From 000e5a623341dc4b0579622a700117c572a51be2 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 8 Aug 2023 16:24:59 -0400 Subject: [PATCH 1/6] 736 Update info related to EKS instance resource tags --- .../eks-cluster-configuration.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index ae2fe186b52..08a7da4ab84 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -82,9 +82,11 @@ Amazon EKS managed node groups automate the provisioning and lifecycle managemen For more information about how node groups work and how they are configured, refer to the [EKS documentation.](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) -#### Bring your own launch template +#### Existing Launch Templates -A launch template ID and version can be provided in order to easily configure the EC2 instances in a node group. If a launch template is provided, then none of the settings below will be configurable in Rancher. Therefore, using a launch template would require that all the necessary and desired settings from the list below would need to be specified in the launch template. Also note that if a launch template ID and version is provided, then only the template version can be updated. Using a new template ID would require creating a new managed node group. +You can provide your own launch template ID and version to configure the EC2 instances in a node group. If you provide the launch template, none of the template settings will be configurable from Rancher. You must set all of the required options listed below in your launch template. + +Also, if you provide the launch template, you can only update the template version, not the template ID. To use a new template ID, create a new managed node group. | Option | Description | Required/Optional | | ------ | ----------- | ----------------- | @@ -93,7 +95,7 @@ A launch template ID and version can be provided in order to easily configure th | Node Volume Size | The launch template must specify an EBS volume with the desired size | Required | | SSH Key | A key to be added to the instances to provide SSH access to the nodes | Optional | | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | -| Instance Resource Tags | Tag each EC2 instance in the node group | Optional | +| Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | #### Rancher-managed launch templates From aec3b7f391aba96aa72b4de7acccb5979cd3c0c2 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 8 Aug 2023 16:44:32 -0400 Subject: [PATCH 2/6] updated titles --- .../rancher-server-configuration/eks-cluster-configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index 08a7da4ab84..c56264b858f 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -82,7 +82,7 @@ Amazon EKS managed node groups automate the provisioning and lifecycle managemen For more information about how node groups work and how they are configured, refer to the [EKS documentation.](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) -#### Existing Launch Templates +#### User-provided Launch Templates You can provide your own launch template ID and version to configure the EC2 instances in a node group. If you provide the launch template, none of the template settings will be configurable from Rancher. You must set all of the required options listed below in your launch template. @@ -97,7 +97,7 @@ Also, if you provide the launch template, you can only update the template versi | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | | Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | -#### Rancher-managed launch templates +#### Rancher-managed Launch Templates If you do not specify a launch template, then you will be able to configure the above options in the Rancher UI and all of them can be updated after creation. In order to take advantage of all of these options, Rancher will create and manage a launch template for you. Each cluster in Rancher will have one Rancher-managed launch template and each managed node group that does not have a specified launch template will have one version of the managed launch template. The name of this launch template will have the prefix "rancher-managed-lt-" followed by the display name of the cluster. In addition, the Rancher-managed launch template will be tagged with the key "rancher-managed-template" and value "do-not-modify-or-delete" to help identify it as Rancher-managed. It is important that this launch template and its versions not be modified, deleted, or used with any other clusters or managed node groups. Doing so could result in your node groups being "degraded" and needing to be destroyed and recreated. From 9a0087b1a98fd1433c1e1c870479a369a0475b5f Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 11 Aug 2023 11:26:08 -0400 Subject: [PATCH 3/6] versioned docs synced- v2.6, v2.7. v2.5 gets copyedit but uncertain if changes to table apply --- .../eks-cluster-configuration.md | 8 +++++--- .../eks-cluster-configuration.md | 10 ++++++---- .../eks-cluster-configuration.md | 11 ++++++----- 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index a405f293d59..d1820b390f2 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -103,9 +103,11 @@ Amazon EKS managed node groups automate the provisioning and lifecycle managemen For more information about how node groups work and how they are configured, refer to the [EKS documentation.](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) -#### Bring your own launch template +#### User-provided Launch Templates -A launch template ID and version can be provided in order to easily configure the EC2 instances in a node group. If a launch template is provided, then none of the settings below will be configurable in Rancher. Therefore, using a launch template would require that all the necessary and desired settings from the list below would need to be specified in the launch template. Also note that if a launch template ID and version is provided, then only the template version can be updated. Using a new template ID would require creating a new managed node group. +You can provide your own launch template ID and version to configure the EC2 instances in a node group. If you provide the launch template, none of the template settings will be configurable from Rancher. You must set all of the required options listed below in your launch template. + +Also, if you provide the launch template, you can only update the template version, not the template ID. To use a new template ID, create a new managed node group. | Option | Description | Required/Optional | | ------ | ----------- | ----------------- | @@ -116,7 +118,7 @@ A launch template ID and version can be provided in order to easily configure th | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | | Instance Resource Tags | Tag each EC2 instance in the node group | Optional | -#### Rancher-managed launch templates +#### Rancher-managed Launch Templates If you do not specify a launch template, then you will be able to configure the above options in the Rancher UI and all of them can be updated after creation. In order to take advantage of all of these options, Rancher will create and manage a launch template for you. Each cluster in Rancher will have one Rancher-managed launch template and each managed node group that does not have a specified launch template will have one version of the managed launch template. The name of this launch template will have the prefix "rancher-managed-lt-" followed by the display name of the cluster. In addition, the Rancher-managed launch template will be tagged with the key "rancher-managed-template" and value "do-not-modify-or-delete" to help identify it as Rancher-managed. It is important that this launch template and its versions not be modified, deleted, or used with any other clusters or managed node groups. Doing so could result in your node groups being "degraded" and needing to be destroyed and recreated. diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index ae2fe186b52..c56264b858f 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -82,9 +82,11 @@ Amazon EKS managed node groups automate the provisioning and lifecycle managemen For more information about how node groups work and how they are configured, refer to the [EKS documentation.](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) -#### Bring your own launch template +#### User-provided Launch Templates -A launch template ID and version can be provided in order to easily configure the EC2 instances in a node group. If a launch template is provided, then none of the settings below will be configurable in Rancher. Therefore, using a launch template would require that all the necessary and desired settings from the list below would need to be specified in the launch template. Also note that if a launch template ID and version is provided, then only the template version can be updated. Using a new template ID would require creating a new managed node group. +You can provide your own launch template ID and version to configure the EC2 instances in a node group. If you provide the launch template, none of the template settings will be configurable from Rancher. You must set all of the required options listed below in your launch template. + +Also, if you provide the launch template, you can only update the template version, not the template ID. To use a new template ID, create a new managed node group. | Option | Description | Required/Optional | | ------ | ----------- | ----------------- | @@ -93,9 +95,9 @@ A launch template ID and version can be provided in order to easily configure th | Node Volume Size | The launch template must specify an EBS volume with the desired size | Required | | SSH Key | A key to be added to the instances to provide SSH access to the nodes | Optional | | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | -| Instance Resource Tags | Tag each EC2 instance in the node group | Optional | +| Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | -#### Rancher-managed launch templates +#### Rancher-managed Launch Templates If you do not specify a launch template, then you will be able to configure the above options in the Rancher UI and all of them can be updated after creation. In order to take advantage of all of these options, Rancher will create and manage a launch template for you. Each cluster in Rancher will have one Rancher-managed launch template and each managed node group that does not have a specified launch template will have one version of the managed launch template. The name of this launch template will have the prefix "rancher-managed-lt-" followed by the display name of the cluster. In addition, the Rancher-managed launch template will be tagged with the key "rancher-managed-template" and value "do-not-modify-or-delete" to help identify it as Rancher-managed. It is important that this launch template and its versions not be modified, deleted, or used with any other clusters or managed node groups. Doing so could result in your node groups being "degraded" and needing to be destroyed and recreated. diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index ae2fe186b52..3d0813ef7ec 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -82,9 +82,11 @@ Amazon EKS managed node groups automate the provisioning and lifecycle managemen For more information about how node groups work and how they are configured, refer to the [EKS documentation.](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) -#### Bring your own launch template +#### User-provided Launch Templates -A launch template ID and version can be provided in order to easily configure the EC2 instances in a node group. If a launch template is provided, then none of the settings below will be configurable in Rancher. Therefore, using a launch template would require that all the necessary and desired settings from the list below would need to be specified in the launch template. Also note that if a launch template ID and version is provided, then only the template version can be updated. Using a new template ID would require creating a new managed node group. +You can provide your own launch template ID and version to configure the EC2 instances in a node group. If you provide the launch template, none of the template settings will be configurable from Rancher. You must set all of the required options listed below in your launch template. + +Also, if you provide the launch template, you can only update the template version, not the template ID. To use a new template ID, create a new managed node group. | Option | Description | Required/Optional | | ------ | ----------- | ----------------- | @@ -93,9 +95,9 @@ A launch template ID and version can be provided in order to easily configure th | Node Volume Size | The launch template must specify an EBS volume with the desired size | Required | | SSH Key | A key to be added to the instances to provide SSH access to the nodes | Optional | | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | -| Instance Resource Tags | Tag each EC2 instance in the node group | Optional | +| Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | -#### Rancher-managed launch templates +#### Rancher-managed Launch Templates If you do not specify a launch template, then you will be able to configure the above options in the Rancher UI and all of them can be updated after creation. In order to take advantage of all of these options, Rancher will create and manage a launch template for you. Each cluster in Rancher will have one Rancher-managed launch template and each managed node group that does not have a specified launch template will have one version of the managed launch template. The name of this launch template will have the prefix "rancher-managed-lt-" followed by the display name of the cluster. In addition, the Rancher-managed launch template will be tagged with the key "rancher-managed-template" and value "do-not-modify-or-delete" to help identify it as Rancher-managed. It is important that this launch template and its versions not be modified, deleted, or used with any other clusters or managed node groups. Doing so could result in your node groups being "degraded" and needing to be destroyed and recreated. @@ -146,4 +148,3 @@ The syncing interval can be changed by running `kubectl edit setting eks-refresh If the `eks-refresh-cron` setting was previously set, the migration will happen automatically. The shorter the refresh window, the less likely any race conditions will occur, but it does increase the likelihood of encountering request limits that may be in place for AWS APIs. - From 184756baeabfc08dc9c56c4f5e82a2875c8fdd9e Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 11 Aug 2023 12:03:33 -0400 Subject: [PATCH 4/6] reverted table update for v2.6 as change is only present in v2.7. Kept copyedit --- .../rancher-server-configuration/eks-cluster-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index c56264b858f..209441189ce 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -95,7 +95,7 @@ Also, if you provide the launch template, you can only update the template versi | Node Volume Size | The launch template must specify an EBS volume with the desired size | Required | | SSH Key | A key to be added to the instances to provide SSH access to the nodes | Optional | | User Data | Cloud init script in [MIME multi-part format](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html#launch-template-user-data) | Optional | -| Instance Resource Tags | Tag each EC2 instance and its volumes in the node group | Optional | +| Instance Resource Tags | Tag each EC2 instance in the node group | Optional | #### Rancher-managed Launch Templates From 1ff00131051d5ad3b70015c07288950746a12ec7 Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 11 Aug 2023 12:12:40 -0400 Subject: [PATCH 5/6] adding canonical links for good measure --- .../rancher-server-configuration/eks-cluster-configuration.md | 4 ++++ .../rancher-server-configuration/eks-cluster-configuration.md | 4 ++++ .../rancher-server-configuration/eks-cluster-configuration.md | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index d1820b390f2..8efef1b6cde 100644 --- a/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.5/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -2,6 +2,10 @@ title: EKS Cluster Configuration Reference --- + + + + diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index 209441189ce..91e2cfb1e50 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -2,6 +2,10 @@ title: EKS Cluster Configuration Reference --- + + + + ### Account Access Complete each drop-down and field using the information obtained for your IAM policy. diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index 3d0813ef7ec..9df79bc6dfb 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -2,6 +2,10 @@ title: EKS Cluster Configuration Reference --- + + + + ### Account Access Complete each drop-down and field using the information obtained for your IAM policy. From df77c2fe32a7b335a7a59f42bdf1183297dfc346 Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 11 Aug 2023 12:15:16 -0400 Subject: [PATCH 6/6] and one more canonical for the /docs page --- .../rancher-server-configuration/eks-cluster-configuration.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md index c56264b858f..1d43c3acea3 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/eks-cluster-configuration.md @@ -2,6 +2,10 @@ title: EKS Cluster Configuration Reference --- + + + + ### Account Access Complete each drop-down and field using the information obtained for your IAM policy.