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.

Sign up for GitHub

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

Jump to bottom

Allow customization of aws-secret name and keys in Helm Chart #1668

Merged
merged 1 commit into from
Jul 3, 2023
Merged

Allow customization of aws-secret name and keys in Helm Chart #1668

merged 1 commit into from
Jul 3, 2023

Conversation

AndrewSirenko
Copy link
Contributor

@AndrewSirenko AndrewSirenko commented Jul 3, 2023 •
edited
Loading

Is this a bug fix or adding new feature?

Feature

What is this PR about? / Why do we need it?

Closes #1492; supersedes #1571

Currently, users that grant the driver IAM permissions with a secret object are only allowed to use the secret name aws-secret, and key names key_id and access_key due to charts/aws-ebs-csi-driver/templates/controller.yaml not templating those parameters.

This PR would allow users to customize their secret and key names via the helm parameters awsAccessSecret.name, awsAccessSecret.keyId, and awsAccessSecret.accessKey in this PR's values.yaml.

What testing is done?

Granted CSI-driver IAM permissions using a secret object with custom secret, Key ID, and Access Key names. Manually installed CSI-Driver via helm with changed default values, leading to the following CSI Driver controller deployment description (see screenshot).

CSI Driver Controlley Deployment Evidence

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 3, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: AndrewSirenko / name: Drew Sirenko (88f6c17)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 3, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @AndrewSirenko!

It looks like this is your first PR to kubernetes-sigs/aws-ebs-csi-driver 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/aws-ebs-csi-driver has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 3, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @AndrewSirenko. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot requested review from gtxu and torredil July 3, 2023 17:03
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 3, 2023
@torredil
Copy link
Member

torredil commented Jul 3, 2023

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 3, 2023
@hanyuel
Copy link
Contributor

hanyuel commented Jul 3, 2023

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 3, 2023
ConnorJC3
ConnorJC3 requested changes Jul 3, 2023
View reviewed changes
docs/install.md Outdated
@@ -31,7 +31,7 @@ There are several methods to grant the driver IAM permissions:
* Using IAM [instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) - attach the policy to the instance profile IAM role and turn on access to [instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) for the instance(s) on which the driver Deployment will run
* EKS only: Using [IAM roles for ServiceAccounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) - create an IAM role, attach the policy to it, then follow the IRSA documentation to associate the IAM role with the driver Deployment service account, which if you are installing via Helm is determined by value `controller.serviceAccount.name`, `ebs-csi-controller-sa` by default. If you are using k8s 1.24 or higher, the ServiceAccountToken is not mounted because the `LegacyServiceAccountTokenNoAutoGeneration` feature gate is enabled.
Therefore, if you are using k8s 1.24 or higher, you need to set `true` to `controller.serviceAccount.autoMountServiceAccountToken`.
* Using secret object - create an IAM user, attach the policy to it, then create a generic secret called `aws-secret` in the `kube-system` namespace with the user's credentials
* Using secret object - create an IAM user, attach the policy to it, then create a generic secret in the `kube-system` namespace with the user's credentials. The snippet below creates the generic secret named `aws-secret` that the driver accepts by default. You can customize this default name via Helm by setting `Value.awsAccessSecret.name` to a custom secret name. Additionally, you may use an existing secret with an AWS access key by configuring `Value.awsAccessSecret.name` with the name of your existing secret, `Value.awsAccessSecret.keyId` with the key of the AWS_ACCESS_KEY_ID, and `Value.awsAccessSecret.accessKey` with the key of the AWS_SECRET_ACCESS_KEY.
Copy link
Contributor

Choose a reason for hiding this comment

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

configuring Value.awsAccessSecret.name -> configuring the Helm parameter awsAccessSecret.name

Value.awsAccessSecret.keyId -> awsAccessSecret.keyId

Value.awsAccessSecret.accessKey -> awsAccessSecret.accessKey

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 3, 2023
torredil
torredil approved these changes Jul 3, 2023
View reviewed changes
Copy link
Member

@torredil torredil left a comment

Choose a reason for hiding this comment

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

Thanks @AndrewSirenko /lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 3, 2023
ConnorJC3
ConnorJC3 approved these changes Jul 3, 2023
View reviewed changes
Copy link
Contributor

@ConnorJC3 ConnorJC3 left a comment

Choose a reason for hiding this comment

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

lgtm

@torredil
Copy link
Member

torredil commented Jul 3, 2023

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: torredil

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 3, 2023
@k8s-ci-robot k8s-ci-robot merged commit 280ac42 into kubernetes-sigs:master Jul 3, 2023
@ConnorJC3 ConnorJC3 mentioned this pull request Jul 3, 2023
Closed
@AndrewSirenko AndrewSirenko mentioned this pull request Aug 24, 2023
Closed
9 tasks
@AndrewSirenko AndrewSirenko deleted the issue1492 branch November 1, 2023 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ConnorJC3 ConnorJC3 ConnorJC3 approved these changes

@torredil torredil torredil approved these changes

@gtxu gtxu Awaiting requested review from gtxu

Assignees

@ConnorJC3 ConnorJC3

@torredil torredil

@hanyuel hanyuel

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Helm: Allow to set custom secret name & keys
5 participants
@AndrewSirenko @k8s-ci-robot @torredil @hanyuel @ConnorJC3