Skip to content
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.

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

[feature] #2373: kagami swarm file and kagami swarm dir #3585

Merged
merged 6 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 1 addition & 17 deletions tools/kagami/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,23 +58,7 @@ pub enum Args {
Docs(Box<docs::Args>),
/// Generate the default validator
Validator(validator::Args),
/// Generate a docker-compose configuration for a variable number of peers
/// using a Dockerhub image, GitHub repo, or a local Iroha repo.
///
/// This command builds the docker-compose configuration in a specified directory. If the source
/// is a GitHub repo, it will be cloned into the directory. Also, the default configuration is
/// built and put into `<target>/config` directory, unless `--no-default-configuration` flag is
/// provided. The default configuration is equivalent to running `kagami config peer`,
/// `kagami validator`, and `kagami genesis default --compiled-validator-path ./validator.wasm` consecutively.
///
/// Default configuration building will fail if Kagami is run outside of Iroha repo (tracking
/// issue: https://github.com/hyperledger/iroha/issues/3473). If you are going to run it outside
/// of the repo, make sure to pass `--no-default-configuration` flag.
///
/// Be careful with specifying a Dockerhub image as a source: Kagami Swarm only guarantees that
/// the docker-compose configuration it generates is compatible with the same Git revision it
/// is built from itself. Therefore, if specified image is not compatible with the version of Swarm
/// you are running, the generated configuration might not work.
/// Generate Docker Compose configuration
Swarm(swarm::Args),
}

Expand Down
Loading