Skip to content

Commit

Permalink
add docs/examples for pre-release and nightly img deployments with cl…
Browse files Browse the repository at this point in the history
…usterctl
  • Loading branch information
cahillsf committed Dec 5, 2023
1 parent ef2a1df commit 92017d6
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/book/src/clusterctl/commands/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,40 @@ clusterctl upgrade apply \
In this case, all the provider's versions must be explicitly stated.

</aside>

<aside class="note warning">

<h1> Upgrading to Cluster API core components pre-release versions </h1>

Use `clusterctl` CLI options to target the [desired version](https://github.com/kubernetes-sigs/cluster-api/releases).

The following shows an example of upgrading `bootrap`, `kubeadm` and `core` components to version `v1.6.0-rc.1`:

```bash
TARGET_VERSION=v1.6.0-rc.1

clusterctl upgrade apply \
--bootstrap=kubeadm:${TARGET_VERSION} \
--control-plane=kubeadm:${TARGET_VERSION} \
--core=cluster-api:${TARGET_VERSION}
```

</aside>

<aside class="note warning">

<h1> Deploying nightly release images </h1>

Cluster API publishes nightly versions of the project's images from the `main` branch to a `staging` registry that can be deployed in a management cluster using [clusterctl image overrides](../configuration.md#image-overrides).

The tagging convention for the nightly images is `nightly_main_$(shell date +'%Y%m%d')`.

For example, to deploy the image versions `nightly_main_20231201` from the Cluster API staging repository, add the following `images` override entry to your [clusterctl config file](../configuration.md#clusterctl-configuration-file):

```yaml
images:
all:
tag: nightly_main_20231201
repository: gcr.io/k8s-staging-cluster-api
```
</aside>

0 comments on commit 92017d6

Please sign in to comment.