1
1
# clusterctl config cluster
2
2
3
3
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.
5
4
6
5
For example
7
6
@@ -13,7 +12,7 @@ Creates a YAML file named `my-cluster.yaml` with a predefined list of Cluster AP
13
12
Machine Deployments, etc. to be deployed in the current namespace (in case, use the ` --target-namespace ` flag to
14
13
specify a different target namespace).
15
14
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
17
16
to apply the cluster manifest.
18
17
19
18
```
@@ -26,7 +25,7 @@ The `clusterctl config cluster` command uses smart defaults in order to simplify
26
25
it detects that there is only an ` aws ` infrastructure provider in the current management cluster and so it automatically
27
26
selects a cluster template from the ` aws ` provider's repository.
28
27
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
30
29
provider to use for the workload cluster:
31
30
32
31
```
@@ -44,7 +43,7 @@ clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
44
43
### Flavors
45
44
46
45
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.
48
47
49
48
```
50
49
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
55
54
56
55
### Alternative source for cluster templates
57
56
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
59
58
for cluster templates can be used as well:
60
59
61
60
#### ConfigMaps
62
61
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.
64
63
65
64
```
66
65
clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
@@ -69,7 +68,7 @@ clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
69
68
70
69
#### GitHub or local file system folder
71
70
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.
73
72
74
73
```
75
74
clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
@@ -85,12 +84,12 @@ clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
85
84
86
85
### Variables
87
86
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.
89
88
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
91
90
should ensure the corresponding environment variable to be set before executing ` clusterctl config cluster ` .
92
91
93
92
Please refer to the providers documentation for more info about the required variables or use the
94
93
` clusterctl config cluster --list-variables ` flag to get a list of variables names required by a cluster template.
95
94
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.
0 commit comments