diff --git a/jetstream/configuration_mgmt/README.md b/jetstream/configuration_mgmt/README.md index 59a6459..30ca1a4 100644 --- a/jetstream/configuration_mgmt/README.md +++ b/jetstream/configuration_mgmt/README.md @@ -4,36 +4,8 @@ In many cases managing the configuration in your application code is the best mo We support a number of tools to assist with this: -* `nats` CLI with configuration files +* [CLI with Configuration Files](nats-admin-cli.md) * [Terraform](terraform.md) * [GitHub Actions](github_actions.md) * [Kubernetes JetStream Controller](kubernetes_controller.md) -## nats Admin CLI - -The `nats` CLI can be used to manage Streams and Consumers easily using it's `--config` flag, for example: - -## Add a new Stream - -This creates a new Stream based on `orders.json`. The `orders.json` file can be extracted from an existing stream using `nats stream info ORDERS -j | jq .config` - -```text -$ nats str add ORDERS --config orders.json -``` - -## Edit an existing Stream - -This edits an existing stream ensuring it complies with the configuration in `orders.json` - -```text -$ nats str edit ORDERS --config orders.json -``` - -## Add a New Consumer - -This creates a new Consumer based on `orders_new.json`. The `orders_new.json` file can be extracted from an existing stream using `nats con info ORDERS NEW -j | jq .config` - -```text -$ nats con add ORDERS NEW --config orders_new.json -``` - diff --git a/jetstream/configuration_mgmt/nats-admin-cli.md b/jetstream/configuration_mgmt/nats-admin-cli.md index 58f1a8b..fb16025 100644 --- a/jetstream/configuration_mgmt/nats-admin-cli.md +++ b/jetstream/configuration_mgmt/nats-admin-cli.md @@ -1,2 +1,30 @@ # NATS Admin CLI +## nats Admin CLI + +The `nats` CLI can be used to manage Streams and Consumers easily using it's `--config` flag, for example: + +## Add a new Stream + +This creates a new Stream based on `orders.json`. The `orders.json` file can be extracted from an existing stream using `nats stream info ORDERS -j | jq .config` + +```text +$ nats str add ORDERS --config orders.json +``` + +## Edit an existing Stream + +This edits an existing stream ensuring it complies with the configuration in `orders.json` + +```text +$ nats str edit ORDERS --config orders.json +``` + +## Add a New Consumer + +This creates a new Consumer based on `orders_new.json`. The `orders_new.json` file can be extracted from an existing stream using `nats con info ORDERS NEW -j | jq .config` + +```text +$ nats con add ORDERS NEW --config orders_new.json +``` +