Skip to content

Commit 19cd62b

Browse files
furkatgofurov7furkatgofurov7
authored
Merge pull request #363 from anmazzotti/document_helmapp_workaround
Document HelmApp to HelmOp migration
2 parents bff8abb + d78a65c commit 19cd62b

File tree

5 files changed

+24
-14
lines changed

5 files changed

+24
-14
lines changed

‎docs/next/modules/en/pages/operator/airgapped.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ spec:
5050

5151
== How to mirror CAPI Provider OCI artifact
5252

53-
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
53+
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
5454

5555
Install the ORAS (OCI Registry As Storage) CLI tool to manage OCI artifacts. Follow the installation instructions at: https://oras.land/docs/installation
5656

@@ -116,7 +116,7 @@ kubectl apply -f capz-provider-oci.yaml
116116
Using kubectl operator::
117117
+
118118
====
119-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
119+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
120120

121121
Install https://cluster-api-operator.sigs.k8s.io/03_topics/03_plugin/01_installation[cluster-api-operator] plugin for `kubectl`
122122

@@ -177,7 +177,7 @@ kubectl operator publish -u ${PROD_REGISTRY}:${RELEASE_TAG} infrastructure-compo
177177
Using Oras::
178178
+
179179
====
180-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
180+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
181181

182182
Clone the official https://github.com/kubernetes-sigs/cluster-api-provider-azure/[Azure CAPI Provider repository] and navigate to the project directory
183183

‎docs/next/modules/en/pages/user/clusterclass.adoc‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,9 +406,19 @@ spec:
406406

407407
== Create a Cluster from a ClusterClass
408408

409-
[WARNING]
409+
[IMPORTANT]
410410
====
411-
The experimental `HelmApp` CRD introduced in Rancher `v2.11` has been renamed to `HelmOp` in Rancher `v2.12`.
411+
The experimental `HelmApp` CRD introduced in Rancher `v2.11` has been renamed to `HelmOp` in Rancher `v2.12`.
412+
Upgrading to Rancher `v2.12` or higher will lead to the removal of `HelmApps`, potentially breaking the provisioned Clusters.
413+
414+
In order to migrate to Rancher `v2.12` and `HelmOps`, you need to take the following steps:
415+
416+
1. **Before** upgrading Rancher, update all the `HelmApps` with `HelmApp.spec.keepResources: true`. This will prevent the deployed Helm chart to be uninstalled downstream once the `HelmApp` resource is deleted.
417+
2. Upgrade Rancher to `v2.12` or higher. Wait until the `HelmApp` CRD has been removed, and the new `HelmOp` has been installed by the Fleet `v0.13` version update.
418+
3. Upgrade Rancher Turtles to `v0.24` or higher.
419+
4. Deploy the converted `HelmOps` ensuring `HelmOp.spec.helm.takeOwnership: true`.
420+
421+
Following these steps is necessary to guarantee the downstream Clusters will not be affected during the `HelmApp` conversion.
412422
====
413423

414424
[tabs]

‎docs/v0.21/modules/en/pages/operator/airgapped.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ spec:
5050

5151
== How to mirror CAPI Provider OCI artifact
5252

53-
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
53+
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
5454

5555
Install the ORAS (OCI Registry As Storage) CLI tool to manage OCI artifacts. Follow the installation instructions at: https://oras.land/docs/installation
5656

@@ -116,7 +116,7 @@ kubectl apply -f capz-provider-oci.yaml
116116
Using kubectl operator::
117117
+
118118
====
119-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
119+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
120120

121121
Install https://cluster-api-operator.sigs.k8s.io/03_topics/03_plugin/01_installation[cluster-api-operator] plugin for `kubectl`
122122

@@ -177,7 +177,7 @@ kubectl operator publish -u ${PROD_REGISTRY}:${RELEASE_TAG} infrastructure-compo
177177
Using Oras::
178178
+
179179
====
180-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
180+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
181181

182182
Clone the official https://github.com/kubernetes-sigs/cluster-api-provider-azure/[Azure CAPI Provider repository] and navigate to the project directory
183183

‎docs/v0.22/modules/en/pages/operator/airgapped.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ spec:
5050

5151
== How to mirror CAPI Provider OCI artifact
5252

53-
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
53+
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
5454

5555
Install the ORAS (OCI Registry As Storage) CLI tool to manage OCI artifacts. Follow the installation instructions at: https://oras.land/docs/installation
5656

@@ -116,7 +116,7 @@ kubectl apply -f capz-provider-oci.yaml
116116
Using kubectl operator::
117117
+
118118
====
119-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
119+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
120120

121121
Install https://cluster-api-operator.sigs.k8s.io/03_topics/03_plugin/01_installation[cluster-api-operator] plugin for `kubectl`
122122

@@ -177,7 +177,7 @@ kubectl operator publish -u ${PROD_REGISTRY}:${RELEASE_TAG} infrastructure-compo
177177
Using Oras::
178178
+
179179
====
180-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
180+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
181181

182182
Clone the official https://github.com/kubernetes-sigs/cluster-api-provider-azure/[Azure CAPI Provider repository] and navigate to the project directory
183183

‎docs/v0.23/modules/en/pages/operator/airgapped.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ spec:
5050

5151
== How to mirror CAPI Provider OCI artifact
5252

53-
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
53+
You mirror OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
5454

5555
Install the ORAS (OCI Registry As Storage) CLI tool to manage OCI artifacts. Follow the installation instructions at: https://oras.land/docs/installation
5656

@@ -116,7 +116,7 @@ kubectl apply -f capz-provider-oci.yaml
116116
Using kubectl operator::
117117
+
118118
====
119-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
119+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
120120

121121
Install https://cluster-api-operator.sigs.k8s.io/03_topics/03_plugin/01_installation[cluster-api-operator] plugin for `kubectl`
122122

@@ -177,7 +177,7 @@ kubectl operator publish -u ${PROD_REGISTRY}:${RELEASE_TAG} infrastructure-compo
177177
Using Oras::
178178
+
179179
====
180-
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-default.yaml
180+
You can build OCI artifacts for any CAPI Provider listed in the Rancher Turtles configuration: https://github.com/rancher/turtles/blob/main/internal/controllers/clusterctl/config-community.yaml
181181

182182
Clone the official https://github.com/kubernetes-sigs/cluster-api-provider-azure/[Azure CAPI Provider repository] and navigate to the project directory
183183

0 commit comments

Comments
 (0)