Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ this should generally not be the case.

## Contributing a Patch

1. If you haven't already done so, sign a Contributor License Agreement (see details above).
1. If you haven't already done so, sign a [Contributor License Agreement](#contributor-license-agreements).
1. If working on an issue, signal other contributors that you are actively working on it by assigning it to yourself.
1. Fork the desired repo, develop and test your code changes.
1. Submit a pull request.
Expand Down
16 changes: 8 additions & 8 deletions docs/book/src/clusterctl/commands/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ management cluster.

## Defining the management cluster

The `clusterctl init` command accepts in input a list of providers to install.
The `clusterctl init` command accepts a list of providers to install.

<aside class="note">

Expand Down Expand Up @@ -38,10 +38,10 @@ For example, to get a fully operational management cluster with the `aws` infras
<h1> Warning </h1>

The `cluster-api` core provider, the `kubeadm` bootstrap provider, and the `kubeadm` control-plane provider are automatically installed only if:
- The user doesn't explicitly require to install a core/bootstrap/control-plane provider using the `--core` flag, the `--bootstrap` flag or the `--control-plane` flags;
- There is not an instance of a CoreProvider already installed in the cluster;
- The user doesn't explicitly install a core/bootstrap/control-plane provider using the `--core` flag, the `--bootstrap` flag or the `--control-plane` flags;
- There is no CoreProvider instance already installed in the cluster;

Please note that the second rule allows to execute `clusterctl init` more times: the first call actually initializes
Please note that the second rule allows to executing `clusterctl init` multiple times. The first call actually initializes
the management cluster, while the subsequent calls can be used to add more providers.

</aside>
Expand Down Expand Up @@ -112,7 +112,7 @@ same target namespace.

## Provider repositories

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

Expand All @@ -130,7 +130,7 @@ See [clusterctl configuration](../configuration.md) for more info about provider

<h1> Is it possible to override files read from a provider repository? </h1>

If, for any reasons, the user wants to replace the assets available on a provider repository with a locally available asset,
If, for any reason, the user wants to replace the assets available on a provider repository with a locally available asset,
the user is required to save the file under `$XDG_CONFIG_HOME/cluster-api/overrides/<provider-label>/<version>/<file-name.yaml>`.

```bash
Expand Down Expand Up @@ -168,7 +168,7 @@ When installing a provider, the `clusterctl init` command executes a set of step
the lifecycle management of the provider's components.

* All the provider's components are labeled, so they can be easily identified in
subsequent moments of the provider's lifecycle, e.g. upgrades.
subsequent stages of the provider's lifecycle, e.g. upgrades.

```bash
labels:
Expand Down Expand Up @@ -202,7 +202,7 @@ available options to customize this operation.
<h1>Warning</h1>

Please note that, if clusterctl installs cert-manager, it will take care of its lifecycle, eventually upgrading it
during clusterctl upgrade. Instead, if cert-manager is provided by the users, the user is responsible for
during clusterctl upgrade. Instead, if cert-manager is provided by the user, the user is responsible for
upgrading this component when required.

</aside>
Expand Down
10 changes: 5 additions & 5 deletions docs/book/src/clusterctl/commands/move.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# clusterctl move

The `clusterctl move` command allows to move the Cluster API objects defining workload clusters, like e.g. Cluster, Machines,
MachineDeployments, etc. from one management cluster to another management cluster.
The `clusterctl move` command allows one to move Cluster API objects defining workload clusters, e.g. Cluster, Machines,
MachineDeployments, from one management cluster to another management cluster.

<aside class="note warning">

Expand All @@ -21,8 +21,8 @@ You can use:
clusterctl move --to-kubeconfig="path-to-target-kubeconfig.yaml"
```

To move the Cluster API objects existing in the current namespace of the source management cluster; in case if you want
to move the Cluster API objects defined in another namespace, you can use the `--namespace` flag.
to move Cluster API objects existing in the current namespace of the source management cluster. In case you want
to move Cluster API objects defined in another namespace, you can add the `--namespace` flag.

The discovery mechanism for determining the objects to be moved is in the [provider contract](../../developer/providers/contracts/clusterctl.md#move)

Expand Down Expand Up @@ -103,4 +103,4 @@ This can now be achieved with the following procedure:

## Dry run

With `--dry-run` option you can dry-run the move action by only printing logs without taking any actual actions. Use log level verbosity `-v` to see different levels of information.
With the `--dry-run` option you can dry-run the move action by only printing logs without taking any actual actions. Use log level verbosity `-v` to see different levels of information.
6 changes: 3 additions & 3 deletions docs/book/src/clusterctl/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ quick start with Cluster API. It automates fetching the YAML files defining [pro
Additionally it encodes a set of best practices in managing providers, that helps the user in avoiding
mis-configurations or in managing day 2 operations such as upgrades.

Below you can find a list of main clusterctl commands:
Below you can find a list of the main clusterctl commands:

* [`clusterctl init`](commands/init.md) Initialize a management cluster.
* [`clusterctl upgrade plan`](commands/upgrade.md#upgrade-plan) Provide a list of recommended target versions for upgrading Cluster API providers in a management cluster.
Expand All @@ -24,9 +24,9 @@ For the full list of clusterctl commands please refer to [commands](commands/com

### Avoiding GitHub rate limiting

While using providers hosted on GitHub, clusterctl is calling GitHub API which are rate limited; for normal usage free tier is enough but when using clusterctl extensively users might hit the rate limit.
While using providers hosted on GitHub, clusterctl calls the GitHub API which is rate limited. For normal usage the free tier is enough but when using clusterctl extensively users might hit the rate limit.

To avoid rate limiting for the public repos set the `GITHUB_TOKEN` environment variable. To generate a token [follow this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) documentation. The token only needs `repo` scope for clusterctl.
To avoid rate limiting for the public repos set the `GITHUB_TOKEN` environment variable. To generate a token [follow this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) documentation. The token only needs the `repo` scope for clusterctl.

Per default `clusterctl` will use a go proxy to detect the available versions to prevent additional
API calls to the GitHub API. It is possible to configure the go proxy url using the `GOPROXY` variable as
Expand Down
Loading