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

Update install.md to fully cover creating the necessary IAM role and service account #1607

Open
pgasca opened this issue May 17, 2023 · 2 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@pgasca
Copy link

pgasca commented May 17, 2023

/kind bug

What happened?
This procedure points to "Creating the Amazon EBS CSI driver IAM role for service accounts" from the EKS User Guide.. However, that procedure is NOT intended for users who are using the EBS CSI driver as a self-managed addon.

What you expected to happen?
Remove the reference to that procedure and update the install.md file instructions to include details such as creating/annotating the ebs-csi-controller-sa service account.

How to reproduce it (as minimally and precisely as possible)?
https://github.com/kubernetes-sigs/aws-ebs-csi-driver/blob/master/docs/install.md#set-up-driver-permissions

Anything else we need to know?:
The intended scope of the EKS User Guide is to only cover the managed add-on case, so the GitHub repo files need to fully cover how to use the driver as self-managed without referencing the EKS User Guide. This may warrant further changes beyond what I mention.

Environment

  • Kubernetes version (use kubectl version):
  • Driver version:
@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label May 17, 2023
@rdpsin rdpsin added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label May 22, 2023
@AndrewSirenko
Copy link
Contributor

/assign

@torredil
Copy link
Member

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

5 participants