Skip to content

fix: custom preset cached on target's preset.yml #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fboucquez merged 4 commits into from
Nov 24, 2021
Merged

fix: custom preset cached on target's preset.yml #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be04ccb
fix: custom preset cached on target
fboucquez Jul 29, 2021
4fec3d2
feedback fixes
Nov 24, 2021
979051c
Rolledback change for unit test sanity. It will be changed next pr.
Nov 24, 2021
0b8c030
Merge remote-tracking branch 'origin/dev' into custom_preset_cache
Nov 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
| ---------------- | ------- | ------------------------------------------------------------------ |
| Symbol Bootstrap | v1.1.2 | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |

- The `bootstrap` preset is not the default anymore. The name must be provided via --preset or as a custom preset field.
- A 'safe' custom preset is cached in the target folder. It's not required when upgrading the node without a configuration change.
- Added `--logger` option to the commands.

## [1.1.1] - Nov-16-2021
Expand Down
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,17 @@ Presets are defined at 4 levels from general to specific:

Properties in each file override the previous values (by object deep merge).

### Out-of-the-box presets:
### Out-of-the-box presets and assemblies:

- `-p bootstrap`: Default [preset](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/network.yml). It's a private network with 1 mongo database, 2 peers, 1 api and 1 rest gateway. Nemesis block is generated.
- `-p bootstrap -a light`: A [light](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/assembly-light.yml) network. It's a version of bootstrap preset with 1 mongo database, 1 dual peer and 1 rest gateway. Great for faster light e2e automatic testing. Nemesis block is generated.
- `-p bootstrap -a full`: A [full](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/assembly-full.yml) network. The default bootstrap preset plus 1 wallet, 1 explorer and 1 faucet. Great for demonstration purposes. Nemesis block is generated.
- `-p bootstrap`: A [multinode](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/network.yml) local network. A network with 1 mongo database, 2 peers, 1 api and 1 rest gateway. Nemesis block is generated.
- `-p bootstrap -a light`: A [light](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/assembly-light.yml) local network. It's a version of bootstrap preset with 1 mongo database, 1 dual peer and 1 rest gateway. Great for faster light e2e automatic testing. Nemesis block is generated.
- `-p bootstrap -a full`: A [full](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/assembly-full.yml) local network. The bootstrap preset plus 1 wallet, 1 explorer and 1 faucet. Great for demonstration purposes. Nemesis block is generated.
- `-p testnet -a peer`: A [harvesting](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/assembly-peer.yml) peer node that connects to the current public [testnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/network.yml). [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/testnet/seed/00000) is copied over.
- `-p testnet -a api`: A [api](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/assembly-api.yml) peer node that connects to the current public [testnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/network.yml) running its own mongo database and rest gateway. [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/testnet/seed/00000) is copied over.
- `-p testnet -a dual`: A [dual](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/assembly-dual.yml) haversting peer node that connects to the current public [testnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/network.yml) running its own mongo database and rest gateway. [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/testnet/seed/00000) is copied over.
- `-p mainnet -a peer`: A [harvesting](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/mainnet/assembly-peer.yml) peer node that connects to the current public [mainnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/mainnet/network.yml). [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/mainnet/seed/00000) is copied over.
- `-p mainnet -a api`: A [api](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/mainnet/assembly-api.yml) peer node that connects to the current public [mainnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/mainnet/network.yml) running its own mongo database and rest gateway. [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/mainnet/seed/00000) is copied over.
- `-p mainnet -a dual`: A [dual](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/mainnet/assembly-dual.yml) haversting peer node that connects to the current public [mainnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/mainnet/network.yml) running its own mongo database and rest gateway. [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/mainnet/seed/00000) is copied over.

### Custom preset:

Expand Down
4 changes: 2 additions & 2 deletions docs/clean.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ OPTIONS
-h, --help It shows the help of this command.
-t, --target=target [default: target] The target folder where the symbol-bootstrap network is generated

--logger=logger [default: ConsoleLog,File] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console,File] The loggers the command will use. Options are: Console,File,Silent. Use
',' to select multiple loggers.

EXAMPLE
$ symbol-bootstrap clean
Expand Down
4 changes: 2 additions & 2 deletions docs/compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ OPTIONS
-u, --user=user [default: current] User used to run the services in the docker-compose.yml file. "current" means
the current user.

