Skip to content

docs: Add --track flag to the deployment examples #300

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
marclop merged 1 commit into from
Jun 9, 2020
Merged

docs: Add --track flag to the deployment examples #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions docs/ecctl-getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ Run the <<ecctl_deployment_create,{p} deployment create>> command with `create-d

[source, sh]
--
ecctl deployment create -f create-deployment.json
ecctl deployment create [--track] -f create-deployment.json
--

[source, sh]
Expand Down Expand Up @@ -486,9 +486,11 @@ The JSON body is similar to what we used to create the deployment, with the foll

In this example, prune_orphans is set to `false`, so the Kibana and APM instances are not changed or removed, while the Elasticsearch resource is modified according to the configuration specified in the JSON file.

[source, json]
To monitor the progress, use the `--track` flag.

[source, sh]
--
ecctl deployment update $DEPLOYMENT_ID -f update-deployment.json
ecctl deployment update [--track] $DEPLOYMENT_ID -f update-deployment.json
--
* `$DEPLOYMENT_ID` is the ID for the deployment that was created in the previous <<{p}-example-create-deployment,create a deployment>> example.

Expand Down Expand Up @@ -528,14 +530,16 @@ ecctl deployment update $DEPLOYMENT_ID -f update-deployment.json

In this last example, you can use the <<ecctl_deployment_shutdown,{p} deployment shutdown>> command to delete the deployment that you created.

[source, json]
[source, sh]
--
ecctl deployment shutdown $DEPLOYMENT_ID
ecctl deployment shutdown [--track] $DEPLOYMENT_ID
--
* `$DEPLOYMENT_ID` is the ID for the deployment that was created in the previous <<{p}-example-create-deployment,create a deployment>> example.

On running this and other destructive commands, {p} prompts you with a confirmation message. Use the `--force` option to skip the confirmation step, if you are using {p} for automation.

To monitor the progress, use the `--track` flag.

To see the different options that {p} supports, run `ecctl <command> <help>`.


Expand Down