-
Notifications
You must be signed in to change notification settings - Fork 47
DOC-1772: Fix invalid ACL command example in RBAC documentation #1420
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
📝 WalkthroughWalkthroughThis PR corrects an invalid ACL create command example in the RBAC documentation. The topic patterns in the example are updated from Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/manage/partials/rbac-dp.adoc (1)
189-189: Update best practice example to reflect corrected pattern format.The best practice statement references
analytics-*as a prefixed pattern, but the corrected command examples now useanalytics-(without wildcard) when paired with--resource-pattern-type prefixed. Clarify the guidance to reflect that the prefix itself (e.g.,analytics-) is sufficient and the wildcard is redundant with theprefixedflag.Apply this diff to align the best practice with the corrected examples:
-* Use wildcards carefully: Prefixed patterns like `analytics-*` are useful but review regularly +* Use wildcards carefully: Prefixed patterns (e.g., `analytics-` with `--resource-pattern-type prefixed`) match topics by prefix and should be reviewed regularly
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/manage/partials/rbac-dp.adoc(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-25T21:00:26.626Z
Learnt from: micheleRP
PR: redpanda-data/docs#1334
File: modules/manage/partials/rbac-dp.adoc:93-98
Timestamp: 2025-08-25T21:00:26.626Z
Learning: In cloud documentation (env-cloud), Security is at the top level navigation, so ACL references should use `security:authorization/rbac/acl.adoc`. In self-managed documentation, Security is nested under Manage, so ACL references use `manage:security/authorization/acl.adoc`. The different xref paths in conditional blocks reflect these different navigation structures.
Applied to files:
modules/manage/partials/rbac-dp.adoc
🔇 Additional comments (2)
modules/manage/partials/rbac-dp.adoc (2)
37-44: Corrected ACL commands now conform to Kafka topic naming validation.Removing the wildcard suffix (
*) from the topic patterns aligns with the semantics of--resource-pattern-type prefixed, which already implies prefix matching. The corrected patterns (analytics-andreports-) are now valid and will execute without validation errors.
158-158: Verify consistency of resource pattern type usage in rpk acl examples.The corrected examples at lines 37–43 use explicit
--resource-pattern-type prefixedflags with prefix patterns ('analytics-','reports-'), while the self-managed example at line 158 uses a wildcard pattern (private-*) without this flag. Additionally, the narrative text at line 189 referencesanalytics-*with an asterisk, but the actual command uses'analytics-'without one.Clarify whether:
- The wildcard syntax
private-*at line 158 works without--resource-pattern-type, or if it should also include the flag for consistency- The distinction between prefix patterns (
'topic-') and wildcard patterns (topic-*) has different requirements
4a1ff83 to
ebc419f
Compare
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1772
Review deadline: Tuesday, October 28th, 2025
Page previews
https://deploy-preview-1420--redpanda-docs-preview.netlify.app/current/manage/security/authorization/rbac/#manage-roles
Checks