From 82de0b83bd35b9b2d641039ea76146cff7f24b70 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 | 10 ++++------ docs/docs/getting-started/first-steps.md | 6 +++--- docs/docs/reference/cli.md | 6 ++---- docs/docs/workflows/config.md | 2 +- docs/docs/workflows/create.md | 7 +------ docs/docs/workflows/troubleshooting.md | 2 +- docs/screencasts/docker/create-cluster.expect | 2 +- docs/screencasts/docker/github-readme.expect | 2 +- 10 files changed, 16 insertions(+), 25 deletions(-) diff --git a/dev-docs/howto/nfs.md b/dev-docs/howto/nfs.md index 3ff817bb4..b3c36d024 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 ``` ## Deploy CSI Driver diff --git a/dev-docs/workflows/bazel.md b/dev-docs/workflows/bazel.md index 7eb7e6e59..71fda6bc5 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 8fcd71811..de9c66e9b 100644 --- a/docs/docs/getting-started/first-steps-local.md +++ b/docs/docs/getting-started/first-steps-local.md @@ -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 diff --git a/docs/docs/getting-started/first-steps.md b/docs/docs/getting-started/first-steps.md index 0329c5776..0b224e04d 100644 --- a/docs/docs/getting-started/first-steps.md +++ b/docs/docs/getting-started/first-steps.md @@ -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. ``` diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md index 35a5289d9..2a1fe54ef 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/config.md b/docs/docs/workflows/config.md index f276f3f63..6076259ac 100644 --- a/docs/docs/workflows/config.md +++ b/docs/docs/workflows/config.md @@ -78,7 +78,7 @@ SNP-based attestation will be enabled as soon as a fix is verified. -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 diff --git a/docs/docs/workflows/create.md b/docs/docs/workflows/create.md index 811d52041..494def766 100644 --- a/docs/docs/workflows/create.md +++ b/docs/docs/workflows/create.md @@ -29,15 +29,10 @@ Before you create the cluster, make sure to have a [valid configuration file](./ -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. diff --git a/docs/docs/workflows/troubleshooting.md b/docs/docs/workflows/troubleshooting.md index 2ddf3335d..43f7cace2 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 ``` Or alternatively, for `terminate`: diff --git a/docs/screencasts/docker/create-cluster.expect b/docs/screencasts/docker/create-cluster.expect index b891184fb..7d640b2b1 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 513358264..733b41a53 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"