From de7e238e5342bdc9c907215b5800d5c292712ec6 Mon Sep 17 00:00:00 2001 From: Pankti Shah Date: Fri, 27 Oct 2023 15:52:25 -0700 Subject: [PATCH] update docs about changes that went in for kindless upgrade task --- .../en/docs/clustermgmt/cluster-upgrades/baremetal-upgrades.md | 1 + .../cluster-upgrades/vsphere-and-cloudstack-upgrades.md | 1 + docs/content/en/docs/getting-started/baremetal/bare-spec.md | 1 + docs/content/en/docs/getting-started/cloudstack/cloud-spec.md | 1 + docs/content/en/docs/getting-started/nutanix/nutanix-spec.md | 2 ++ docs/content/en/docs/getting-started/vsphere/vsphere-spec.md | 1 + 6 files changed, 7 insertions(+) diff --git a/docs/content/en/docs/clustermgmt/cluster-upgrades/baremetal-upgrades.md b/docs/content/en/docs/clustermgmt/cluster-upgrades/baremetal-upgrades.md index 580b02a7d847a..bea92c6941056 100755 --- a/docs/content/en/docs/clustermgmt/cluster-upgrades/baremetal-upgrades.md +++ b/docs/content/en/docs/clustermgmt/cluster-upgrades/baremetal-upgrades.md @@ -31,6 +31,7 @@ If you have a management cluster running EKS Anywhere version v0.15, you can suc When triggering a workload cluster upgrade after upgrading the management cluster, please keep in mind that it will not only apply your changes in the workload cluster spec, but also any new improvements included in the new EKS Anywhere controller that was upgraded on the management cluster. The changes in the EKS Anywhere controller can trigger a machine rollout on the workload cluster during upgrade, even if the changes to the workload cluster spec didn't require one (for example, scaling down a worker node group). +To upgrade a cluster to v0.18.x `eksctl anywhere` version, it is madatory to upgrade the cluster first to `eksctl anywhere` version v0.17.x. From v0.18.0 onwards, CLI waits for 1 hour combined for waiting for etcd to be ready, control plane to be ready, default CNI to be configured, worker nodes to be ready and cluster to be ready state. It is highly recommended to run the `upgrade` command with the `--no-timeouts` flag to override 1 hour timeout behavior. The `osImageURL` name for the cluster should have a cluster kubernetes version or workerNodeGroupConfiguration.kubernetesVersion version(in case of modular upgrade) in the name. If the kubernetes version is 1.24, the `osImageURL` name should include 1.24, 1_24, 1-24 or 124. {{% /alert %}} ### EKS Anywhere Version Upgrades diff --git a/docs/content/en/docs/clustermgmt/cluster-upgrades/vsphere-and-cloudstack-upgrades.md b/docs/content/en/docs/clustermgmt/cluster-upgrades/vsphere-and-cloudstack-upgrades.md index ec99144664292..69f24f4d8de22 100755 --- a/docs/content/en/docs/clustermgmt/cluster-upgrades/vsphere-and-cloudstack-upgrades.md +++ b/docs/content/en/docs/clustermgmt/cluster-upgrades/vsphere-and-cloudstack-upgrades.md @@ -28,6 +28,7 @@ If you have a management cluster running EKS Anywhere version v0.15, you can suc When triggering a workload cluster upgrade after upgrading the management cluster, please keep in mind that it will not only apply your changes in the workload cluster spec, but also any new improvements included in the new EKS Anywhere controller that was upgraded on the management cluster. The changes in the EKS Anywhere controller can trigger a machine rollout on the workload cluster during upgrade, even if the changes to the workload cluster spec didn't require one (for example, scaling down a worker node group). +To upgrade a cluster to v0.18.x `eksctl anywhere` version, it is madatory to upgrade the cluster first to `eksctl anywhere` version v0.17.x. From v0.18.0 onwards, CLI waits for 1 hour combined for waiting for etcd to be ready, control plane to be ready, default CNI to be configured, worker nodes to be ready and cluster to be ready state. It is highly recommended to run the `upgrade` command with the `--no-timeouts` flag to override 1 hour timeout behavior. The `image`/`template` field that is being used for the cluster should have a cluster kubernetes version or workerNodeGroupConfiguration.kubernetesVersion version(in case of modular upgrade) in the name. If the kubernetes version is 1.24, the `image`/`template` field name should include 1.24, 1_24, 1-24 or 124. {{% /alert %}} ### Prepare DHCP IP addresses pool diff --git a/docs/content/en/docs/getting-started/baremetal/bare-spec.md b/docs/content/en/docs/getting-started/baremetal/bare-spec.md index 444a6a8e5f323..333ea80537c37 100644 --- a/docs/content/en/docs/getting-started/baremetal/bare-spec.md +++ b/docs/content/en/docs/getting-started/baremetal/bare-spec.md @@ -210,6 +210,7 @@ When separate management and workload clusters are supported in Bare Metal, the ### osImageURL Optional field to replace the default Bottlerocket operating system. EKS Anywhere can only auto-import Bottlerocket. In order to use Ubuntu or Redhat see [building baremetal node images]({{< relref "../../osmgmt/artifacts/#build-bare-metal-node-images" >}}) to learn more on building and using Ubuntu with an EKS Anywhere cluster. This field is also useful if you want to provide a customized operating system image or simply host the standard image locally. +The `osImageURL` name for the cluster should have a cluster kubernetes version or workerNodeGroupConfiguration.kubernetesVersion version(in case of modular upgrade) in the name. If the kubernetes version is 1.24, the `osImageURL` name should include 1.24, 1_24, 1-24 or 124. ### hookImagesURLPath Optional field to replace the HookOS image. diff --git a/docs/content/en/docs/getting-started/cloudstack/cloud-spec.md b/docs/content/en/docs/getting-started/cloudstack/cloud-spec.md index b094190dd0034..200c2f91a5fb6 100644 --- a/docs/content/en/docs/getting-started/cloudstack/cloud-spec.md +++ b/docs/content/en/docs/getting-started/cloudstack/cloud-spec.md @@ -340,6 +340,7 @@ The default is generating a key in your `$(pwd)/` folder when not ### template.{id,name} (required) The VM template to use for your EKS Anywhere cluster. Currently, a VM based on RHEL 8.6 is required. This can be a name or ID. +The `template.name` field name must have a cluster kubernetes version or workerNodeGroupConfiguration.kubernetesVersion version(in case of modular upgrade) in the name. If the kubernetes version is 1.24, the `template.name` field name should include 1.24, 1_24, 1-24 or 124. See the [Artifacts]({{< relref "../../osmgmt/artifacts" >}}) page for instructions for building RHEL-based images. ### diskOffering (optional) diff --git a/docs/content/en/docs/getting-started/nutanix/nutanix-spec.md b/docs/content/en/docs/getting-started/nutanix/nutanix-spec.md index 6f70dc6ce059a..523dd5556e6af 100644 --- a/docs/content/en/docs/getting-started/nutanix/nutanix-spec.md +++ b/docs/content/en/docs/getting-started/nutanix/nutanix-spec.md @@ -244,9 +244,11 @@ Type to identify the OS image. (Permitted values: `name` or `uuid`) ### image.name (`name` or `UUID` required) Name of the image +The `image.name` name must have a cluster kubernetes version or workerNodeGroupConfiguration.kubernetesVersion version(in case of modular upgrade) in the name. If the kubernetes version is 1.24, the `image.name` field name should include 1.24, 1_24, 1-24 or 124. ### image.uuid (`name` or `UUID` required) UUID of the image +The image name of the `image.uuid` field must have a cluster kubernetes version or workerNodeGroupConfiguration.kubernetesVersion version(in case of modular upgrade) in the name. If the kubernetes version is 1.24, the image name of the `image.uuid` field name should include 1.24, 1_24, 1-24 or 124. ### memorySize Size of RAM on virtual machines (Default: `4Gi`) diff --git a/docs/content/en/docs/getting-started/vsphere/vsphere-spec.md b/docs/content/en/docs/getting-started/vsphere/vsphere-spec.md index 9e1f4c5c320f0..2f09f3ec528fa 100644 --- a/docs/content/en/docs/getting-started/vsphere/vsphere-spec.md +++ b/docs/content/en/docs/getting-started/vsphere/vsphere-spec.md @@ -301,6 +301,7 @@ The default is generating a key in your `$(pwd)/` folder when not The VM template to use for your EKS Anywhere cluster. This template was created when you [imported the OVA file into vSphere]({{< relref "../vsphere/customize/vsphere-ovas.md" >}}). This is a required field if you are using Ubuntu-based or RHEL-based OVAs. +The `template` name must have a cluster kubernetes version or workerNodeGroupConfiguration.kubernetesVersion version(in case of modular upgrade) in the name. If the kubernetes version is 1.24, the `template` field name should include 1.24, 1_24, 1-24 or 124. ### cloneMode (optional) `cloneMode` defines the clone mode to use when creating the cluster VMs from the template. Allowed values are: