From 1cb2277e2eea6f22320bc6dfd223258765fcf83c Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 9 Aug 2024 13:28:54 -0600 Subject: [PATCH 1/2] Clarify kurl cluster update steps --- docs/enterprise/updating-kurl.mdx | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/enterprise/updating-kurl.mdx b/docs/enterprise/updating-kurl.mdx index 3377f93237..580205beb8 100644 --- a/docs/enterprise/updating-kurl.mdx +++ b/docs/enterprise/updating-kurl.mdx @@ -21,7 +21,7 @@ For kURL installations, you can update an application from the Admin Console. Yo ## Update the kURL Cluster -You can rerun the kURL installation script to update a kURL cluster. For more information about kURL cluster udpates, see [About kURL Cluster Updates](/enterprise/updating-kurl-about). +After updating the kURL installer spec, you can rerun the kURL installation script to update a kURL cluster. For more information about kURL cluster udpates, see [About kURL Cluster Updates](/enterprise/updating-kurl-about). :::important The Kubernetes scheduler automatically reschedules Pods to other nodes during maintenance. Any deployments or StatefulSets with a single replica experience downtime while being rescheduled. @@ -31,13 +31,15 @@ The Kubernetes scheduler automatically reschedules Pods to other nodes during ma To update the kURL cluster in an online environment: +1. Edit the kURL installer spec as desired. For example, update the version of Kubernetes or add, remove, or update add-ons. For more information, see [Creating a kURL Installer](/vendor/packaging-embedded-kubernetes). + 1. Run the kURL installation script on any primary node in the cluster: - ``` + ```bash curl -sSL https://k8s.kurl.sh/APP_SLUG | sudo bash -s ADVANCED_OPTIONS ``` Replace: - * `APP_SLUG` with the unique slug for the application from your application vendor. + * `APP_SLUG` with the unique slug for the application. * `ADVANCED_OPTIONS` optionally with any flags listed in [Advanced Options](https://kurl.sh/docs/install-with-kurl/advanced-options) in the kURL documentation. To use no advanced installation options, remove `-s ADVANCED_OPTIONS` from the command. @@ -54,28 +56,23 @@ For air gap installations, you must load images on each node in the cluster befo To update the kURL cluster in an air gap environment: -1. On each node in the cluster, download the kURL `.tar.gz` bundle provided by your software vendor and extract the contents: - - ```bash - tar -xvzf FILENAME.tar.gz - ``` - Replace `FILENAME` with the name of the kURL `.tar.gz` bundle. +1. Edit the kURL installer spec as desired. For example, update the version of Kubernetes or add, remove, or update add-ons. For more information, see [Creating a kURL Installer](/vendor/packaging-embedded-kubernetes). - For more information, see [Download the kURL Bundle](/vendor/releases-download-airgap-bundles#installer-bundle) in _Downloading Air Gap Bundles_. +1. On each node in the cluster, download the kURL `.tar.gz` air gap bundle for the updated spec and extract the contents. For more information, see [Download the kURL Bundle](/vendor/releases-download-airgap-bundles#installer-bundle) in _Downloading Air Gap Bundles_. 1. Run the following KURL script to ensure all required images are available: - ``` + ```bash cat tasks.sh | sudo bash -s load-images ``` :::note - The kURL installation script that you run in the next step also performs a check for required images and prompts you to run the `load-images` command if any images are missing. + The kURL installation script that you will run in the next step also performs a check for required images and prompts you to run the `load-images` command if any images are missing. ::: 1. Run the kURL installation script on any primary node in the cluster with the `airgap` option: - ``` + ```bash cat install.sh | sudo bash -s airgap OTHER_ADVANCED_OPTIONS ``` Replace `OTHER_ADVANCED_OPTIONS` optionally with any flags listed in [Advanced Options](https://kurl.sh/docs/install-with-kurl/advanced-options) in the kURL documentation. From bef3eba0aa192d5aabd8460bf31ca40c1a0b6993 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 9 Aug 2024 13:41:36 -0600 Subject: [PATCH 2/2] refactor kurl air gap bundle step --- docs/enterprise/updating-kurl.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/enterprise/updating-kurl.mdx b/docs/enterprise/updating-kurl.mdx index 580205beb8..481b4b69fa 100644 --- a/docs/enterprise/updating-kurl.mdx +++ b/docs/enterprise/updating-kurl.mdx @@ -58,7 +58,14 @@ To update the kURL cluster in an air gap environment: 1. Edit the kURL installer spec as desired. For example, update the version of Kubernetes or add, remove, or update add-ons. For more information, see [Creating a kURL Installer](/vendor/packaging-embedded-kubernetes). -1. On each node in the cluster, download the kURL `.tar.gz` air gap bundle for the updated spec and extract the contents. For more information, see [Download the kURL Bundle](/vendor/releases-download-airgap-bundles#installer-bundle) in _Downloading Air Gap Bundles_. +1. On each node in the cluster, download the kURL `.tar.gz` air gap bundle for the updated spec. See [Download the kURL Bundle](/vendor/releases-download-airgap-bundles#installer-bundle) in _Downloading Air Gap Bundles_. + + Then, extract the contents: + + ```bash + tar -xvzf FILENAME.tar.gz + ``` + Replace `FILENAME` with the name of the downloaded kURL `.tar.gz` air gap bundle. 1. Run the following KURL script to ensure all required images are available: