Document pods/exec RBAC requirement for SDK support bundle collectors#4090
Merged
Conversation
…ctors The SDK's built-in support bundle spec uses exec collectors to call internal API endpoints, but the pods/exec RBAC requirement was not documented. Without it, app-info.json and license.yaml are silently missing from bundles. This adds an RBAC requirements section to the customizing page and a troubleshooting entry to the generating page. sc-136407 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| verbs: ["create"] | ||
| ``` | ||
|
|
||
| Without this permission, the `exec` collectors fail silently. The support bundle is still generated and can be uploaded to the Vendor Portal, but `app-info.json` and `license.yaml` will be missing. The Vendor Portal displays warnings such as "No app-info file found" and "No license file found" when these files are absent. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('be uploaded').
|
|
||
| #### Cause | ||
|
|
||
| The Replicated SDK's built-in support bundle spec uses `exec` collectors to retrieve application and license information from the SDK pod. If the service account running the support bundle does not have `pods/exec` permissions with the `create` verb, these collectors fail silently and the data is not included in the bundle. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
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
2 participants
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.
Summary
execcollectors requiringpods/execwithcreateverbCloses sc-136407
Context
The SDK's default support bundle spec calls internal API endpoints (
/api/v1/app/info,/api/v1/license/info) via exec collectors. Whenpods/execRBAC is missing, these collectors fail silently and the bundle uploads withoutapp-info.jsonorlicense.yaml. The only indication is VP warnings after upload.Test plan
#exec-rbacanchor link from the generating page resolves correctly🤖 Generated with Claude Code