Skip to content

Commit 4eec824

Browse files
address comments
1 parent 36903af commit 4eec824

File tree

5 files changed

+20
-21
lines changed

5 files changed

+20
-21
lines changed

docs/book/src/clusterctl/commands/config-cluster.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# clusterctl config cluster
22

33
The `clusterctl create config` command returns a YAML template for creating a workload cluster.
4-
Store it locally, eventually customize it, and the apply it to start provisioning the workload cluster.
54

65
For example
76

@@ -13,7 +12,7 @@ Creates a YAML file named `my-cluster.yaml` with a predefined list of Cluster AP
1312
Machine Deployments, etc. to be deployed in the current namespace (in case, use the `--target-namespace` flag to
1413
specify a different target namespace).
1514

16-
Then, the file can be eventually modified using your editor of choice; when ready, run the following command
15+
Then, the file can be modified using your editor of choice; when ready, run the following command
1716
to apply the cluster manifest.
1817

1918
```
@@ -26,7 +25,7 @@ The `clusterctl config cluster` command uses smart defaults in order to simplify
2625
it detects that there is only an `aws` infrastructure provider in the current management cluster and so it automatically
2726
selects a cluster template from the `aws` provider's repository.
2827

29-
In case there is more than one infrastructure provider, following syntax can be used to select which infrastructure
28+
In case there is more than one infrastructure provider, the following syntax can be used to select which infrastructure
3029
provider to use for the workload cluster:
3130

3231
```
@@ -44,7 +43,7 @@ clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
4443
### Flavors
4544

4645
The infrastructure provider authors can provide different type of cluster templates, or flavors; use the `--flavor` flag
47-
to specify the which flavor to use; e.g.
46+
to specify which flavor to use; e.g.
4847

4948
```
5049
clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
@@ -55,12 +54,12 @@ Please refer to the providers documentation for more info about available flavor
5554

5655
### Alternative source for cluster templates
5756

58-
clusterctl uses the provider's repository as a primary source for cluster templates; following alternative sources
57+
clusterctl uses the provider's repository as a primary source for cluster templates; the following alternative sources
5958
for cluster templates can be used as well:
6059

6160
#### ConfigMaps
6261

63-
Use the `--from-config-map` flag to read cluster templates stored in Kubernetes ConfigMap; e.g.
62+
Use the `--from-config-map` flag to read cluster templates stored in a Kubernetes ConfigMap; e.g.
6463

6564
```
6665
clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
@@ -69,7 +68,7 @@ clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
6968

7069
#### GitHub or local file system folder
7170

72-
Use the `--from` flag to read cluster templates stored into a GitHub repository or in a local file system folder; e.g.
71+
Use the `--from` flag to read cluster templates stored in a GitHub repository or in a local file system folder; e.g.
7372

7473
```
7574
clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
@@ -85,12 +84,12 @@ clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
8584

8685
### Variables
8786

88-
If the select cluster template expects some environment variables, user should ensure those variables are set in advance.
87+
If the selected cluster template expects some environment variables, user should ensure those variables are set in advance.
8988

90-
e.g. if the `AWS_CREDENTIALS` variable is expected for a cluster template targeting the `aws` infrastructure, user
89+
e.g. if the `AWS_CREDENTIALS` variable is expected for a cluster template targeting the `aws` infrastructure, you
9190
should ensure the corresponding environment variable to be set before executing `clusterctl config cluster`.
9291

9392
Please refer to the providers documentation for more info about the required variables or use the
9493
`clusterctl config cluster --list-variables` flag to get a list of variables names required by a cluster template.
9594

96-
In case, the [clusterctl configuration](configuration.md) file can be used as alternative to environment variables.
95+
The [clusterctl configuration](configuration.md) file can be used as alternative to environment variables.

docs/book/src/clusterctl/commands/move.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ process completes.
3838

3939
## Pivot
4040

41-
Pivot is a process for moving the provider components and declared cluster-api resources from a source management
41+
Pivoting is a process for moving the provider components and declared Cluster API resources from a source management
4242
cluster to a target management cluster.
4343

4444
This can now achieved with the following procedure:
@@ -48,16 +48,16 @@ This can now achieved with the following procedure:
4848

4949
## Bootstrap & Pivot
5050

51-
In former versions of clusterctl the pivot process was bounded with the creation of a temporary bootstrap cluster
52-
used to provision a target Management cluster.
51+
The pivot process can be bounded with the creation of a temporary bootstrap cluster
52+
used to provision a target Management cluster.
5353

5454
This can now achieved with the following procedure:
5555

56-
1. Create a temporary bootstrap cluster, e.g. using Kind or Minikube
56+
1. Create a temporary bootstrap cluster, e.g. using Kind or Minikube
5757
2. Use `clusterctl init` to install the provider components
5858
3. Use `clusterctl config cluster ... | kubectl apply -f -` to provision a target management cluster
5959
4. Wait for the target management cluster to be up and running
6060
5. Get the kubeconfig for the new target management cluster
6161
6. Use `clusterctl init` with the new cluster's kubeconfig to install the provider components
62-
7. Use `clusterctl move` to move the cluster-api resources from the bootstrap cluster to the target management cluster
62+
7. Use `clusterctl move` to move the Cluster API resources from the bootstrap cluster to the target management cluster
6363
8. Delete the bootstrap cluster

docs/book/src/clusterctl/commands/upgrade.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ The upgrade process is composed by two steps:
5858
are hosted and the provider's CRDs.
5959
* Install the new version of the provider components.
6060

61-
Please note that clusterctl does not upgrades Cluster API objects (Clusters, MachineDeployments, Machine etc.); upgrading
62-
such objects is responsibility of the provider's controllers.
61+
Please note that clusterctl does not upgrade Cluster API objects (Clusters, MachineDeployments, Machine etc.); upgrading
62+
such objects are the responsibility of the provider's controllers.
6363

6464

6565
<aside class="note warning">

docs/book/src/clusterctl/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ for cluster templates.
229229
If the cluster template defined by the infrastructure provider expects some environment variables, user
230230
should ensure those variables are set in advance.
231231

232-
See [`clusterctl config cluster`](commands/config-cluster.md) for details about how discover the list of
232+
See [`clusterctl config cluster`](commands/config-cluster.md) for details about how to discover the list of
233233
variables required by a cluster templates.
234234

235235
</aside>

docs/book/src/clusterctl/provider-contract.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ about how to create a release.
4848

4949
#### Creating a local provider repository
5050

51-
clusterctl supports reading from repository defined in the local file system.
51+
clusterctl supports reading from a repository defined on the local file system.
5252

53-
Local repository can be defined by crating a `<provider-name>` folder with a `<version>` sub-folder for each hosted release;
53+
A local repository can be defined by creating a `<provider-name>` folder with a `<version>` sub-folder for each hosted release;
5454
the sub-folder name MUST be a valid semantic version number.
5555

56-
Each version sub-folder MUST contains the corresponding components YAML, the metadata YAML and eventually the workload cluster templates.
56+
Each version sub-folder MUST contain the corresponding components YAML, the metadata YAML and eventually the workload cluster templates.
5757

5858
### Metadata YAML
5959

0 commit comments

Comments
 (0)