feat(docs): add permission configuration step to external CI guide#311
feat(docs): add permission configuration step to external CI guide#311kaviththiranga wants to merge 1 commit intoopenchoreo:mainfrom
Conversation
Add Step 2 documenting how to configure RBAC permissions for the Jenkins service account via the Backstage Access Control UI, including role creation with workload:create action and role binding setup. Renumber existing steps 2-4 to 3-5 accordingly. Signed-off-by: Kavith Lokuhewage <kaviththiranga@gmail.com>
📝 WalkthroughWalkthroughThis pull request updates the External CI documentation with a reorganized permission configuration guide, including new steps for Backstage Access Control and cluster role setup, alongside a Jenkins pipeline example. Additionally, marketplace plugin star counts are incrementally updated across multiple entries. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/user-guide/ci/external-ci.mdx (1)
49-52:⚠️ Potential issue | 🟠 MajorRemove explicit default credentials from docs.
Publishing real default credentials is a compliance risk. Replace with placeholders and direct readers to configure secrets securely.
Proposed fix
-2. Log in with your admin credentials (default: `admin` / `admin`) +2. Log in with your admin credentials (e.g., `THUNDER_ADMIN_USERNAME` / `THUNDER_ADMIN_PASSWORD`)Based on learnings: Do not document or expose real credentials in docs or sample files; replace with placeholders and explain secure configuration.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/user-guide/ci/external-ci.mdx` around lines 49 - 52, Remove the explicit default credentials "admin / admin" from the step that instructs logging in; replace them with a placeholder (e.g., <ADMIN_USERNAME> / <ADMIN_PASSWORD> or "your-admin-username" / "your-admin-password") and add a short note instructing readers to configure and store those secrets securely (e.g., use secret management or CI credentials store) when creating the Admin account and adding Jenkins credentials; update the line that currently contains the literal credentials to the placeholder text and add one brief sentence about secure storage.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/user-guide/ci/external-ci.mdx`:
- Around line 49-52: Remove the explicit default credentials "admin / admin"
from the step that instructs logging in; replace them with a placeholder (e.g.,
<ADMIN_USERNAME> / <ADMIN_PASSWORD> or "your-admin-username" /
"your-admin-password") and add a short note instructing readers to configure and
store those secrets securely (e.g., use secret management or CI credentials
store) when creating the Admin account and adding Jenkins credentials; update
the line that currently contains the literal credentials to the placeholder text
and add one brief sentence about secure storage.
Add Step 2 documenting how to configure RBAC permissions for the
Jenkins service account via the Backstage Access Control UI, including
role creation with workload:create action and role binding setup.
Renumber existing steps 2-4 to 3-5 accordingly.
Summary by CodeRabbit
Release Notes
Documentation
Chores