Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CA - AWS - Rework IAM Docs/Snippets #4670

Merged

Conversation

gjtempleton
Copy link
Member

@gjtempleton gjtempleton commented Feb 8, 2022

Which component this PR applies to?

Cluster Autoscaler - AWS cloud provider docs.

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Follows up on a number of PRs we've seen from users in the recent past being confused by the existing IAM docs for using the CA in AWS (e.g. #4586 and #4465) as well as strengthening recommendations that users restrict the IAM roles provided via Resources of Conditionals as suggested by #4403.

Does this in part by explicitly providing two IAM policies rather than one minimal set with recommended additions hidden in a later sentence and making explicit the options blocked off by the use of the more limited policy. It also moves the recommendation to lock down IAM permissions to before the policy snippets rather than after to increase the likelihood of users reading it.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 8, 2022
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 8, 2022
@gjtempleton
Copy link
Member Author

@RafaelMoreira1180778 and @raphael1021 as authors of some of the original PRs, would appreciate your feedback on whether you think this improves the docs.

@trumant Do you think this improves things on the RBAC recommendation front? I've moved the restrictions block higher up to before the snippets and reused some of your reworking of the policies.

Copy link

@raphaelIl raphaelIl left a comment

Choose a reason for hiding this comment

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

It's a readable docs. Thx :)

@gjtempleton
Copy link
Member Author

/assign @jaypipes

@RafaelMoreira1180778
Copy link

Hi, sorry for answering so late, it's a great improvement, I had to change the permissions to those on my CA setup, thanks for changing the docs!

@gjtempleton
Copy link
Member Author

gjtempleton commented Feb 16, 2022

/hold
Need to rework the IAM snippet in the OIDC example as well as here.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 16, 2022
@gjtempleton
Copy link
Member Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 16, 2022
Copy link
Contributor

@jaypipes jaypipes left a comment

Choose a reason for hiding this comment

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

All very good cleanups, @gjtempleton thank you!

@@ -66,17 +68,23 @@ Note: The keys for the tags that you entered don't have values. Cluster Autoscal
"autoscaling:DescribeAutoScalingInstances",
"autoscaling:DescribeLaunchConfigurations",
"autoscaling:DescribeTags",
"ec2:DescribeInstanceTypes",
"ec2:DescribeLaunchTemplateVersions"
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

"autoscaling:SetDesiredCapacity",
"autoscaling:TerminateInstanceInAutoScalingGroup"
],
"Resource": "*"
"Resource": ["*"]
Copy link
Contributor

Choose a reason for hiding this comment

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

nice catch.

@jaypipes
Copy link
Contributor

/lgtm

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gjtempleton, jaypipes, RafaelMoreira1180778, raphael1021, trumant

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 22, 2022
@k8s-ci-robot k8s-ci-robot merged commit a255161 into kubernetes:master Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants