Skip to content

Commit b9aa1be

Browse files
authored
🌱 Fix typos in docs. (#1463)
1 parent 7495902 commit b9aa1be

File tree

3 files changed

+19
-24
lines changed

3 files changed

+19
-24
lines changed

docs/caph/01-getting-started/02-quickstart/02-management-cluster-setup.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ For production use, a “real” Kubernetes cluster should be used with appropri
5151
### Install Clusterctl
5252

5353
To install Clusterctl, refer to the instructions available in the official ClusterAPI documentation [here](https://cluster-api.sigs.k8s.io/user/quick-start.html#install-clusterctl).
54-
Alternatively, use the `make install-clusterctl` command to do the same.
5554

5655
### Initialize the management cluster
5756

@@ -74,13 +73,9 @@ For a specific version, use the `--infrastructure hetzner:vX.X.X` flag with the
7473
## Variable Preparation to generate a cluster-template
7574

7675
```shell
77-
export SSH_KEY_NAME="<ssh-key-name>" \
78-
export CLUSTER_NAME="my-cluster" \
79-
export HCLOUD_REGION="fsn1" \
80-
export CONTROL_PLANE_MACHINE_COUNT=3 \
81-
export WORKER_MACHINE_COUNT=3 \
82-
export KUBERNETES_VERSION=1.29.4 \
83-
export HCLOUD_CONTROL_PLANE_MACHINE_TYPE=cpx31 \
76+
export SSH_KEY_NAME="<ssh-key-name>"
77+
export HCLOUD_REGION="fsn1"
78+
export HCLOUD_CONTROL_PLANE_MACHINE_TYPE=cpx31
8479
export HCLOUD_WORKER_MACHINE_TYPE=cpx31
8580
```
8681

docs/caph/01-getting-started/03-preparation.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ Or for a specific [version](https://github.com/syself/cluster-api-provider-hetzn
6666
## Variable Preparation to generate a cluster-template
6767

6868
```shell
69-
export SSH_KEY_NAME="<ssh-key-name>" \
70-
export CLUSTER_NAME="my-cluster" \
71-
export HCLOUD_REGION="fsn1" \
72-
export CONTROL_PLANE_MACHINE_COUNT=3 \
73-
export WORKER_MACHINE_COUNT=3 \
74-
export KUBERNETES_VERSION=1.29.4 \
75-
export HCLOUD_CONTROL_PLANE_MACHINE_TYPE=cpx31 \
69+
export SSH_KEY_NAME="<ssh-key-name>"
70+
export CLUSTER_NAME="my-cluster"
71+
export HCLOUD_REGION="fsn1"
72+
export CONTROL_PLANE_MACHINE_COUNT=3
73+
export WORKER_MACHINE_COUNT=3
74+
export KUBERNETES_VERSION=1.29.4
75+
export HCLOUD_CONTROL_PLANE_MACHINE_TYPE=cpx31
7676
export HCLOUD_WORKER_MACHINE_TYPE=cpx31
7777
```
7878

@@ -120,10 +120,10 @@ The secret name and the tokens can also be customized in the cluster template.
120120
In order for the provider integration hetzner to communicate with the Hetzner API ([HCloud API](https://docs.hetzner.cloud/) + [Robot API](https://robot.your-server.de/doc/webservice/en.html#preface)), we need to create a secret with the access data. The secret must be in the same namespace as the other CRs.
121121

122122
```shell
123-
export HCLOUD_TOKEN="<YOUR-TOKEN>" \
124-
export HETZNER_ROBOT_USER="<YOUR-ROBOT-USER>" \
125-
export HETZNER_ROBOT_PASSWORD="<YOUR-ROBOT-PASSWORD>" \
126-
export HETZNER_SSH_PUB_PATH="<YOUR-SSH-PUBLIC-PATH>" \
123+
export HCLOUD_TOKEN="<YOUR-TOKEN>"
124+
export HETZNER_ROBOT_USER="<YOUR-ROBOT-USER>"
125+
export HETZNER_ROBOT_PASSWORD="<YOUR-ROBOT-PASSWORD>"
126+
export HETZNER_SSH_PUB_PATH="<YOUR-SSH-PUBLIC-PATH>"
127127
export HETZNER_SSH_PRIV_PATH="<YOUR-SSH-PRIVATE-PATH>"
128128
```
129129

docs/caph/02-topics/05-baremetal/02-management-cluster.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,11 @@ We create two secrets named `hetzner` for Hetzner Cloud and Robot API access and
128128
The `hetzner` secret contains API token for hcloud token. It also contains username and password that is used to interact with robot API. `robot-ssh` secret contains the public-key, private-key and name of the ssh-key used for baremetal servers.
129129

130130
```shell
131-
export HCLOUD_TOKEN="<YOUR-TOKEN>" \
132-
export HETZNER_ROBOT_USER="<YOUR-ROBOT-USER>" \
133-
export HETZNER_ROBOT_PASSWORD="<YOUR-ROBOT-PASSWORD>" \
134-
export SSH_KEY_NAME="<YOUR-SSH-KEY-NAME>" \
135-
export HETZNER_SSH_PUB_PATH="<YOUR-SSH-PUBLIC-PATH>" \
131+
export HCLOUD_TOKEN="<YOUR-TOKEN>"
132+
export HETZNER_ROBOT_USER="<YOUR-ROBOT-USER>"
133+
export HETZNER_ROBOT_PASSWORD="<YOUR-ROBOT-PASSWORD>"
134+
export SSH_KEY_NAME="<YOUR-SSH-KEY-NAME>"
135+
export HETZNER_SSH_PUB_PATH="<YOUR-SSH-PUBLIC-PATH>"
136136
export HETZNER_SSH_PRIV_PATH="<YOUR-SSH-PRIVATE-PATH>"
137137
```
138138

0 commit comments

Comments
 (0)