Skip to content

Conversation

Feediver1
Copy link
Contributor

@Feediver1 Feediver1 commented Aug 14, 2025

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

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@Feediver1 Feediver1 requested a review from a team as a code owner August 14, 2025 23:53
Copy link

netlify bot commented Aug 14, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit cea3ece
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/68a4e173a2aebf00083d0922
😎 Deploy Preview https://deploy-preview-1310--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Aug 14, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

  • Updated local Antora playbook to use cloud-docs branch DOC-1618 instead of main.
  • Added a new cluster property entry: schema_registry_enable_authorization, including description, defaults, licensing note, restart behavior, and tag wrappers for snippet extraction.
  • No changes to exported code or executable logic; documentation and build configuration only.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective Addressed Explanation
Tag SR AuthZ property for Cloud (DOC-1620)

Assessment against linked issues: Out-of-scope changes

Code Change Explanation
Switch cloud-docs source branch to DOC-1618 in local-antora-playbook.yml (local-antora-playbook.yml) Not referenced in DOC-1620; appears to be a local build config change unrelated to tagging the SR AuthZ property. Unclear necessity for this specific issue.

Possibly related PRs

Suggested reviewers

  • alenkacz
  • mattschumpert
  • deniscoady
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1620

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 props

Update 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
    `schema_registry_api.authn_method`
    to
    `schema_registry_api[].authentication_method`
    to match the 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 and superusers 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 722b308 and 1033837.

📒 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

Copy link
Contributor

@micheleRP micheleRP left a 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

@sago2k8
Copy link
Contributor

sago2k8 commented Aug 18, 2025

Thanks!! It looks good to me and the property is available for cloud indeed.

Feediver1 and others added 3 commits August 19, 2025 17:41
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@Feediver1 Feediver1 merged commit d7dc5c0 into main Aug 19, 2025
7 checks passed
@Feediver1 Feediver1 deleted the DOC-1620 branch August 19, 2025 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants