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.

Sign up for GitHub

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

🌱 Update README to match CAPH v1.0.0 #1491

Merged
merged 1 commit into from
Oct 15, 2024
Merged

🌱 Update README to match CAPH v1.0.0 #1491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 .github/actions/e2e/action.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ runs:
HETZNER_SSH_PUB: ${{ inputs.e2e_ssh_pub }}
HETZNER_SSH_PRIV: ${{ inputs.e2e_ssh_priv }}
SKIP_IMAGE_BUILD: "1"
CAPH_LATEST_VERSION: "v1.0.0-beta.26"
CAPH_LATEST_VERSION: "v1.0.0"
run: make ${{ inputs.e2e_make_target }}
- name: Upload artifact
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
Expand Down
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,18 @@ In addition to the pure creation and operation of Kubernetes clusters, this prov

This provider's versions are compatible with the following versions of Cluster API:

| | Cluster API `v1beta1` (`v1.6.x`) | Cluster API `v1beta1` (`v1.7.x`) |
| --------------------------------- | -------------------------------- | -------------------------------- |
| Hetzner Provider `v1.0.0-beta.33` | ✅ | ❌ |
| Hetzner Provider `v1.0.0-beta.34-40` | ❌ | ✅ |
| | CAPI `v1beta1` (`v1.7.x`) | CAPI `v1beta1` (`v1.8.x`) |
| ------------------------------------ | ------------------------- | ------------------------- |
| Hetzner Provider `v1.0.0-beta.34-43` | ✅ | ❌ |
| Hetzner Provider `v1.0.0` | ✅ | ✅ |

This provider's versions can install and manage the following versions of Kubernetes:

| | Hetzner Provider `v1.0.x` |
| ----------------- | ------------------------- |
| Kubernetes 1.27.x | ✅ |
| Kubernetes 1.28.x | ✅ |
| Kubernetes 1.29.x | ✅ |
| Kubernetes 1.30.x | ✅ |
| Kubernetes 1.28.x | ✅ |
| Kubernetes 1.29.x | ✅ |
| Kubernetes 1.30.x | ✅ |

Test status:

Expand Down
8 changes: 4 additions & 4 deletions docs/caph/01-getting-started/01-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ It is recommended that you have at least a basic understanding of Cluster API be

This provider's versions are compatible with the following versions of Cluster API:

| | Cluster API `v1beta1` (`v1.6.x`) | Cluster API `v1beta1` (`v1.7.x`) |
| --------------------------------- | -------------------------------- | -------------------------------- |
| Hetzner Provider `v1.0.0-beta.33` | ✅ | ❌ |
| Hetzner Provider `v1.0.0-beta.34-35` | ❌ | ✅ |
| | CAPI `v1beta1` (`v1.7.x`) | CAPI `v1beta1` (`v1.8.x`) |
| ------------------------------------ | ------------------------- | ------------------------- |
| Hetzner Provider `v1.0.0-beta.34-43` | ✅ | ❌ |
| Hetzner Provider `v1.0.0` | ✅ | ✅ |

This provider's versions can install and manage the following versions of Kubernetes:

Expand Down
36 changes: 18 additions & 18 deletions docs/caph/02-topics/04-upgrading-caph.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ Checking new release availability...
Latest release available for the v1beta1 API Version of Cluster API (contract):

NAME NAMESPACE TYPE CURRENT VERSION NEXT VERSION
bootstrap-kubeadm capi-kubeadm-bootstrap-system BootstrapProvider v1.6.0 v1.6.3
control-plane-kubeadm capi-kubeadm-control-plane-system ControlPlaneProvider v1.6.0 v1.6.3
cluster-api capi-system CoreProvider v1.6.0 v1.6.3
infrastructure-hetzner caph-system InfrastructureProvider v1.0.0-beta.30 Already up to date
bootstrap-kubeadm capi-kubeadm-bootstrap-system BootstrapProvider v1.8.0 v1.8.4
control-plane-kubeadm capi-kubeadm-control-plane-system ControlPlaneProvider v1.8.0 v1.8.4
cluster-api capi-system CoreProvider v1.8.0 v1.8.4
infrastructure-hetzner caph-system InfrastructureProvider v1.0.0 Already up to date

You can now apply the upgrade by executing the following command:

Expand All @@ -77,23 +77,23 @@ You might be surprised that for `infrastructure-hetzner`, you see the "Already u

## Upgrade cluster-API

We will upgrade cluster API core components to v1.6.3 version.
We will upgrade cluster API core components to v1.8.4 version.
Use the command, which you saw in the plan:

