Skip to content

Commit

Permalink
update docs about changes that went in for kindless upgrade task
Browse files Browse the repository at this point in the history
  • Loading branch information
panktishah26 committed Oct 27, 2023
1 parent 76d57f2 commit de7e238
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ The default is generating a key in your `$(pwd)/<cluster-name>` 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)
Expand Down
2 changes: 2 additions & 0 deletions docs/content/en/docs/getting-started/nutanix/nutanix-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ The default is generating a key in your `$(pwd)/<cluster-name>` 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:
Expand Down

0 comments on commit de7e238

Please sign in to comment.