DOC-1936: Note SR authorization is on by default for Redpanda Cloud#1694
DOC-1936: Note SR authorization is on by default for Redpanda Cloud#1694
Conversation
Schema Registry Authorization is now enabled fleet-wide on Redpanda Cloud BYOC and Dedicated clusters: schema_registry_enable_authorization is set automatically at provisioning, and predefined Cloud roles include Schema Registry permissions. - Add a Cloud-only intro NOTE explaining the default behavior and pointing to the predefined roles - Split the Prerequisites/Enable section so the Cloud branch shows only the ACL management prerequisites, while self-managed users continue to see the full enable-authorization flow - Fix a broken xref in the Cloud branch (security:/authorization/acl -> security:authorization/acl) and remove a stale "After enabling..." preamble in the Cloud Console step Co-Authored-By: Claude Opus 4.7 (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. |
📝 WalkthroughWalkthroughThis pull request reorganizes the Schema Registry Authorization documentation to clarify cloud versus self-hosted deployment paths. It adds a cloud-only note explaining automatic authorization enablement on BYOC and Dedicated clusters, introduces a new section for managing Schema Registry ACLs in cloud environments, refactors prerequisites to conditionally apply based on deployment type, and updates documentation links to point to environment-appropriate resources. Possibly related PRs
Suggested reviewers
🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@modules/manage/pages/schema-reg/schema-reg-authorization.adoc`:
- Line 421: Replace the hard-coded xref text in the link string
"xref:manage:rpk/rpk-install.adoc[rpk installation]" with empty brackets so the
target document title is pulled automatically — change the occurrence of
xref:manage:rpk/rpk-install.adoc[rpk installation] to
xref:manage:rpk/rpk-install.adoc[] in the schema-reg-authorization content.
- Line 439: Replace the explicit link text in the xref call so the document
title is pulled automatically: change the xref token
xref:get-started:rpk-install.adoc[rpk installation] to use empty brackets
(xref:get-started:rpk-install.adoc[]) in the sentence that currently reads "*
`rpk` v25.2+ installed. For installation instructions, see
xref:get-started:rpk-install.adoc[rpk installation]." so the published link uses
the target document's title instead of hard-coded text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e9b8a8bb-b9e5-4386-9f51-5fff74c2970e
📒 Files selected for processing (1)
modules/manage/pages/schema-reg/schema-reg-authorization.adoc
| Before you can create or manage Schema Registry ACLs, you must have: | ||
|
|
||
| ifdef::env-cloud[] | ||
| * `rpk` v25.2+ installed. For installation instructions, see xref:manage:rpk/rpk-install.adoc[rpk installation]. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
Use empty brackets in xref to auto-pull the document title.
The xref link uses explicit text [rpk installation] but should use empty brackets to automatically pull the title from the target document.
📝 Suggested fix
-* `rpk` v25.2+ installed. For installation instructions, see xref:manage:rpk/rpk-install.adoc[rpk installation].
+* `rpk` v25.2+ installed. For installation instructions, see xref:manage:rpk/rpk-install.adoc[].Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically. Avoid hard-coding link text; use xref:...[] to let the target document's title render as the link text when publishing."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * `rpk` v25.2+ installed. For installation instructions, see xref:manage:rpk/rpk-install.adoc[rpk installation]. | |
| * `rpk` v25.2+ installed. For installation instructions, see xref:manage:rpk/rpk-install.adoc[]. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/manage/pages/schema-reg/schema-reg-authorization.adoc` at line 421,
Replace the hard-coded xref text in the link string
"xref:manage:rpk/rpk-install.adoc[rpk installation]" with empty brackets so the
target document title is pulled automatically — change the occurrence of
xref:manage:rpk/rpk-install.adoc[rpk installation] to
xref:manage:rpk/rpk-install.adoc[] in the schema-reg-authorization content.
| Before you can enable Schema Registry Authorization, you must have: | ||
|
|
||
| * A valid Redpanda Enterprise license. | ||
| * `rpk` v25.2+ installed. For installation instructions, see xref:get-started:rpk-install.adoc[rpk installation]. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
Use empty brackets in xref to auto-pull the document title.
The xref link uses explicit text [rpk installation] but should use empty brackets to automatically pull the title from the target document.
📝 Suggested fix
-* `rpk` v25.2+ installed. For installation instructions, see xref:get-started:rpk-install.adoc[rpk installation].
+* `rpk` v25.2+ installed. For installation instructions, see xref:get-started:rpk-install.adoc[].Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically. Avoid hard-coding link text; use xref:...[] to let the target document's title render as the link text when publishing."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * `rpk` v25.2+ installed. For installation instructions, see xref:get-started:rpk-install.adoc[rpk installation]. | |
| * `rpk` v25.2+ installed. For installation instructions, see xref:get-started:rpk-install.adoc[]. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/manage/pages/schema-reg/schema-reg-authorization.adoc` at line 439,
Replace the explicit link text in the xref call so the document title is pulled
automatically: change the xref token xref:get-started:rpk-install.adoc[rpk
installation] to use empty brackets (xref:get-started:rpk-install.adoc[]) in the
sentence that currently reads "* `rpk` v25.2+ installed. For installation
instructions, see xref:get-started:rpk-install.adoc[rpk installation]." so the
published link uses the target document's title instead of hard-coded text.
1 participant
Summary
Schema Registry Authorization is now enabled fleet-wide on Redpanda Cloud BYOC and Dedicated clusters:
schema_registry_enable_authorizationis set automatically at provisioning, and predefined Cloud roles include Schema Registry permissions.This PR updates the single-sourced
schema-reg-authorization.adocpage so the Cloud rendering reflects this:rpk cluster config set schema_registry_enable_authorization truestep).security:/authorization/acl→security:authorization/acl) and removes a stale "After enabling Schema Registry Authorization for your cluster" preamble in the Cloud Console step.Self-managed content is unchanged.
Closes DOC-1936.
Related PR
Companion cloud-docs PR with predefined-roles, Account impersonation, and What's New updates: redpanda-data/cloud-docs#581
Preview pages
Test plan
manage/schema-reg/schema-reg-authorizationshows the new "enabled by default" NOTE and the Manage Schema Registry ACLs prerequisites section.🤖 Generated with Claude Code