From 7302475fb782ef4df7528926842a9d17f1a9fd93 Mon Sep 17 00:00:00 2001 From: Alex Seymour Date: Thu, 5 Feb 2026 15:05:12 +0100 Subject: [PATCH] Update air-gapped migration instructions for Rancher backup and restore --- .../migrate-rancher-to-new-cluster.md | 36 ++++++++++++++----- .../migrate-rancher-to-new-cluster.md | 36 ++++++++++++++----- .../migrate-rancher-to-new-cluster.md | 36 ++++++++++++++----- .../migrate-rancher-to-new-cluster.md | 36 ++++++++++++++----- .../migrate-rancher-to-new-cluster.md | 36 ++++++++++++++----- 5 files changed, 135 insertions(+), 45 deletions(-) diff --git a/versioned_docs/version-2.10/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.10/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 22317321806..b7176fe5746 100644 --- a/versioned_docs/version-2.10/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.10/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -42,23 +42,41 @@ Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-o ``` 1. Install the charts: - + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION ``` - :::note + :::note - The above assumes an environment with outbound connectivity to Docker Hub. + The above assumes an environment with outbound connectivity to Docker Hub. - For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. + For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. - ```bash - --set image.repository /rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl - ``` + ```bash + --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` - ::: + If the host running the Helm commands is **also air-gapped and cannot reach charts.rancher.io**, download the charts on a non-air-gapped host and then install them from local files on the air-gapped host. + + On a non-air-gapped host: + + ```bash + helm repo add rancher-charts https://charts.rancher.io + helm repo update + helm fetch rancher-charts/rancher-backup-crd --version $CHART_VERSION + helm fetch rancher-charts/rancher-backup --version $CHART_VERSION + ``` + + Copy the `rancher-backup-crd-.tgz` and `rancher-backup-.tgz` files to the air-gapped host, then use them to install the charts: + + ```bash + helm install rancher-backup-crd ./rancher-backup-crd-.tgz -n cattle-resources-system --create-namespace + helm install rancher-backup ./rancher-backup-.tgz -n cattle-resources-system --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` + + ::: ### 2. Restore from backup using a Restore custom resource @@ -200,7 +218,7 @@ Full instructions on how to redirect traffic to the migrated cluster differ base ### 6. Scale Down the Original Rancher Instance -After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. +After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. Leaving the old server up can cause agents to keep contacting the original `server-url`, which often leaves clusters stuck in **Updating** in the new environment. diff --git a/versioned_docs/version-2.11/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.11/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 22317321806..b7176fe5746 100644 --- a/versioned_docs/version-2.11/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.11/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -42,23 +42,41 @@ Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-o ``` 1. Install the charts: - + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION ``` - :::note + :::note - The above assumes an environment with outbound connectivity to Docker Hub. + The above assumes an environment with outbound connectivity to Docker Hub. - For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. + For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. - ```bash - --set image.repository /rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl - ``` + ```bash + --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` - ::: + If the host running the Helm commands is **also air-gapped and cannot reach charts.rancher.io**, download the charts on a non-air-gapped host and then install them from local files on the air-gapped host. + + On a non-air-gapped host: + + ```bash + helm repo add rancher-charts https://charts.rancher.io + helm repo update + helm fetch rancher-charts/rancher-backup-crd --version $CHART_VERSION + helm fetch rancher-charts/rancher-backup --version $CHART_VERSION + ``` + + Copy the `rancher-backup-crd-.tgz` and `rancher-backup-.tgz` files to the air-gapped host, then use them to install the charts: + + ```bash + helm install rancher-backup-crd ./rancher-backup-crd-.tgz -n cattle-resources-system --create-namespace + helm install rancher-backup ./rancher-backup-.tgz -n cattle-resources-system --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` + + ::: ### 2. Restore from backup using a Restore custom resource @@ -200,7 +218,7 @@ Full instructions on how to redirect traffic to the migrated cluster differ base ### 6. Scale Down the Original Rancher Instance -After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. +After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. Leaving the old server up can cause agents to keep contacting the original `server-url`, which often leaves clusters stuck in **Updating** in the new environment. diff --git a/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 22317321806..b7176fe5746 100644 --- a/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.12/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -42,23 +42,41 @@ Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-o ``` 1. Install the charts: - + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION ``` - :::note + :::note - The above assumes an environment with outbound connectivity to Docker Hub. + The above assumes an environment with outbound connectivity to Docker Hub. - For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. + For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. - ```bash - --set image.repository /rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl - ``` + ```bash + --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` - ::: + If the host running the Helm commands is **also air-gapped and cannot reach charts.rancher.io**, download the charts on a non-air-gapped host and then install them from local files on the air-gapped host. + + On a non-air-gapped host: + + ```bash + helm repo add rancher-charts https://charts.rancher.io + helm repo update + helm fetch rancher-charts/rancher-backup-crd --version $CHART_VERSION + helm fetch rancher-charts/rancher-backup --version $CHART_VERSION + ``` + + Copy the `rancher-backup-crd-.tgz` and `rancher-backup-.tgz` files to the air-gapped host, then use them to install the charts: + + ```bash + helm install rancher-backup-crd ./rancher-backup-crd-.tgz -n cattle-resources-system --create-namespace + helm install rancher-backup ./rancher-backup-.tgz -n cattle-resources-system --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` + + ::: ### 2. Restore from backup using a Restore custom resource @@ -200,7 +218,7 @@ Full instructions on how to redirect traffic to the migrated cluster differ base ### 6. Scale Down the Original Rancher Instance -After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. +After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. Leaving the old server up can cause agents to keep contacting the original `server-url`, which often leaves clusters stuck in **Updating** in the new environment. diff --git a/versioned_docs/version-2.13/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.13/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 22317321806..b7176fe5746 100644 --- a/versioned_docs/version-2.13/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.13/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -42,23 +42,41 @@ Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-o ``` 1. Install the charts: - + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION ``` - :::note + :::note - The above assumes an environment with outbound connectivity to Docker Hub. + The above assumes an environment with outbound connectivity to Docker Hub. - For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. + For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. - ```bash - --set image.repository /rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl - ``` + ```bash + --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` - ::: + If the host running the Helm commands is **also air-gapped and cannot reach charts.rancher.io**, download the charts on a non-air-gapped host and then install them from local files on the air-gapped host. + + On a non-air-gapped host: + + ```bash + helm repo add rancher-charts https://charts.rancher.io + helm repo update + helm fetch rancher-charts/rancher-backup-crd --version $CHART_VERSION + helm fetch rancher-charts/rancher-backup --version $CHART_VERSION + ``` + + Copy the `rancher-backup-crd-.tgz` and `rancher-backup-.tgz` files to the air-gapped host, then use them to install the charts: + + ```bash + helm install rancher-backup-crd ./rancher-backup-crd-.tgz -n cattle-resources-system --create-namespace + helm install rancher-backup ./rancher-backup-.tgz -n cattle-resources-system --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` + + ::: ### 2. Restore from backup using a Restore custom resource @@ -200,7 +218,7 @@ Full instructions on how to redirect traffic to the migrated cluster differ base ### 6. Scale Down the Original Rancher Instance -After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. +After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. Leaving the old server up can cause agents to keep contacting the original `server-url`, which often leaves clusters stuck in **Updating** in the new environment. diff --git a/versioned_docs/version-2.9/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.9/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index f180ad65416..4563e905911 100644 --- a/versioned_docs/version-2.9/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.9/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -42,23 +42,41 @@ Install the [`rancher-backup chart`](https://github.com/rancher/backup-restore-o ``` 1. Install the charts: - + ```bash helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-resources-system --create-namespace --version $CHART_VERSION helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION ``` - :::note + :::note - The above assumes an environment with outbound connectivity to Docker Hub. + The above assumes an environment with outbound connectivity to Docker Hub. - For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. + For an **air-gapped environment**, use the following Helm values to pull the `backup-restore-operator` and `kubectl` images from your private registry when you install the rancher-backup Helm chart. - ```bash - --set image.repository /rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl - ``` + ```bash + --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` - ::: + If the host running the Helm commands is **also air-gapped and cannot reach charts.rancher.io**, download the charts on a non-air-gapped host and then install them from local files on the air-gapped host. + + On a non-air-gapped host: + + ```bash + helm repo add rancher-charts https://charts.rancher.io + helm repo update + helm fetch rancher-charts/rancher-backup-crd --version $CHART_VERSION + helm fetch rancher-charts/rancher-backup --version $CHART_VERSION + ``` + + Copy the `rancher-backup-crd-.tgz` and `rancher-backup-.tgz` files to the air-gapped host, then use them to install the charts: + + ```bash + helm install rancher-backup-crd ./rancher-backup-crd-.tgz -n cattle-resources-system --create-namespace + helm install rancher-backup ./rancher-backup-.tgz -n cattle-resources-system --set image.repository=/rancher/backup-restore-operator --set global.kubectl.repository=/rancher/kubectl + ``` + + ::: ### 2. Restore from backup using a Restore custom resource @@ -180,7 +198,7 @@ Full instructions on how to redirect traffic to the migrated cluster differ base ### 6. Scale Down the Original Rancher Instance -After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. +After redirecting traffic to the new Rancher environment, **scale the original Rancher instance to 0 replicas** so it no longer contacts your managed clusters. Leaving the old server up can cause agents to keep contacting the original `server-url`, which often leaves clusters stuck in **Updating** in the new environment.