Skip to content

chore(eks): improve documentation for updating a cluster#30259

Merged
mergify[bot] merged 2 commits intomainfrom
colifran/eks-documentation
May 17, 2024
Merged

chore(eks): improve documentation for updating a cluster#30259
mergify[bot] merged 2 commits intomainfrom
colifran/eks-documentation

Conversation

@colifran
Copy link
Copy Markdown
Contributor

Reason for this change

In our EKS documentation, we note that you need to add a temporary policy to the cluster admin role for
successful replacement when renaming a cluster. The temporary policy we recommend adding to the cluster admin role is:

cluster.adminRole.addToPolicy(new iam.PolicyStatement({
  actions: [
    'eks:DeleteCluster',
  ],
  resources: [ 
    Stack.of(this).formatArn({ service: 'eks', resource: 'cluster', resourceName: 'foo' }),
	]
}))

Changing the cluster name is an update that requires replacement. This will cause the old cluster to be automatically deleted by CloudFormation upon success. Since this policy doesn't have the eks:DescribeCluster action, the delete will fail:

image

Description of changes

Added eks:DescribeCluster to the actions of the recommended temporary policy.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Signed-off-by: Francis <colifran@amazon.com>
@github-actions github-actions bot added the p2 label May 17, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team May 17, 2024 16:37
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label May 17, 2024
Copy link
Copy Markdown
Contributor

@piradeepk piradeepk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm 🚀

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented May 17, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 2381a44
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 4549cdf into main May 17, 2024
@mergify mergify bot deleted the colifran/eks-documentation branch May 17, 2024 17:33
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented May 17, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

contribution/core This is a PR that came from AWS. p2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants