From a8c814e31fa94838c71ffdcad7c46b308ece9ace Mon Sep 17 00:00:00 2001 From: Malte Poll Date: Wed, 2 Aug 2023 10:45:52 +0200 Subject: [PATCH] docs: remove deprecated flags from docs --- dev-docs/howto/nfs.md | 2 +- dev-docs/workflows/bazel.md | 2 +- docs/docs/getting-started/first-steps-local.md | 2 +- docs/docs/getting-started/first-steps.md | 2 +- docs/docs/reference/cli.md | 6 ++---- docs/docs/workflows/create.md | 2 +- docs/docs/workflows/troubleshooting.md | 2 +- docs/screencasts/docker/create-cluster.expect | 2 +- docs/screencasts/docker/github-readme.expect | 2 +- 9 files changed, 10 insertions(+), 12 deletions(-) diff --git a/dev-docs/howto/nfs.md b/dev-docs/howto/nfs.md index 3ff817bb484..03a0bbb47ca 100644 --- a/dev-docs/howto/nfs.md +++ b/dev-docs/howto/nfs.md @@ -7,7 +7,7 @@ This document describes how to deploy NFS in Constellation using Rook. The cluster needs at least 3 worker nodes, default machines are powerful enough. ```bash -constellation create --name nfs -c 1 -w 3 +constellation create --name nfs ``` ## Deploy CSI Driver diff --git a/dev-docs/workflows/bazel.md b/dev-docs/workflows/bazel.md index 7eb7e6e59c5..71fda6bc59b 100644 --- a/dev-docs/workflows/bazel.md +++ b/dev-docs/workflows/bazel.md @@ -28,7 +28,7 @@ bazel build //cli:cli_oss_darwin_arm64 # cross compile CLI for mac arm64 ### Run -* `bazel run --run_under="cd $PWD &&" //cli:cli_oss -- create -c 1 -w 1` - build + run a target with arguments in current working directory +* `bazel run --run_under="cd $PWD &&" //cli:cli_oss -- create --yes` - build + run a target with arguments in current working directory ### Pre-PR checks diff --git a/docs/docs/getting-started/first-steps-local.md b/docs/docs/getting-started/first-steps-local.md index 8fcd7181112..c8ad08083dd 100644 --- a/docs/docs/getting-started/first-steps-local.md +++ b/docs/docs/getting-started/first-steps-local.md @@ -103,7 +103,7 @@ attaching persistent storage, or autoscaling aren't available. 2. Now you can create your cluster and its nodes. `constellation create` uses the options set in `constellation-conf.yaml`. ```bash - constellation create --control-plane-nodes 1 --worker-nodes 1 + constellation create ``` This will create 2 VMs: one worker node, and one control plane node. diff --git a/docs/docs/getting-started/first-steps.md b/docs/docs/getting-started/first-steps.md index 0329c577642..32e6f0477e1 100644 --- a/docs/docs/getting-started/first-steps.md +++ b/docs/docs/getting-started/first-steps.md @@ -128,7 +128,7 @@ If you encounter any problem with the following steps, make sure to use the [lat ::: ```bash - constellation create --control-plane-nodes 1 --worker-nodes 2 -y + constellation create -y ``` This should give the following output: diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md index 35a5289d9be..2a1fe54efce 100644 --- a/docs/docs/reference/cli.md +++ b/docs/docs/reference/cli.md @@ -219,10 +219,8 @@ constellation create [flags] ### Options ``` - -c, --control-plane-nodes int number of control-plane nodes (required) - -h, --help help for create - -w, --worker-nodes int number of worker nodes (required) - -y, --yes create the cluster without further confirmation + -h, --help help for create + -y, --yes create the cluster without further confirmation ``` ### Options inherited from parent commands diff --git a/docs/docs/workflows/create.md b/docs/docs/workflows/create.md index 811d5204142..eaabea507a9 100644 --- a/docs/docs/workflows/create.md +++ b/docs/docs/workflows/create.md @@ -33,7 +33,7 @@ Choose the initial size of your cluster. The following command creates a cluster with one control-plane and two worker nodes: ```bash -constellation create --control-plane-nodes 1 --worker-nodes 2 +constellation create ``` For details on the flags, consult the command help via `constellation create -h`. diff --git a/docs/docs/workflows/troubleshooting.md b/docs/docs/workflows/troubleshooting.md index 2ddf3335d4c..fa1d6600234 100644 --- a/docs/docs/workflows/troubleshooting.md +++ b/docs/docs/workflows/troubleshooting.md @@ -31,7 +31,7 @@ Afterward, set `ARM_SKIP_PROVIDER_REGISTRATION=true` as an environment variable For example: ```bash -ARM_SKIP_PROVIDER_REGISTRATION=true constellation create --control-plane-nodes 1 --worker-nodes 2 -y +ARM_SKIP_PROVIDER_REGISTRATION=true constellation create -y ``` Or alternatively, for `terminate`: diff --git a/docs/screencasts/docker/create-cluster.expect b/docs/screencasts/docker/create-cluster.expect index b891184fbf9..7d640b2b1dc 100755 --- a/docs/screencasts/docker/create-cluster.expect +++ b/docs/screencasts/docker/create-cluster.expect @@ -25,7 +25,7 @@ expect_prompt run_command "# Step 1: Create cloud environment" expect_prompt -run_command "constellation create --control-plane-nodes 3 --worker-nodes 2" +run_command "constellation create" expect -re "y\/n" send "y" send "\r" diff --git a/docs/screencasts/docker/github-readme.expect b/docs/screencasts/docker/github-readme.expect index 513358264e6..733b41a5318 100644 --- a/docs/screencasts/docker/github-readme.expect +++ b/docs/screencasts/docker/github-readme.expect @@ -23,7 +23,7 @@ spawn asciinema rec --overwrite /recordings/github-readme.cast send "\r" expect_prompt -run_command "constellation create --control-plane-nodes 3 --worker-nodes 2" +run_command "constellation create" expect -re "y\/n" send "y" send "\r"