Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 add docs/examples for pre-release and nightly img version deployments with clusterctl #9797

Merged
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
27 changes: 27 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,30 @@ 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>
Copy link
Member

@sbueringer sbueringer Dec 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for writing this up!

Can you please try if it's possible to overwrite only the URL for the providers instead of the images (see: #9604 (comment))

This way we would also get the latest manifests if I understand it correctly

(also gave a pointer on how to use core CAPI nightly images for provider e2e tests there)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 @sbueringer have not gotten any traction on the linked issue re adding googlestorage repo support

wdyt if i update this current PR to remove the example for overwriting the image tag and simplify the doc update to mention the location of the nightly release YAMLs.

i will also create a follow up issue to address Add support for consuming nightly release manifests in clusterctl?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pushed up some changes here when you have a chance to take another pass

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx!


Cluster API publishes nightly versions of the project componenents' manifests from the `main` branch to a Google storage bucket for user consumption. The syntax for the URL is: `https://storage.googleapis.com/artifacts.k8s-staging-cluster-api.appspot.com/components/nightly_main_<YYYYMMDD>/<COMPENENT_NAME>-components.yaml`.

For example, to retrieve the core component manifest published January 1, 2024, the following URL can be used: https://storage.googleapis.com/artifacts.k8s-staging-cluster-api.appspot.com/components/nightly_main_20240101/core-components.yaml.