From 3a373c0fa3a886600feed467da063bcac936591b Mon Sep 17 00:00:00 2001 From: rishabh Date: Sat, 11 Apr 2026 18:00:55 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20backport=20air-gap=20image=20step=20imp?= =?UTF-8?q?rovements=20to=20v2.10=E2=80=93v2.14?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: rishabh --- .../publish-images.md | 37 +++++++++++++++---- .../publish-images.md | 37 +++++++++++++++---- .../publish-images.md | 37 +++++++++++++++---- .../publish-images.md | 37 +++++++++++++++---- .../publish-images.md | 37 +++++++++++++++---- .../publish-images.md | 37 +++++++++++++++---- 6 files changed, 180 insertions(+), 42 deletions(-) diff --git a/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md b/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md index 992129fc684..d546b027741 100644 --- a/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md +++ b/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md @@ -42,7 +42,7 @@ If you will use ARM64 hosts, the registry must support manifests. As of April 20 1. Go to our [releases page,](https://github.com/rancher/rancher/releases) find the Rancher v2.x.x release that you want to install, and click **Assets**. Note: Don't use releases marked `rc` or `Pre-release`, as they are not stable for production environments. -2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air gap environment: +2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air-gap environment: | Release File | Description | | ---------------- | -------------- | @@ -83,16 +83,39 @@ In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS ### 3. Save the images to your workstation -1. Make `rancher-save-images.sh` an executable: - ``` +(Optional) Verify the image list before pulling: + +```bash +wc -l rancher-images.txt +head rancher-images.txt +``` + +1. Make `rancher-save-images.sh` executable: + ```bash chmod +x rancher-save-images.sh ``` 1. Run `rancher-save-images.sh` with the `rancher-images.txt` image list to create a tarball of all the required images: - ```plain + ```bash ./rancher-save-images.sh --image-list ./rancher-images.txt ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. + +(Optional) Specify a custom output file: + +```bash +./rancher-save-images.sh \ + --image-list ./rancher-images.txt \ + --images rancher-images-custom.tar.gz +``` + +**Result:** Docker begins pulling the images required for an air-gap installation. The process may take several minutes. + +1. Verify that the tarball was created: + ```bash + ls -lh rancher-images.tar.gz + ``` + +If some images fail to pull, review the output and retry after resolving any issues. ### 4. Populate the private registry @@ -163,7 +186,7 @@ Your registry must support manifests. As of April 2020, Amazon Elastic Container ./rancher-save-images.ps1 ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. + **Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. @@ -273,7 +296,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are ./rancher-save-images.sh --image-list ./rancher-images.txt ``` -**Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. +**Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. diff --git a/versioned_docs/version-2.10/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md b/versioned_docs/version-2.10/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md index 992129fc684..d546b027741 100644 --- a/versioned_docs/version-2.10/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md +++ b/versioned_docs/version-2.10/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md @@ -42,7 +42,7 @@ If you will use ARM64 hosts, the registry must support manifests. As of April 20 1. Go to our [releases page,](https://github.com/rancher/rancher/releases) find the Rancher v2.x.x release that you want to install, and click **Assets**. Note: Don't use releases marked `rc` or `Pre-release`, as they are not stable for production environments. -2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air gap environment: +2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air-gap environment: | Release File | Description | | ---------------- | -------------- | @@ -83,16 +83,39 @@ In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS ### 3. Save the images to your workstation -1. Make `rancher-save-images.sh` an executable: - ``` +(Optional) Verify the image list before pulling: + +```bash +wc -l rancher-images.txt +head rancher-images.txt +``` + +1. Make `rancher-save-images.sh` executable: + ```bash chmod +x rancher-save-images.sh ``` 1. Run `rancher-save-images.sh` with the `rancher-images.txt` image list to create a tarball of all the required images: - ```plain + ```bash ./rancher-save-images.sh --image-list ./rancher-images.txt ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. + +(Optional) Specify a custom output file: + +```bash +./rancher-save-images.sh \ + --image-list ./rancher-images.txt \ + --images rancher-images-custom.tar.gz +``` + +**Result:** Docker begins pulling the images required for an air-gap installation. The process may take several minutes. + +1. Verify that the tarball was created: + ```bash + ls -lh rancher-images.tar.gz + ``` + +If some images fail to pull, review the output and retry after resolving any issues. ### 4. Populate the private registry @@ -163,7 +186,7 @@ Your registry must support manifests. As of April 2020, Amazon Elastic Container ./rancher-save-images.ps1 ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. + **Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. @@ -273,7 +296,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are ./rancher-save-images.sh --image-list ./rancher-images.txt ``` -**Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. +**Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. diff --git a/versioned_docs/version-2.11/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md b/versioned_docs/version-2.11/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md index 992129fc684..d546b027741 100644 --- a/versioned_docs/version-2.11/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md +++ b/versioned_docs/version-2.11/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md @@ -42,7 +42,7 @@ If you will use ARM64 hosts, the registry must support manifests. As of April 20 1. Go to our [releases page,](https://github.com/rancher/rancher/releases) find the Rancher v2.x.x release that you want to install, and click **Assets**. Note: Don't use releases marked `rc` or `Pre-release`, as they are not stable for production environments. -2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air gap environment: +2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air-gap environment: | Release File | Description | | ---------------- | -------------- | @@ -83,16 +83,39 @@ In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS ### 3. Save the images to your workstation -1. Make `rancher-save-images.sh` an executable: - ``` +(Optional) Verify the image list before pulling: + +```bash +wc -l rancher-images.txt +head rancher-images.txt +``` + +1. Make `rancher-save-images.sh` executable: + ```bash chmod +x rancher-save-images.sh ``` 1. Run `rancher-save-images.sh` with the `rancher-images.txt` image list to create a tarball of all the required images: - ```plain + ```bash ./rancher-save-images.sh --image-list ./rancher-images.txt ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. + +(Optional) Specify a custom output file: + +```bash +./rancher-save-images.sh \ + --image-list ./rancher-images.txt \ + --images rancher-images-custom.tar.gz +``` + +**Result:** Docker begins pulling the images required for an air-gap installation. The process may take several minutes. + +1. Verify that the tarball was created: + ```bash + ls -lh rancher-images.tar.gz + ``` + +If some images fail to pull, review the output and retry after resolving any issues. ### 4. Populate the private registry @@ -163,7 +186,7 @@ Your registry must support manifests. As of April 2020, Amazon Elastic Container ./rancher-save-images.ps1 ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. + **Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. @@ -273,7 +296,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are ./rancher-save-images.sh --image-list ./rancher-images.txt ``` -**Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. +**Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. diff --git a/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md b/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md index 992129fc684..d546b027741 100644 --- a/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md +++ b/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md @@ -42,7 +42,7 @@ If you will use ARM64 hosts, the registry must support manifests. As of April 20 1. Go to our [releases page,](https://github.com/rancher/rancher/releases) find the Rancher v2.x.x release that you want to install, and click **Assets**. Note: Don't use releases marked `rc` or `Pre-release`, as they are not stable for production environments. -2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air gap environment: +2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air-gap environment: | Release File | Description | | ---------------- | -------------- | @@ -83,16 +83,39 @@ In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS ### 3. Save the images to your workstation -1. Make `rancher-save-images.sh` an executable: - ``` +(Optional) Verify the image list before pulling: + +```bash +wc -l rancher-images.txt +head rancher-images.txt +``` + +1. Make `rancher-save-images.sh` executable: + ```bash chmod +x rancher-save-images.sh ``` 1. Run `rancher-save-images.sh` with the `rancher-images.txt` image list to create a tarball of all the required images: - ```plain + ```bash ./rancher-save-images.sh --image-list ./rancher-images.txt ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. + +(Optional) Specify a custom output file: + +```bash +./rancher-save-images.sh \ + --image-list ./rancher-images.txt \ + --images rancher-images-custom.tar.gz +``` + +**Result:** Docker begins pulling the images required for an air-gap installation. The process may take several minutes. + +1. Verify that the tarball was created: + ```bash + ls -lh rancher-images.tar.gz + ``` + +If some images fail to pull, review the output and retry after resolving any issues. ### 4. Populate the private registry @@ -163,7 +186,7 @@ Your registry must support manifests. As of April 2020, Amazon Elastic Container ./rancher-save-images.ps1 ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. + **Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. @@ -273,7 +296,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are ./rancher-save-images.sh --image-list ./rancher-images.txt ``` -**Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. +**Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. diff --git a/versioned_docs/version-2.13/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md b/versioned_docs/version-2.13/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md index 992129fc684..d546b027741 100644 --- a/versioned_docs/version-2.13/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md +++ b/versioned_docs/version-2.13/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md @@ -42,7 +42,7 @@ If you will use ARM64 hosts, the registry must support manifests. As of April 20 1. Go to our [releases page,](https://github.com/rancher/rancher/releases) find the Rancher v2.x.x release that you want to install, and click **Assets**. Note: Don't use releases marked `rc` or `Pre-release`, as they are not stable for production environments. -2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air gap environment: +2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air-gap environment: | Release File | Description | | ---------------- | -------------- | @@ -83,16 +83,39 @@ In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS ### 3. Save the images to your workstation -1. Make `rancher-save-images.sh` an executable: - ``` +(Optional) Verify the image list before pulling: + +```bash +wc -l rancher-images.txt +head rancher-images.txt +``` + +1. Make `rancher-save-images.sh` executable: + ```bash chmod +x rancher-save-images.sh ``` 1. Run `rancher-save-images.sh` with the `rancher-images.txt` image list to create a tarball of all the required images: - ```plain + ```bash ./rancher-save-images.sh --image-list ./rancher-images.txt ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. + +(Optional) Specify a custom output file: + +```bash +./rancher-save-images.sh \ + --image-list ./rancher-images.txt \ + --images rancher-images-custom.tar.gz +``` + +**Result:** Docker begins pulling the images required for an air-gap installation. The process may take several minutes. + +1. Verify that the tarball was created: + ```bash + ls -lh rancher-images.tar.gz + ``` + +If some images fail to pull, review the output and retry after resolving any issues. ### 4. Populate the private registry @@ -163,7 +186,7 @@ Your registry must support manifests. As of April 2020, Amazon Elastic Container ./rancher-save-images.ps1 ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. + **Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. @@ -273,7 +296,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are ./rancher-save-images.sh --image-list ./rancher-images.txt ``` -**Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. +**Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. diff --git a/versioned_docs/version-2.14/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md b/versioned_docs/version-2.14/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md index 992129fc684..d546b027741 100644 --- a/versioned_docs/version-2.14/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md +++ b/versioned_docs/version-2.14/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md @@ -42,7 +42,7 @@ If you will use ARM64 hosts, the registry must support manifests. As of April 20 1. Go to our [releases page,](https://github.com/rancher/rancher/releases) find the Rancher v2.x.x release that you want to install, and click **Assets**. Note: Don't use releases marked `rc` or `Pre-release`, as they are not stable for production environments. -2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air gap environment: +2. From the release's **Assets** section, download the following files, which are required to install Rancher in an air-gap environment: | Release File | Description | | ---------------- | -------------- | @@ -83,16 +83,39 @@ In a Kubernetes Install, if you elect to use the Rancher default self-signed TLS ### 3. Save the images to your workstation -1. Make `rancher-save-images.sh` an executable: - ``` +(Optional) Verify the image list before pulling: + +```bash +wc -l rancher-images.txt +head rancher-images.txt +``` + +1. Make `rancher-save-images.sh` executable: + ```bash chmod +x rancher-save-images.sh ``` 1. Run `rancher-save-images.sh` with the `rancher-images.txt` image list to create a tarball of all the required images: - ```plain + ```bash ./rancher-save-images.sh --image-list ./rancher-images.txt ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. + +(Optional) Specify a custom output file: + +```bash +./rancher-save-images.sh \ + --image-list ./rancher-images.txt \ + --images rancher-images-custom.tar.gz +``` + +**Result:** Docker begins pulling the images required for an air-gap installation. The process may take several minutes. + +1. Verify that the tarball was created: + ```bash + ls -lh rancher-images.tar.gz + ``` + +If some images fail to pull, review the output and retry after resolving any issues. ### 4. Populate the private registry @@ -163,7 +186,7 @@ Your registry must support manifests. As of April 2020, Amazon Elastic Container ./rancher-save-images.ps1 ``` - **Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. + **Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-windows-images.tar.gz`. Check that the output is in the directory. @@ -273,7 +296,7 @@ The workstation must have Docker 18.02+ in order to support manifests, which are ./rancher-save-images.sh --image-list ./rancher-images.txt ``` -**Result:** Docker begins pulling the images used for an air gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory. +**Result:** Docker begins pulling the images used for an air-gap install. Be patient. This process takes a few minutes. When the process completes, your current directory will output a tarball named `rancher-images.tar.gz`. Check that the output is in the directory.