Skip to content

Commit

Permalink
docs: remove deprecated flags from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
malt3 committed Aug 2, 2023
1 parent 10e992e commit a8c814e
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 12 deletions.
2 changes: 1 addition & 1 deletion dev-docs/howto/nfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/workflows/bazel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/first-steps-local.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 2 additions & 4 deletions docs/docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/workflows/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/workflows/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
2 changes: 1 addition & 1 deletion docs/screencasts/docker/create-cluster.expect
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/screencasts/docker/github-readme.expect
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit a8c814e

Please sign in to comment.