--logger=logger [default: ConsoleLog,File] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console,File] The loggers the command will use. Options are: Console,File,Silent. Use
',' to select multiple loggers.

--noPassword When provided, Bootstrap will not use a password, so private keys will be stored in plain text.
Use with caution.
Expand Down
22 changes: 12 additions & 10 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ USAGE
$ symbol-bootstrap config

OPTIONS
-a, --assembly=assembly The assembly, example "dual" for testnet. If not provided, the value is
resolved from the target/preset.yml file.
-a, --assembly=assembly The assembly that defines the node(s) layout. It can be provided via custom
preset or cli parameter. If not provided, the value is resolved from the
target/preset.yml file.

-c, --customPreset=customPreset External preset file. Values in this file will override the provided presets
-c, --customPreset=customPreset External preset file. Values in this file will override the provided
presets.

-h, --help It shows the help of this command.

-p, --preset=(bootstrap|testnet|mainnet) The network preset, can be provided via custom preset or cli parameter. If
not provided, the value is resolved from the target/preset.yml file.
-p, --preset=(bootstrap|testnet|mainnet) The network preset. It can be provided via custom preset or cli parameter.
If not provided, the value is resolved from the target/preset.yml file.

-r, --reset It resets the configuration generating a new one
-r, --reset It resets the configuration generating a new one.

-t, --target=target [default: target] The target folder where the symbol-bootstrap network is
generated
Expand All @@ -33,8 +35,8 @@ OPTIONS
configuration files like certificates or nemesis block. "current" means the
current user.

--logger=logger [default: ConsoleLog,File] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console,File] The loggers the command will use. Options are:
Console,File,Silent. Use ',' to select multiple loggers.

--noPassword When provided, Bootstrap will not use a password, so private keys will be
stored in plain text. Use with caution.
Expand All @@ -49,12 +51,12 @@ OPTIONS

--upgrade It regenerates the configuration reusing the previous keys. Use this flag
when upgrading the version of bootstrap to keep your node up to date without
dropping the local data. The original preset (-t), assembly (-a), and custom
preset (-a) must be used. Backup the target folder before upgrading.
dropping the local data. Backup the target folder before upgrading.

