docs(uxp): add worked ClusterRole example for AddOn RBAC#1225
Open
kaessert wants to merge 1 commit into
Open
Conversation
The AddOn RBAC section explained that the upbound-controller-manager ServiceAccount needs permissions but only showed a ClusterRoleBinding skeleton, leaving the actual rules to the reader. Users hit install-time failures (e.g. forbidden on policy/poddisruptionbudgets) with no guidance on how to determine the required resources. Add a concrete cert-manager ClusterRole + binding covering the object kinds the chart creates (PodDisruptionBudget, webhooks, RBAC included), a tip on rendering the chart to enumerate resources, and a note on RBAC escalation prevention when an AddOn chart ships its own roles.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Improves the Create a ClusterRole or Role for your AddOn section of the UXP AddOns docs (
manuals/uxp/concepts/packages/add-ons).Why
The section told users they must grant the
upbound-controller-managerServiceAccount permissions, but only showed aClusterRoleBindingskeleton with a<your_addon_role>placeholder — no actual rules, and no guidance on how to figure out which resources an AddOn needs. In practice users hit install-time failures on the package's runtime health condition, e.g.:...with nothing in the docs explaining the fix. This came up with a self-hosted customer installing cert-manager as an AddOn.
Changes
ClusterRole+ClusterRoleBindingcovering the object kinds the chart creates (includingPodDisruptionBudget, webhook configurations, and RBAC objects that a manifest-only permission set commonly misses).helm template ... | grep kind) to enumerate the resources an AddOn manages, and what a missing permission looks like at install time.escalate/bind).No changes to existing structure beyond the RBAC subsection.