Skip to content

docs: add Schema Registry ACLs for Redpanda Operator#1619

Open
david-yu wants to merge 5 commits intoredpanda-data:mainfrom
david-yu:docs/schema-registry-acls-operator
Open

docs: add Schema Registry ACLs for Redpanda Operator#1619
david-yu wants to merge 5 commits intoredpanda-data:mainfrom
david-yu:docs/schema-registry-acls-operator

Conversation

@david-yu
Copy link
Contributor

Summary

  • Adds a new page Manage Schema Registry ACLs (Operator) under Manage > Kubernetes > Security > Authentication and Authorization
  • Documents the new subject and registry ACL resource types for User, RedpandaRole, and Group CRDs introduced in Add Schema Registry ACLs redpanda-operator#1306
  • Adds nav entry and cross-links from the Schema Controller page
  • Links to the existing Schema Registry Authorization page for concepts and supported operations

Test plan

  • Verify the new page renders correctly in the Antora preview
  • Verify nav entry appears under Security > Authentication and Authorization
  • Verify cross-links from k-schema-controller page work
  • Verify xref links to CRD reference and schema-reg-authorization resolve correctly
  • Verify included example snippets from acceptance tests render properly (requires operator PR to be merged first for updated examples)

🤖 Generated with Claude Code

Add documentation for managing Schema Registry ACLs using the Redpanda
Operator's User, RedpandaRole, and Group custom resources. This covers
the new `subject` and `registry` ACL resource types added in operator
PR redpanda-data/redpanda-operator#1306.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@david-yu david-yu requested a review from a team as a code owner March 18, 2026 19:22
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 18, 2026

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.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e6fdc26e-a0f6-4b28-9b81-b5500484ae3a

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

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This pull request adds documentation for managing Schema Registry ACLs with the Redpanda Operator in Kubernetes. The changes include a new navigation entry pointing to a comprehensive documentation file that describes how to define and manage Schema Registry ACLs across User, RedpandaRole, and Group resources. The documentation covers supported operations, prerequisites, manifest examples, common use cases, and verification steps. Additionally, cross-reference links are added to an existing schema controller documentation file.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • sago2k8
  • chrisseto
  • Feediver1
  • paulohtb6
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is incomplete according to the template requirements. It is missing the 'Resolves' JIRA ticket reference, review deadline, page previews, and check selections (New feature, Content gap, etc.). Add the JIRA ticket reference, review deadline, page preview link, and select the appropriate check boxes (likely 'New feature' or 'Content gap').
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly and concisely summarizes the main change: adding Schema Registry ACLs documentation for the Redpanda Operator.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can approve the review once all CodeRabbit's comments are resolved.

Enable the reviews.request_changes_workflow setting to automatically approve the review once all CodeRabbit's comments are resolved.

@netlify
Copy link

netlify bot commented Mar 18, 2026

Deploy Preview for redpanda-docs-preview ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 37b6e75
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69bb2dd70d786b0007467845
😎 Deploy Preview https://deploy-preview-1619--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 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.

🧹 Nitpick comments (2)
modules/manage/pages/kubernetes/security/authentication/k-schema-registry-acls.adoc (1)

6-6: Prefer auto-title xrefs where possible.

Several xrefs hard-code link text; repository convention prefers xref:...[] so titles are pulled from targets automatically.

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."

Also applies to: 41-42, 55-56

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@modules/manage/pages/kubernetes/security/authentication/k-schema-registry-acls.adoc`
at line 6, The xref links in k-schema-registry-acls.adoc currently include
hard-coded link text (e.g.,
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-user[User]
and
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-role[RedpandaRole]);
replace those explicit labels with auto-title xrefs by removing the bracket text
so they become
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-user[]
and
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-role[],
and apply the same change to the other occurrences noted around lines 41-42 and
55-56 so the link titles are pulled automatically from the target documents.
modules/manage/pages/kubernetes/k-schema-controller.adoc (1)

281-281: Use empty-bracket xref for consistency with docs linking style.

This link can rely on target page title instead of hard-coded text.

Suggested diff
-* xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[Manage Schema Registry ACLs (Operator)]
+* xref:manage:kubernetes/security/authentication/k-schema-registry-acls.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."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@modules/manage/pages/kubernetes/k-schema-controller.adoc` at line 281,
Replace the explicit link text
xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[Manage
Schema Registry ACLs (Operator)] with an empty-bracket xref so the target title
is pulled automatically, e.g.
xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[];
update the occurrence in k-schema-controller.adoc where that xref appears.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@modules/manage/pages/kubernetes/k-schema-controller.adoc`:
- Line 281: Replace the explicit link text
xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[Manage
Schema Registry ACLs (Operator)] with an empty-bracket xref so the target title
is pulled automatically, e.g.
xref:manage:kubernetes/security/authentication/k-schema-registry-acls.adoc[];
update the occurrence in k-schema-controller.adoc where that xref appears.

In
`@modules/manage/pages/kubernetes/security/authentication/k-schema-registry-acls.adoc`:
- Line 6: The xref links in k-schema-registry-acls.adoc currently include
hard-coded link text (e.g.,
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-user[User]
and
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-role[RedpandaRole]);
replace those explicit labels with auto-title xrefs by removing the bracket text
so they become
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-user[]
and
xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-role[],
and apply the same change to the other occurrences noted around lines 41-42 and
55-56 so the link titles are pulled automatically from the target documents.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 85b3a6ad-76ca-41ed-af12-72b7c75648f6

📥 Commits

Reviewing files that changed from the base of the PR and between 49e7aa6 and 85a8e11.

📒 Files selected for processing (3)
  • modules/ROOT/nav.adoc
  • modules/manage/pages/kubernetes/k-schema-controller.adoc
  • modules/manage/pages/kubernetes/security/authentication/k-schema-registry-acls.adoc

david-yu and others added 4 commits March 18, 2026 12:58
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.

1 participant