/ 
App-bwk-mn-0.001
River stage one • 1 direct dependent • 1 total dependent
/ bwk-mn

NAME

bwk-mn - Some commands to manage Bulwark masternode

VERSION

This document describes version 0.001 of bwk-mn (from Perl distribution App-bwk-mn), released on 2019-07-22.

SYNOPSIS

To upgrade to the latest version:

% bwk-mn -U

To see masternode status:

% bwk-mn status

To restore from a ZFS snapshot:

% bwk-mn restore-from-zfs-snapshot

To create a new ZFS snapshot:

% bwk-mn new-zfs-snapshot

DESCRIPTION

Early release. More functionality will be added in the future.

SUBCOMMANDS

new-zfs-snapshot

Create a new ZFS snapshot.

This subcommand will:

1. stop bulwarkd
2. create a new ZFS snapshot
3. restart bulwarkd again

See restore_from_zfs_snapshot for more details.

restore-from-zfs-snapshot

Restore broken installation from ZFS snapshot.

This subcommand will:

1. stop bulwarkd
2. rollback to a specific ZFS snapshot
3. restart bulwarkd again
4. wait until node is fully sync-ed (not yet implemented)

For this to work, a specific setup is required. First, at least the blocks/ and chainstate directory are put in a ZFS filesystem (this part is assumed and not checked) and a snapshot of that filesytem has been made. The ZFS filesystem needs to have "bulwark" or "bwk" as part of its name, and the snapshot must be named using YYYY-MM-DD. The most recent snapshot will be selected.

Rationale: as of this writing (2019-07-22, Bulwark version 2.2.0.0) a Bulwark masternode still from time to time gets corrupted with this message in the debug.log:

2019-07-22 02:30:17 ERROR: VerifyDB() : *** irrecoverable inconsistency in block data at xxxxxx, hash=xxxxxxxx

(It used to happen more often prior to 2.1.0 release, and less but still happens from time to time since 2.1.0.)

Resync-ing from scratch will take at least 1-2 hours, and if this happens on each masternode every few days then resync-ing will waste a lot of time. Thus the ZFS snapshot. Snapshots will of course need to be created regularly for this setup to benefit.

status

bulwark-cli getblockcount + masternode status.

This is mostly just a shortcut for running bulwark-cli getblockcount and bulwark-cli masternode status.

OPTIONS

* marks required options.

Common options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--no-config, -C

Do not use any configuration file.

--no-env

Do not read environment for default options.

--quiet

Shortcut for --log-level=error.

--self-upgrade, -U

Update program to latest version from CPAN.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C bwk-mn bwk-mn

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete bwk-mn 'p/*/`bwk-mn`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/bwk-mn.conf, ~/bwk-mn.conf, or /etc/bwk-mn.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

Common for all subcommands

format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)

Configuration for subcommand new-zfs-snapshot

Configuration for subcommand restore-from-zfs-snapshot

Configuration for subcommand status

ENVIRONMENT

BWK_MN_OPT => str

Specify additional command-line options.

FILES

~/.config/bwk-mn.conf

~/bwk-mn.conf

/etc/bwk-mn.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-bwk-mn.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-bwk-mn.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-bwk-mn

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

cryp-mn

Other cryp-* in the App::cryp family.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.