Skip to content

fix: ServiceAccount name in custom RBAC documentation#1935

Merged
Skarlso merged 3 commits into
open-component-model:mainfrom
reshnm:patch-1
Mar 10, 2026
Merged

fix: ServiceAccount name in custom RBAC documentation#1935
Skarlso merged 3 commits into
open-component-model:mainfrom
reshnm:patch-1

Conversation

@reshnm

@reshnm reshnm commented Mar 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

When following the documentation for deployment (https://github.com/open-component-model/open-component-model/blob/main/kubernetes/controller/docs/getting-started/setup.md#install-the-ocm-k8s-toolkit), the service account name of the ocm kubernetes toolkit is ocm-k8s-toolkit-controller-manager, not ocm-k8s-toolkit-chart-controller-manager

Which issue(s) this PR fixes

Testing

How to test the changes
helm install ocm-k8s-toolkit oci://ghcr.io/open-component-model/kubernetes/controller/chart:0.0.0-5b3f034 \
  --namespace ocm-k8s-toolkit-system \
  --create-namespace

Create the ClusterRole and the ClusterRoleBinding as described in the documentation and a Deployer that creates a ResourceGraphDefinition. This will result in an error that the deployer is allowed to patch ResourceGraphDefinitions.

Verification
  • I have tested the changes locally by running ocm

Summary by CodeRabbit

  • Documentation
    • Updated Kubernetes RBAC configuration documentation with corrected ServiceAccount references for controller bindings.

@reshnm
fix: ServiceAccount name in custom RBAC documentation
138c889 
The service account name of the ocm kubernetes toolkit is `ocm-k8s-toolkit-controller-manager`, not `ocm-k8s-toolkit-chart-controller-manager`

Signed-off-by: René Schünemann <rene.schuenemann@sap.com>
@reshnm reshnm requested a review from a team as a code owner March 9, 2026 16:56
@github-actions github-actions Bot added kind/bugfix Bug size/xs Extra small labels Mar 9, 2026
@coderabbitai

coderabbitai Bot commented Mar 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Updated a ServiceAccount name in a ClusterRoleBinding within RBAC documentation from ocm-k8s-toolkit-chart-controller-manager to ocm-k8s-toolkit-controller-manager to align the binding with the renamed controller service account.

Changes

Cohort / File(s) Summary
RBAC Documentation
kubernetes/controller/docs/getting-started/custom-rbac.md		 Updated ClusterRoleBinding subject ServiceAccount name to match the renamed controller service account.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A name change hops through the RBAC,
From "chart" to plain "controller" we track,
ServiceAccount aligned with care,
The binding now matches everywhere! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: ServiceAccount name in custom RBAC documentation' directly describes the main change: correcting the ServiceAccount name in documentation from ocm-k8s-toolkit-chart-controller-manager to ocm-k8s-toolkit-controller-manager.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Skarlso
Skarlso reviewed Mar 9, 2026
View reviewed changes
Comment thread kubernetes/controller/docs/getting-started/custom-rbac.md
@Skarlso Skarlso enabled auto-merge (squash) March 10, 2026 06:36
@Skarlso Skarlso merged commit 22af610 into open-component-model:main Mar 10, 2026
20 checks passed
frewilhelm pushed a commit to frewilhelm/open-component-model that referenced this pull request Mar 12, 2026
@reshnm @Skarlso @frewilhelm
fix: ServiceAccount name in custom RBAC documentation (open-component…
23dd137 
…-model#1935)

Co-authored-by: Gergely Bräutigam <gergely.brautigam@sap.com>
morri-son pushed a commit to morri-son/open-component-model that referenced this pull request Mar 18, 2026
@reshnm @Skarlso @morrison-sap
fix: ServiceAccount name in custom RBAC documentation (open-component…
1d282f1 
…-model#1935)

Co-authored-by: Gergely Bräutigam <gergely.brautigam@sap.com>
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Skarlso Skarlso Skarlso approved these changes

@frewilhelm frewilhelm frewilhelm approved these changes

Assignees

No one assigned

Labels

kind/bugfix Bug size/xs Extra small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@reshnm @Skarlso @frewilhelm @jakobmoellerdev