AWS eks documentation change
Summary
Restructured documentation with new section headers (Cluster insight types, Considerations, Use cases, Get started). Moved permissions/frequency details to 'Considerations' section. Added explicit subsection for upgrade insights workflow and temporary feature rollback notice.
Security assessment
The changes primarily reorganize existing content rather than address new security issues. While the documentation mentions permissions (security-adjacent) and a temporary rollback of upgrade enforcement (originally a safeguard), these are existing security controls being relocated rather than new vulnerabilities or mitigations. No concrete evidence of addressing a specific security vulnerability in the diff.
Diff
diff --git a/eks/latest/userguide/cluster-insights.md b/eks/latest/userguide/cluster-insights.md index 317aaa31b..d143f47bb 100644 --- a//eks/latest/userguide/cluster-insights.md +++ b//eks/latest/userguide/cluster-insights.md @@ -5 +5 @@ -Prepare for Kubernetes version upgrades with cluster insightsTroubleshoot misconfiguration with cluster insights +Cluster insight typesConsiderationsUse casesGet started @@ -15 +15 @@ Amazon EKS cluster insights provide detection of issues and recommendations to r -Amazon EKS provides two types of insights: **Configuration insights** and **Upgrade insights**. **Configuration insights** identify misconfigurations in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. **Upgrade insights** identify issues that could impact your ability to upgrade to new versions of Kubernetes. +## Cluster insight types @@ -17 +17 @@ Amazon EKS provides two types of insights: **Configuration insights** and **Upgr -To see the list of insight checks performed and any relevant issues that Amazon EKS has identified, you can call the look in the AWS Management Console, the AWS CLI, AWS SDKs, and Amazon EKS `ListInsights` API operation. For steps, see [View cluster insights](./view-cluster-insights.html). + * **Configuration insights** : Identifies misconfigurations in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. @@ -19 +19 @@ To see the list of insight checks performed and any relevant issues that Amazon -**Frequency** Amazon EKS refreshes cluster insights every 24 hours. You cannot manually refresh cluster insights. If you fix a cluster issue, it will take some time for cluster insights to update. To determine if a fix was successful, compare the time that the change deployed to the "last refresh time" of the insight check. + * **Upgrade insights** : Identifies issues that could impact your ability to upgrade to new versions of Kubernetes. @@ -21 +20,0 @@ To see the list of insight checks performed and any relevant issues that Amazon -**Permissions** Amazon EKS automatically creates a cluster access entry for cluster insights in every EKS cluster. This entry gives EKS permission to view information about your cluster. EKS uses this information to generate the insights. For more information, see [AmazonEKSClusterInsightsPolicy](./access-policy-permissions.html#access-policy-permissions-AmazonEKSClusterInsightsPolicy). @@ -23 +21,0 @@ To see the list of insight checks performed and any relevant issues that Amazon -## Prepare for Kubernetes version upgrades with cluster insights @@ -25 +22,0 @@ To see the list of insight checks performed and any relevant issues that Amazon -###### Important @@ -27 +24 @@ To see the list of insight checks performed and any relevant issues that Amazon -Amazon EKS has temporarily rolled back a feature that would require you to use a `--force` flag to upgrade your cluster when there were certain cluster insight issues. For more information, see [Temporary rollback of enforcing upgrade insights on update cluster version](https://github.com/aws/containers-roadmap/issues/2570) on GitHub. +## Considerations @@ -29 +26,3 @@ Amazon EKS has temporarily rolled back a feature that would require you to use a -For more information about updating your cluster, see [Step 3: Update cluster control plane](./update-cluster.html#update-cluster-control-plane). + * **Frequency** : Amazon EKS refreshes cluster insights every 24 hours. You cannot manually refresh cluster insights. If you fix a cluster issue, it will take some time for cluster insights to update. To determine if a fix was successful, compare the time that the change deployed to the "last refresh time" of the insight check. + + * **Permissions** : Amazon EKS automatically creates a cluster access entry for cluster insights in every EKS cluster. This entry gives EKS permission to view information about your cluster. EKS uses this information to generate the insights. For more information, see [AmazonEKSClusterInsightsPolicy](./access-policy-permissions.html#access-policy-permissions-AmazonEKSClusterInsightsPolicy). @@ -31 +29,0 @@ For more information about updating your cluster, see [Step 3: Update cluster co -_Upgrade insights_ are a specific type of insight checks within cluster insights. These checks returns insights related to Kubernetes version upgrade readiness. Amazon EKS runs upgrade insight checks on every EKS cluster. @@ -33 +30,0 @@ _Upgrade insights_ are a specific type of insight checks within cluster insights - * Before updating your cluster Kubernetes version, check the **Cluster insights** tab of the observability dashboard in the [Amazon EKS console](https://console.aws.amazon.com/eks/home#/clusters). @@ -35 +31,0 @@ _Upgrade insights_ are a specific type of insight checks within cluster insights - * If your cluster has identified issues, review them and make appropriate fixes. The issues include links to Amazon EKS and Kubernetes documentation. @@ -37 +33 @@ _Upgrade insights_ are a specific type of insight checks within cluster insights - * After fixing issues, wait for the cluster insights to refresh. If all issues have been resolved, [update your cluster](./update-cluster.html). +## Use cases @@ -38,0 +35 @@ _Upgrade insights_ are a specific type of insight checks within cluster insights +Cluster insights in Amazon EKS provide automated checks to help maintain the health, reliability, and optimal configuration of your Kubernetes clusters. Below are key use cases for cluster insights, including upgrade readiness and configuration troubleshooting. @@ -39,0 +37 @@ _Upgrade insights_ are a specific type of insight checks within cluster insights +### Upgrade insights @@ -40,0 +39,9 @@ _Upgrade insights_ are a specific type of insight checks within cluster insights +Upgrade insights are a specific type of insight checks within cluster insights. These checks returns insights related to Kubernetes version upgrade readiness. Amazon EKS runs upgrade insight checks on every EKS cluster. + +###### Important + +Amazon EKS has temporarily rolled back a feature that would require you to use a `--force` flag to upgrade your cluster when there were certain cluster insight issues. For more information, see [Temporary rollback of enforcing upgrade insights on update cluster version](https://github.com/aws/containers-roadmap/issues/2570) on GitHub. + +For more information about updating your cluster, see [Step 3: Update cluster control plane](./update-cluster.html#update-cluster-control-plane). + +Before updating your cluster Kubernetes version, you can use the **Cluster insights** tab of the observability dashboard in the [Amazon EKS console](https://console.aws.amazon.com/eks/home#/clusters). If your cluster has identified issues, review them and make appropriate fixes. The issues include links to Amazon EKS and Kubernetes documentation. After fixing the issue, wait for the cluster insights to refresh. If all issues have been resolved, [update your cluster](./update-cluster.html). @@ -46 +53 @@ Amazon EKS upgrade insights speed up the testing and verification process for ne -## Troubleshoot misconfiguration with cluster insights +### Configuration insights @@ -49,0 +57,4 @@ EKS cluster insights automatically scans Amazon EKS clusters with hybrid nodes t +## Get started + +To see the list of insight checks performed and any relevant issues that Amazon EKS has identified, you can use the AWS Management Console, the AWS CLI, AWS SDKs, and Amazon EKS `ListInsights` API operation. To get started, see [View cluster insights](./view-cluster-insights.html). +