EXAMPLES
$ symbol-bootstrap config -p bootstrap
$ symbol-bootstrap config -p testnet -a dual --password 1234
$ symbol-bootstrap config -p mainnet -a peer -c custom-preset.yml
$ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap config -p testnet -a dual
```

Expand Down
4 changes: 2 additions & 2 deletions docs/decrypt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ OPTIONS
-h, --help It shows the help of this command.
--destination=destination (required) The destination decrypted file to create. The destination file must not exist.

--logger=logger [default: Console] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console] The loggers the command will use. Options are: Console,File,Silent. Use
',' to select multiple loggers.

--password=password The password to use to decrypt the source file into the destination file. Bootstrap prompts
for a password by default, can be provided in the command line (--password=XXXX) or
Expand Down
4 changes: 2 additions & 2 deletions docs/encrypt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ OPTIONS
-h, --help It shows the help of this command.
--destination=destination (required) The destination encrypted file to create. The destination file must not exist.

--logger=logger [default: Console] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console] The loggers the command will use. Options are: Console,File,Silent. Use
',' to select multiple loggers.

--password=password The password to use to encrypt the source file into the destination file. Bootstrap prompts
for a password by default, can be provided in the command line (--password=XXXX) or
Expand Down
4 changes: 2 additions & 2 deletions docs/healthCheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ OPTIONS
-h, --help It shows the help of this command.
-t, --target=target [default: target] The target folder where the symbol-bootstrap network is generated

--logger=logger [default: ConsoleLog,File] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console,File] The loggers the command will use. Options are: Console,File,Silent. Use
',' to select multiple loggers.

DESCRIPTION
This command checks:
Expand Down
3 changes: 1 addition & 2 deletions docs/link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ OPTIONS
-u, --url=url [default: http://localhost:3000] the network url

--logger=logger [default: Console] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple
loggers.
Console,File,Silent. Use ',' to select multiple loggers.

--maxFee=maxFee the max fee used when announcing (absolute). The node min
multiplier will be used if it is not provided.
Expand Down
3 changes: 1 addition & 2 deletions docs/modifyMultisig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ OPTIONS
-u, --url=url [default: http://localhost:3000] the network url

--logger=logger [default: Console] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple
loggers.
Console,File,Silent. Use ',' to select multiple loggers.

--maxFee=maxFee the max fee used when announcing (absolute). The node min
multiplier will be used if it is not provided.
Expand Down
25 changes: 13 additions & 12 deletions docs/pack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ USAGE
$ symbol-bootstrap pack

OPTIONS
-a, --assembly=assembly (required) The assembly, example "dual" for testnet.
-a, --assembly=assembly The assembly that defines the node(s) layout. It can be provided via custom
preset or cli parameter. If not provided, the value is resolved from the
target/preset.yml file.

-c, --customPreset=customPreset (required) External preset file. Values in this file will override the
provided presets
-c, --customPreset=customPreset External preset file. Values in this file will override the provided
presets.

-h, --help It shows the help of this command.

-p, --preset=(bootstrap|testnet|mainnet) (required) The network preset, can be provided via custom preset or cli
parameter.
-p, --preset=(bootstrap|testnet|mainnet) The network preset. It can be provided via custom preset or cli parameter.
If not provided, the value is resolved from the target/preset.yml file.

-r, --reset It resets the configuration generating a new one
-r, --reset It resets the configuration generating a new one.

-t, --target=target [default: target] The target folder where the symbol-bootstrap network is
generated
Expand All @@ -33,8 +35,8 @@ OPTIONS
configuration files like certificates or nemesis block. "current" means the
current user.

--logger=logger [default: ConsoleLog] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console] The loggers the command will use. Options are:
Console,File,Silent. Use ',' to select multiple loggers.

--noPassword When provided, Bootstrap will not use a password, so private keys will be
stored in plain text. Use with caution.
Expand All @@ -51,15 +53,14 @@ OPTIONS

--upgrade It regenerates the configuration reusing the previous keys. Use this flag
when upgrading the version of bootstrap to keep your node up to date without
dropping the local data. The original preset (-t), assembly (-a), and custom
preset (-a) must be used. Backup the target folder before upgrading.
dropping the local data. Backup the target folder before upgrading.

EXAMPLES
$ symbol-bootstrap pack
$ symbol-bootstrap pack -p bootstrap -c custom-preset.yml
$ symbol-bootstrap pack -c custom-preset.yml
$ symbol-bootstrap pack -p testnet -a dual -c custom-preset.yml
$ symbol-bootstrap pack -p mainnet -a dual --password 1234 -c custom-preset.yml
$ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap pack -p mainnet -a dual -c custom-preset.yml
$ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap pack -c custom-preset.yml
```

_See code: [src/commands/pack.ts](https://github.com/nemtech/symbol-bootstrap/blob/v1.1.2/src/commands/pack.ts)_
4 changes: 2 additions & 2 deletions docs/report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ OPTIONS
-h, --help It shows the help of this command.
-t, --target=target [default: target] The target folder where the symbol-bootstrap network is generated

--logger=logger [default: ConsoleLog,File] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console,File] The loggers the command will use. Options are: Console,File,Silent. Use
',' to select multiple loggers.

EXAMPLE
$ symbol-bootstrap report
Expand Down
4 changes: 2 additions & 2 deletions docs/resetData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ OPTIONS
-h, --help It shows the help of this command.
-t, --target=target [default: target] The target folder where the symbol-bootstrap network is generated

--logger=logger [default: ConsoleLog,File] The loggers the command will use. Options are:
Console,ConsoleLog,File,Silent. Use ',' to select multiple loggers.
--logger=logger [default: Console,File] The loggers the command will use. Options are: Console,File,Silent. Use
',' to select multiple loggers.

EXAMPLE
$ symbol-bootstrap resetData
Expand Down
4 changes: 2 additions & 2 deletions docs/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ OPTIONS
The health check process handles 'repeat' and custom 'openPort' services.

--logger=logger
[default: ConsoleLog,File] The loggers the command will use. Options are: Console,ConsoleLog,File,Silent. Use ',' to
select multiple loggers.
[default: Console,File] The loggers the command will use. Options are: Console,File,Silent. Use ',' to select
multiple loggers.

--pullImages
It pulls the images from DockerHub when running the configuration. It only affects alpha/dev docker images.
Expand Down
Loading