-
Notifications
You must be signed in to change notification settings - Fork 45
DOC-1620: tag prop for SR AUthZ in Cloud #1310
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
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthrough
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
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: 1
🧹 Nitpick comments (1)
modules/reference/pages/properties/cluster-properties.adoc (1)
5676-5694
: Fix schema_registry_enable_authorization docs: correct prop name, add license banner & related propsUpdate modules/reference/pages/properties/cluster-properties.adoc (around lines 5676–5694):
- Add the enterprise-license include so this flag shows the banner consistently.
- Change the property reference from
to`schema_registry_api.authn_method`
to match the`schema_registry_api[].authentication_method`
kafka_api[].authentication_method
convention.- Add a Related properties block for discoverability.
Suggested patch:
// tag::schema_registry_enable_authorization[] === schema_registry_enable_authorization +ifndef::env-cloud[] +include::reference:partial$enterprise-licensed-property.adoc[] +endif::[] + Enables ACL-based authorization for Schema Registry requests. When `true`, Schema Registry -uses ACL-based authorization instead of the default `public/user/superuser` authorization model. Requires authentication to be enabled using the `schema_registry_api.authn_method` property. +uses ACL-based authorization instead of the default `public/user/superuser` authorization model. Requires authentication to be enabled using the `schema_registry_api[].authentication_method` property. *Requires restart:* No *Visibility:* `user` *Type:* boolean *Enterprise license required:* `true` *Default:* `false` +*Related properties*: +* `schema_registry_api[].authentication_method` +* <<http_authentication,`http_authentication`>> +* <<superusers,`superusers`>> --- // end::schema_registry_enable_authorization[]Please verify that the xref targets
http_authentication
andsuperusers
resolve correctly, and confirm in practice that no restart is required for this change.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
local-antora-playbook.yml
(1 hunks)modules/reference/pages/properties/cluster-properties.adoc
(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
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.
lgtm! reminder to revert playbook before merging
Thanks!! It looks good to me and the property is available for cloud indeed. |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description
Resolves DOC-1620: tag prop for SR AuthZ in Cloud
Review deadline:
Page previews
https://deploy-preview-1310--redpanda-docs-preview.netlify.app/redpanda-cloud/reference/properties/cluster-properties/#schema_registry_enable_authorization
Checks