Skip to content

Commit 72362f3

Browse files
authored
docs: Add --track flag to the deployment examples (#300)
Adds a `--track` flag to the deployment examples, additionally, fixes the syntax highlighting from `json` to `sh` in a couple of cases. Signed-off-by: Marc Lopez <marc5.12@outlook.com>
1 parent 84cc91a commit 72362f3

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/ecctl-getting-started.asciidoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ Run the <<ecctl_deployment_create,{p} deployment create>> command with `create-d
389389

390390
[source, sh]
391391
--
392-
ecctl deployment create -f create-deployment.json
392+
ecctl deployment create [--track] -f create-deployment.json
393393
--
394394

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

487487
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.
488488

489-
[source, json]
489+
To monitor the progress, use the `--track` flag.
490+
491+
[source, sh]
490492
--
491-
ecctl deployment update $DEPLOYMENT_ID -f update-deployment.json
493+
ecctl deployment update [--track] $DEPLOYMENT_ID -f update-deployment.json
492494
--
493495
* `$DEPLOYMENT_ID` is the ID for the deployment that was created in the previous <<{p}-example-create-deployment,create a deployment>> example.
494496

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

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

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

537539
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.
538540

541+
To monitor the progress, use the `--track` flag.
542+
539543
To see the different options that {p} supports, run `ecctl <command> <help>`.
540544

541545

0 commit comments

Comments
 (0)