```shell
$ clusterctl upgrade apply --contract v1beta1
Checking cert-manager version...
Cert-manager is already up to date
Performing upgrade...
Scaling down Provider="cluster-api" Version="v1.6.0" Namespace="capi-system"
Scaling down Provider="bootstrap-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-bootstrap-system"
Scaling down Provider="control-plane-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-control-plane-system"
Deleting Provider="cluster-api" Version="v1.6.0" Namespace="capi-system"
Installing Provider="cluster-api" Version="v1.6.3" TargetNamespace="capi-system"
Deleting Provider="bootstrap-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-bootstrap-system"
Installing Provider="bootstrap-kubeadm" Version="v1.6.3" TargetNamespace="capi-kubeadm-bootstrap-system"
Deleting Provider="control-plane-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-control-plane-system"
Installing Provider="control-plane-kubeadm" Version="v1.6.3" TargetNamespace="capi-kubeadm-control-plane-system"
Scaling down Provider="cluster-api" Version="v1.8.0" Namespace="capi-system"
Scaling down Provider="bootstrap-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-bootstrap-system"
Scaling down Provider="control-plane-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-control-plane-system"
Deleting Provider="cluster-api" Version="v1.8.0" Namespace="capi-system"
Installing Provider="cluster-api" Version="v1.8.4" TargetNamespace="capi-system"
Deleting Provider="bootstrap-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-bootstrap-system"
Installing Provider="bootstrap-kubeadm" Version="v1.8.4" TargetNamespace="capi-kubeadm-bootstrap-system"
Deleting Provider="control-plane-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-control-plane-system"
Installing Provider="control-plane-kubeadm" Version="v1.8.4" TargetNamespace="capi-kubeadm-control-plane-system"
```

Great, cluster-API was upgraded.
Expand All @@ -108,16 +108,16 @@ If you want to update only one components or update components one by one then t

You can find the latest version of CAPH here:

https://github.com/syself/cluster-api-provider-hetzner/tags
<https://github.com/syself/cluster-api-provider-hetzner/tags>

```shell
$ clusterctl upgrade apply --infrastructure=hetzner:v1.0.0-beta.33
$ clusterctl upgrade apply --infrastructure=hetzner:v1.0.0
Checking cert-manager version...
Cert-manager is already up to date
Performing upgrade...
Scaling down Provider="infrastructure-hetzner" Version="" Namespace="caph-system"
Deleting Provider="infrastructure-hetzner" Version="" Namespace="caph-system"
Installing Provider="infrastructure-hetzner" Version="v1.0.0-beta.33" TargetNamespace="caph-system"
Installing Provider="infrastructure-hetzner" Version="v1.0.0" TargetNamespace="caph-system"
```

After the upgrade, you'll notice the new pod spinning up the `caph-system` namespace.
Expand All @@ -130,7 +130,7 @@ caph-controller-manager-85fcb6ffcb-4sj6d 1/1 Running 0 79s

{% callout %}

Please note that `clusterctl` doesn't support pre-release of GitHub by default so if you want to use a pre-release, you'll have to specify the version such as `hetzner:v1.0.0-beta.33`
Please note that `clusterctl` doesn't support pre-release of GitHub by default so if you want to use a pre-release, you'll have to specify the version such as `hetzner:v1.0.0`

{% /callout %}

Expand Down
2 changes: 1 addition & 1 deletion docs/caph/02-topics/05-baremetal/02-management-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Waiting for cert-manager to be available...
Installing Provider="cluster-api" Version="v1.7.1" TargetNamespace="capi-system"
Installing Provider="bootstrap-kubeadm" Version="v1.7.1" TargetNamespace="capi-kubeadm-bootstrap-system"
Installing Provider="control-plane-kubeadm" Version="v1.7.1" TargetNamespace="capi-kubeadm-control-plane-system"
Installing Provider="infrastructure-hetzner" Version="v1.0.0-beta.33" TargetNamespace="caph-system"
Installing Provider="infrastructure-hetzner" Version="v1.0.0" TargetNamespace="caph-system"

Your management cluster has been initialized successfully!

Expand Down
4 changes: 2 additions & 2 deletions docs/caph/03-reference/06-hetzner-bare-metal-machine-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Example of pulling an image from an oci-registry:
```yaml
image:
name: Ubuntu-2204-jammy-amd64-custom
url: oci://ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.0-beta.2
url: oci://ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.1
```

If you need credentials to pull the image, then provide the environment variable `OCI_REGISTRY_AUTH_TOKEN` to the controller.
Expand Down Expand Up @@ -135,6 +135,6 @@ spec:
You can push an image to an oci-registry with a tool like [oras](https://oras.land):

```shell
oras push ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.0-beta.2 \
oras push ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.1 \
--artifact-type application/vnd.myorg.machine-image.v1 Ubuntu-2204-jammy-amd64-custom.tar.gz
```
Loading