Skip to content

Commit c7f50a3

Browse files
guettliguettli
authored
🌱 Update README to match CAPH v1.0.0 (#1491)
1 parent 7bb3027 commit c7f50a3

File tree

6 files changed

+33
-34
lines changed

6 files changed

+33
-34
lines changed

‎.github/actions/e2e/action.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ runs:
7777
HETZNER_SSH_PUB: ${{ inputs.e2e_ssh_pub }}
7878
HETZNER_SSH_PRIV: ${{ inputs.e2e_ssh_priv }}
7979
SKIP_IMAGE_BUILD: "1"
80-
CAPH_LATEST_VERSION: "v1.0.0-beta.26"
80+
CAPH_LATEST_VERSION: "v1.0.0"
8181
run: make ${{ inputs.e2e_make_target }}
8282
- name: Upload artifact
8383
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4

‎README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,19 +73,18 @@ In addition to the pure creation and operation of Kubernetes clusters, this prov
7373

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

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

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

8383
| | Hetzner Provider `v1.0.x` |
8484
| ----------------- | ------------------------- |
85-
| Kubernetes 1.27.x | ✅ |
86-
| Kubernetes 1.28.x | ✅ |
87-
| Kubernetes 1.29.x | ✅ |
88-
| Kubernetes 1.30.x | ✅ |
85+
| Kubernetes 1.28.x | ✅ |
86+
| Kubernetes 1.29.x | ✅ |
87+
| Kubernetes 1.30.x | ✅ |
8988

9089
Test status:
9190

‎docs/caph/01-getting-started/01-introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ It is recommended that you have at least a basic understanding of Cluster API be
1414

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

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

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

‎docs/caph/02-topics/04-upgrading-caph.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Checking new release availability...
5555
Latest release available for the v1beta1 API Version of Cluster API (contract):
5656

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

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

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

7878
## Upgrade cluster-API
7979

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

8383
```shell
8484
$ clusterctl upgrade apply --contract v1beta1
8585
Checking cert-manager version...
8686
Cert-manager is already up to date
8787
Performing upgrade...
88-
Scaling down Provider="cluster-api" Version="v1.6.0" Namespace="capi-system"
89-
Scaling down Provider="bootstrap-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-bootstrap-system"
90-
Scaling down Provider="control-plane-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-control-plane-system"
91-
Deleting Provider="cluster-api" Version="v1.6.0" Namespace="capi-system"
92-
Installing Provider="cluster-api" Version="v1.6.3" TargetNamespace="capi-system"
93-
Deleting Provider="bootstrap-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-bootstrap-system"
94-
Installing Provider="bootstrap-kubeadm" Version="v1.6.3" TargetNamespace="capi-kubeadm-bootstrap-system"
95-
Deleting Provider="control-plane-kubeadm" Version="v1.6.0" Namespace="capi-kubeadm-control-plane-system"
96-
Installing Provider="control-plane-kubeadm" Version="v1.6.3" TargetNamespace="capi-kubeadm-control-plane-system"
88+
Scaling down Provider="cluster-api" Version="v1.8.0" Namespace="capi-system"
89+
Scaling down Provider="bootstrap-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-bootstrap-system"
90+
Scaling down Provider="control-plane-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-control-plane-system"
91+
Deleting Provider="cluster-api" Version="v1.8.0" Namespace="capi-system"
92+
Installing Provider="cluster-api" Version="v1.8.4" TargetNamespace="capi-system"
93+
Deleting Provider="bootstrap-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-bootstrap-system"
94+
Installing Provider="bootstrap-kubeadm" Version="v1.8.4" TargetNamespace="capi-kubeadm-bootstrap-system"
95+
Deleting Provider="control-plane-kubeadm" Version="v1.8.0" Namespace="capi-kubeadm-control-plane-system"
96+
Installing Provider="control-plane-kubeadm" Version="v1.8.4" TargetNamespace="capi-kubeadm-control-plane-system"
9797
```
9898

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

109109
You can find the latest version of CAPH here:
110110

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

113113
```shell
114-
$ clusterctl upgrade apply --infrastructure=hetzner:v1.0.0-beta.33
114+
$ clusterctl upgrade apply --infrastructure=hetzner:v1.0.0
115115
Checking cert-manager version...
116116
Cert-manager is already up to date
117117
Performing upgrade...
118118
Scaling down Provider="infrastructure-hetzner" Version="" Namespace="caph-system"
119119
Deleting Provider="infrastructure-hetzner" Version="" Namespace="caph-system"
120-
Installing Provider="infrastructure-hetzner" Version="v1.0.0-beta.33" TargetNamespace="caph-system"
120+
Installing Provider="infrastructure-hetzner" Version="v1.0.0" TargetNamespace="caph-system"
121121
```
122122

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

131131
{% callout %}
132132

133-
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`
133+
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`
134134

135135
{% /callout %}
136136

‎docs/caph/02-topics/05-baremetal/02-management-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Waiting for cert-manager to be available...
6060
Installing Provider="cluster-api" Version="v1.7.1" TargetNamespace="capi-system"
6161
Installing Provider="bootstrap-kubeadm" Version="v1.7.1" TargetNamespace="capi-kubeadm-bootstrap-system"
6262
Installing Provider="control-plane-kubeadm" Version="v1.7.1" TargetNamespace="capi-kubeadm-control-plane-system"
63-
Installing Provider="infrastructure-hetzner" Version="v1.0.0-beta.33" TargetNamespace="caph-system"
63+
Installing Provider="infrastructure-hetzner" Version="v1.0.0" TargetNamespace="caph-system"
6464

6565
Your management cluster has been initialized successfully!
6666

‎docs/caph/03-reference/06-hetzner-bare-metal-machine-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Example of pulling an image from an oci-registry:
103103
```yaml
104104
image:
105105
name: Ubuntu-2204-jammy-amd64-custom
106-
url: oci://ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.0-beta.2
106+
url: oci://ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.1
107107
```
108108
109109
If you need credentials to pull the image, then provide the environment variable `OCI_REGISTRY_AUTH_TOKEN` to the controller.
@@ -135,6 +135,6 @@ spec:
135135
You can push an image to an oci-registry with a tool like [oras](https://oras.land):
136136

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

0 commit comments

Comments
 (0)