docs: remove deprecated flags from docs

This commit is contained in:
Malte Poll 2023-08-02 10:45:52 +02:00 committed by Malte Poll
parent 92b0cd5a21
commit 82de0b83bd
10 changed files with 16 additions and 25 deletions

View File

@ -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
```
## Deploy CSI Driver

View File

@ -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

View File

@ -103,15 +103,13 @@ 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.
The Output should look like the following:
```shell-session
$ constellation create ...
$ constellation create
Your Constellation cluster was created successfully.
```
@ -166,7 +164,7 @@ NAME STATUS ROLES AGE VERSION
control-plane-0 Ready control-plane 66s v1.24.6
```
A worker node will request to join the cluster shortly. Before the new worker node is allowed to join the cluster, its state is verified using remote attestation by the [JoinService](../architecture/microservices.md#joinservice).
Additional nodes will request to join the cluster shortly. Before each additional node is allowed to join the cluster, its state is verified using remote attestation by the [JoinService](../architecture/microservices.md#joinservice).
If verification passes successfully, the new node receives keys and certificates to join the cluster.
You can follow this process by viewing the logs of the JoinService:
@ -178,7 +176,7 @@ $ kubectl logs -n kube-system daemonsets/join-service -f
...
```
Once the worker node has joined your cluster, it may take a couple of minutes for all resources to become available.
Once all nodes have joined your cluster, it may take a couple of minutes for all resources to become available.
You can check on the state of your cluster by running the following:
```shell-session

View File

@ -118,7 +118,7 @@ If you encounter any problem with the following steps, make sure to use the [lat
:::
-->
3. Create the cluster with one control-plane node and two worker nodes. `constellation create` uses options set in `constellation-conf.yaml`.
3. Create the cluster. `constellation create` uses options set in `constellation-conf.yaml`.
If you want to manually use [Terraform](../reference/terraform.md) for managing the cloud resources instead, follow the corresponding instructions in the [Create workflow](../workflows/create.md).
:::tip
@ -128,13 +128,13 @@ 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:
```shell-session
$ constellation create ...
$ constellation create -y
Your Constellation cluster was created successfully.
```

View File

@ -219,9 +219,7 @@ 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
```

View File

@ -78,7 +78,7 @@ SNP-based attestation will be enabled as soon as a fix is verified.
</tabItem>
</tabs>
Fill the desired VM type into the **instanceType** field in the `constellation-conf.yml` file.
Fill the desired VM type into the **instanceType** fields in the `constellation-conf.yml` file.
## Choosing a Kubernetes version

View File

@ -29,15 +29,10 @@ Before you create the cluster, make sure to have a [valid configuration file](./
<tabs groupId="provider">
<tabItem value="cli" label="CLI">
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`.
*create* stores your cluster's state in a [`constellation-terraform`](../architecture/orchestration.md#cluster-creation-process) directory in your workspace.
</tabItem>

View File

@ -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
```
Or alternatively, for `terminate`:

View File

@ -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"

View File

@ -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"