Skip to content

Commit 506026c

Browse files
address more comments
1 parent 8b6c84e commit 506026c

13 files changed

+35
-35
lines changed

docs/book/src/SUMMARY.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@
88
- [Certificate Management](./tasks/certs/index.md)
99
- [Using Custom Certificates](./tasks/certs/using-custom-certificates.md)
1010
- [Generating a Kubeconfig](./tasks/certs/generate-kubeconfig.md)
11-
- [clusterctl CLI](./clusterctl/intro.md)
12-
- [clusterctl Commands](./clusterctl/commands.md)
13-
- [init](./clusterctl/init.md)
14-
- [config cluster](clusterctl/config-cluster.md)
15-
- [move](./clusterctl/move.md)
16-
- [adopt](clusterctl/adopt.md)
17-
- [upgrade](./clusterctl/upgrade.md)
18-
- [delete](clusterctl/delete.md)
19-
- [clusterctl Configuration](clusterctl/configuring-clusterctl.md)
20-
- [clusterctl Provider Contract](clusterctl/contract.md)
21-
- [clusterctl for Developers](clusterctl/dev.md)
11+
- [clusterctl CLI](./clusterctl/overview.md)
12+
- [clusterctl Commands](clusterctl/commands/commands.md)
13+
- [init](clusterctl/commands/init.md)
14+
- [config cluster](clusterctl/commands/config-cluster.md)
15+
- [move](./clusterctl/commands/move.md)
16+
- [adopt](clusterctl/commands/adopt.md)
17+
- [upgrade](clusterctl/commands/upgrade.md)
18+
- [delete](clusterctl/commands/delete.md)
19+
- [clusterctl Configuration](clusterctl/configuration.md)
20+
- [clusterctl Provider Contract](clusterctl/provider-contract.md)
21+
- [clusterctl for Developers](clusterctl/developers.md)
2222
- [Developer Guide](./architecture/developer-guide.md)
2323
- [Repository Layout](./architecture/repository-layout.md)
2424
- [Rapid iterative development with Tilt](./developer/tilt.md)
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# init

docs/book/src/clusterctl/init.md renamed to docs/book/src/clusterctl/commands/init.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `clusterctl init` command accepts in input a list of providers to install.
1717
You can use the `clusterctl config providers` command to get the list of supported providers.
1818

1919
If the provider of your choice is missing, you can customize the list of supported providers by using the
20-
[clusterctl configuration](configuring-clusterctl.md) file.
20+
[clusterctl configuration](../configuration.md) file.
2121

2222
</aside>
2323

@@ -171,7 +171,7 @@ To access provider specific information, such as the components YAML to be used
171171
`clusterctl init` accesses the **provider repositories**, that are well-known places where the release assets for
172172
a provider are published.
173173

174-
See [clusterctl configuration](configuring-clusterctl.md) for more info about provider repository configurations.
174+
See [clusterctl configuration](../configuration.md) for more info about provider repository configurations.
175175

176176
<aside class="note">
177177

@@ -186,7 +186,7 @@ the user is required to save the file under `$HOME/.cluster-api/overrides/<provi
186186
Providers can use variables in the components YAML published in the provider's repository.
187187

188188
During `clusterctl init`, those variables are replaced with environment variables or with variables read from the
189-
[clusterctl configuration](configuring-clusterctl.md).
189+
[clusterctl configuration](../configuration.md).
190190

191191
<aside class="note warning">
192192

docs/book/src/clusterctl/configuring-clusterctl.md renamed to docs/book/src/clusterctl/configuration.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
# clusterctl Configuration File
22

3-
The `clusterctl` config file is located at `$HOME/.cluster-api/clusterctl.yaml` and it can be used for:
3+
The `clusterctl` config file is located at `$HOME/.cluster-api/clusterctl.yaml` and it can be used to:
44

5-
- Customizing the list of providers and provider repositories that `clusterctl` can use
6-
- Providing values to be used for variable substitution when installing providers or creating clusters
5+
- Customize the list of providers and provider repositories.
6+
- Provide configuration values to be used for variable substitution when installing providers or creating clusters.
77

88
## Provider repositories
99

10-
The `clusterctl` CLI is designed to work with all the providers implementing
11-
the [clusterct Provider Contract](contract.md).
10+
The `clusterctl` CLI is designed to work with providers implementing the [clusterct Provider Contract](contract.md).
1211

1312
Each provider is expected to define a provider repository, a well-known place where release assets are published.
1413

15-
The `clusterctl` CLI ships with providers sponsored by SIG Cluster Lifecycle.
14+
By default, `clusterctl` ships with providers sponsored by SIG Cluster Lifecycle.
1615

1716
Users can customize the list of available providers using the `clusterctl` configuration file, as shown in the following example:
1817

@@ -31,10 +30,10 @@ providers:
3130
## Variables
3231
3332
When installing a provider `clusterctl` reads a YAML file that is published in the provider repository; while executing
34-
this operation, `clusterctl` supports variable substitution e.g. for injecting the infrastructure provider credentials.
33+
this operation, `clusterctl` can perform substitute certain variables with the ones provided by the user.
3534

36-
The same mechanism apply also when `clusterctl` reads the cluster templates YAML published in the repository, eg.
37-
for injecting the Kubernetes version to use or the number of worker machines to create.
35+
The same mechanism also applies when `clusterctl` reads the cluster templates YAML published in the repository, e.g.
36+
when injecting the Kubernetes version to use. or the number of worker machines to create.
3837

3938
The user can provide values using OS environment variables, but it is also possible to add
4039
variables in the `clusterctl` config file:

docs/book/src/clusterctl/dev.md renamed to docs/book/src/clusterctl/developers.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ You can now run the local-overrides hack from the root of the local copy of Clus
4545
cmd/clusterctl/hack/local-overrides.py
4646
```
4747

