fix(helm): Ensure non-default service account name works with namespaces-cache and configmaps-cache role bindings

[gunzy83]

Issue #, if available: N/A

Relates to aws-controllers-k8s/kms-controller#83

Description of changes: This change ensures that the required ClusterRoleBinding and RoleBinding objects apply to a ServiceAccount with a custom name.

Error seen with custom service account name:

pkg/mod/k8s.io/[email protected]/tools/cache/reflector.go:232: Failed to watch *v1.ConfigMap: failed to list *v1.ConfigMap: configmaps is forbidden: User "system:serviceaccount:kms-controller:kms-controller" cannot list resource "configmaps" in API group "" in the namespace "kms-controller"

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

[ack-prow]

Hi @gunzy83. Thanks for your PR.

I'm waiting for a aws-controllers-k8s 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.

[a-hilaly]

Thank you @gunzy83!!
/approve
/assign @michaelhtm

[a-hilaly]

/ok-to-test

[ack-prow]

@gunzy83: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
verify-attribution	141a7cd	link	false	/test verify-attribution

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

[a-hilaly]

/hold

[a-hilaly]

@mtougeron @eadasiak any thoughts on this change? i'm wondering how did this work with all the CARM installations we've done before?

[mtougeron]

@mtougeron @eadasiak any thoughts on this change? i'm wondering how did this work with all the CARM installations we've done before?

I'm not sure about the code that generates these templates, but I'm assuming it's probably that whatever populates name: {{ .ServiceAccountName }} here https://github.com/aws-controllers-k8s/code-generator/blob/main/templates/helm/values.yaml.tpl#L141 sets it essentially to the same value by default. So it you didn't change from the ServiceAccount name the chart uses by default it would work fine. But if you did try to change it, it wouldn't work properly.

For example, the rendered Deployment manifest uses serviceAccountName: {{ IncludeTemplate "service-account.name" }} so if someone sets

serviceAccount:
  name: foo

in their values.yaml (or via --set serviceAccount.name=foo) that field would be properly updated. But the ClusterRoleBinding & RoleBinding would still have ack-ec2-controller

[gunzy83]

@mtougeron @eadasiak any thoughts on this change? i'm wondering how did this work with all the CARM installations we've done before?

I'm not sure about the code that generates these templates, but I'm assuming it's probably that whatever populates name: {{ .ServiceAccountName }} here https://github.com/aws-controllers-k8s/code-generator/blob/main/templates/helm/values.yaml.tpl#L141 sets it essentially to the same value by default. So it you didn't change from the ServiceAccount name the chart uses by default it would work fine. But if you did try to change it, it wouldn't work properly.

For example, the rendered Deployment manifest uses serviceAccountName: {{ IncludeTemplate "service-account.name" }} so if someone sets

serviceAccount:
  name: foo

in their values.yaml (or via --set serviceAccount.name=foo) that field would be properly updated. But the ClusterRoleBinding & RoleBinding would still have ack-ec2-controller

I think this is only a problem when installScope is namespace. When installScope is cluster the cluster role provides enough permissions and the binding for that is updated with a custom service account name. Perhaps the subset of users who both run with installScope=namespace and a custom service account name is small.

[a-hilaly]

Thank you @gunzy83 and @mtougeron !! Yeah looks like there is an edge case where there is a namespace mismatch between the service account name and the binding. I just tested this patch with new controllers and it's indeed generating the expected namespace value.

[a-hilaly]

/unhold

[michaelhtm]

👍
/lgtm

[ack-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: a-hilaly, gunzy83, michaelhtm

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:

• OWNERS [a-hilaly]

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

[gunzy83]

Thanks everyone! 🎉