docs: add DESCRIBE_CONFIGS to migrator source topic ACLs#1770
Conversation
The Kafka ACL note for data migration listed only READ on source topics, but Redpanda Migrator also issues DescribeConfigs against the source to read each topic's configuration for replication. READ grants DESCRIBE but not DESCRIBE_CONFIGS, so a consumer-only ACL on the source fails topic creation with TOPIC_AUTHORIZATION_FAILED. Add DESCRIBE_CONFIGS (source and target) and an explanatory note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Feediver1
left a comment
There was a problem hiding this comment.
PR Review (final-pass against docs-team-standards)
Files reviewed: 1 .adoc file (3 additions, 1 deletion)
Overall assessment: Tiny, technically-correct accuracy fix authored by the SME. Sound Kafka ACL semantics, clear root-cause explanation. No blocking issues; only two cosmetic consistency nits.
Critical issues (must fix)
None. Content correction with no syntax, xref, or terminology risk. The existing xref:manage:security/authorization/acl.adoc[...] is untouched and resolves. Change is inside the single-source range (tags at lines 5/710), so it correctly lands in cloud-docs too.
Suggestions (should consider)
-
[schema-reg-authorization.adoc:272] Separator inconsistency within the Topics bullet. Source uses a comma (
READ, DESCRIBE_CONFIGS) while target uses slashes (WRITE/CREATE/DESCRIBE/ALTER/DESCRIBE_CONFIGS). For parallelism, consider one separator for both, e.g.READ/DESCRIBE_CONFIGS (source); WRITE/CREATE/DESCRIBE/ALTER/DESCRIBE_CONFIGS (target). -
[schema-reg-authorization.adoc:272-274] Code-formatting inconsistency. The new prose (line 276) and the rest of the page backtick operation names (
`READ`,`DESCRIBE_CONFIGS`), but the three bullets render them as bare uppercase. Optional: backtick the operations in the bullets to match. (Pre-existing style — out of strict scope, but a natural moment to align.)
Impact on other files
- rp-connect-docs#451 (companion, different repo): the source/target ACL set documented there should stay in sync with this note — worth confirming both list
DESCRIBE_CONFIGSidentically. - What's New / nav: No entry or nav change needed — accuracy fix to existing content, not a new page or feature.
- console-v3.adoc: Mentions migrator/ACLs but covers Console role-to-ACL migration (impersonation), not data-migrator Kafka ACLs — no divergence.
What works well
- Technically precise: correctly distinguishes
DESCRIBE(granted byREAD) fromDESCRIBE_CONFIGS, and names the exact failure mode (TOPIC_AUTHORIZATION_FAILED). - Symmetric fix — adds
DESCRIBE_CONFIGSto both source and target, not just the reported source case. - Explanatory note gives operators the why, not just the what.
- Authored by a Kafka-protocol SME; high confidence in accuracy.
🤖 Generated with Claude Code
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated the Schema Registry ACL migration note to refine the Kafka permission matrix. The topic, consumer group, and cluster bullets now list additional topic operations, and the topic section now states that Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
What
Corrects the Kafka ACL note on the Schema Registry Authorization page (currently the only place migrator Kafka ACLs are documented). The note listed only
READon source topics; this addsDESCRIBE_CONFIGS(source and target) and an explanatory note.Why
Redpanda Migrator issues
DescribeConfigsagainst the source to read each topic's configuration for replication.READgrantsDESCRIBEbut notDESCRIBE_CONFIGS, so a consumer-only ACL on the source fails topic creation withTOPIC_AUTHORIZATION_FAILED.Companion to redpanda-data/rp-connect-docs#451, which documents the full source/destination migrator ACL set in the Connect docs.
Preview pages
🤖 Generated with Claude Code