48-
The script reads from the local repositories of the providers you want to install, builds the providers assets,
49-
and place them in a local override folder located under `$HOME/.cluster-api/overrides/`.
50-
Additionally, the command output provide you `clusterctl init` command with all the necessary flags.
48+
The script reads from the local repositories of the providers you want to install, builds the providers' assets,
49+
and places them in a local override folder located under `$HOME/.cluster-api/overrides/`.
50+
Additionally, the command output provides you the `clusterctl init` command with all the necessary flags.
5151

5252
```shell
5353
clusterctl local overrides generated from local repositories for the cluster-api, kubeadm-bootstrap, aws providers.

docs/book/src/clusterctl/intro.md renamed to docs/book/src/clusterctl/overview.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ See the [kind documentation](https://kind.sigs.k8s.io/) for more details.
2626
{{#/tab }}
2727
{{#tab kind for docker provider}}
2828

29-
If if are planning to use the Docker infrastructure provider a custom kind cluster configuration is required in order to
29+
If planning to use the Docker infrastructure provider a custom kind cluster configuration is required in order to
3030
because the provider needs to access Docker on the host:
3131

3232
```bash
@@ -270,9 +270,9 @@ See [`clusterctl config cluster`](config-cluster.md) for more details.
270270

271271
The `clusterctl` command supports also day 2 operations:
272272

273-
* use [`clusterctl init`](init.md) to install additional Cluster API providers
274-
* use [`clusterctl upgrade`](upgrade.md) to upgrade Cluster API providers
275-
* use [`clusterctl delete`](delete.md) to delete Cluster API providers
273+
* use [`clusterctl init`](commands/init.md) to install additional Cluster API providers
274+
* use [`clusterctl upgrade`](commands/upgrade.md) to upgrade Cluster API providers
275+
* use [`clusterctl delete`](commands/delete.md) to delete Cluster API providers
276276

277-
* use [`clusterctl config cluster`](config-cluster.md) to spec out additional workload clusters
278-
* use [`clusterctl move`](move.md) to migrate objects defining a workload clusters (e.g. Cluster, Machines) from a management cluster to another management cluster
277+
* use [`clusterctl config cluster`](commands/config-cluster.md) to spec out additional workload clusters
278+
* use [`clusterctl move`](commands/move.md) to migrate objects defining a workload clusters (e.g. Cluster, Machines) from a management cluster to another management cluster

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ a provider are published.
1010
The provider repository MUST contain the following files:
1111

1212
* The metadata YAML
13-
* The component YAML
13+
* The components YAML
1414

1515

1616
Additionally, the provider repository SHOULD contain the following files:
@@ -30,7 +30,7 @@ If, as a provider implementer, you are interested to be added to this list, plea
3030

3131
<h1>Customizing the list of providers</h1>
3232

33-
It is possible to customize the list of providers for `clusterctl` by changing the [clusterctl configuration](configuring-clusterctl.md).
33+
It is possible to customize the list of providers for `clusterctl` by changing the [clusterctl configuration](configuration.md).
3434

3535
</aside>
3636

@@ -73,7 +73,7 @@ The following rules apply:
7373
#### Naming conventions
7474

7575
It is strongly recommended that:
76-
* Core providers release a file called `core-components.yaml`
76+
* Core provider release a file called `core-components.yaml`
7777
* Infrastructure providers release a file called `infrastructure-components.yaml`
7878
* Bootstrap providers release a file called ` bootstrap-components.yaml`
7979
* Control plane providers release a file called `control-plane-components.yaml`

0 commit comments

Comments
 (0)