Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

Description

This pull request makes minor improvements to the documentation in console-v3.adoc for migrating from Redpanda Console v2 to v3. The changes clarify the instructions for migrating user roles and permissions, especially when using impersonation in v3.

  • Documentation clarity:
    • Removed a redundant sentence introducing the Google OIDC migration example to avoid repetition.
    • Clarified the explanation about roleBindings and impersonation, making it clear that users must be provisioned and granted permissions in Redpanda when using impersonation in v3.

Page previews

Checks

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

@JakeSCahill JakeSCahill requested a review from a team as a code owner October 2, 2025 16:04
@netlify
Copy link

netlify bot commented Oct 2, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 59dd365
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/68dea2a38067560008878e45
😎 Deploy Preview https://deploy-preview-1370--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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025

📝 Walkthrough

Walkthrough

The documentation file modules/migrate/pages/console-v3.adoc was updated to remove a duplicated sentence, clarify that OIDC impersonation ignores roleBindings and that access is controlled by ACLs/RBAC, and add explicit instructions to provision users in Redpanda and grant permissions. The “Migrate Redpanda Console roles to Redpanda ACLs” subsection was revised to mention impersonation and include the provisioning instruction. UI elements (button bars and editors) were added to the migration tool section using two ++++ blocks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • mattschumpert
  • Feediver1
  • paulohtb6

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description omits the required JIRA ticket link and review deadline under the Description section and does not include an actual page preview link in the Page previews section, leaving placeholder comments in place. Add the “Resolves https://redpandadata.atlassian.net/browse/” line with the appropriate ticket, specify a review deadline, and replace the placeholder in the Page previews section with the actual Netlify preview URL for the updated documentation.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title “Fix duplicate lines” accurately references the removal of a redundant sentence but does not capture the broader clarifications made to impersonation and permission provisioning, though it does correspond to a real part of the changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch JakeSCahill-patch-6

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.

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: 0

🧹 Nitpick comments (1)
modules/migrate/pages/console-v3.adoc (1)

215-217: Impersonation guidance looks correct; add refs for “provision and grant permissions.”

The clarification is good. Consider adding direct cross-references so readers know where to provision users and assign permissions.

Apply this minimal tweak:

-You must provision your users in Redpanda and grant them the appropriate permissions.
+You must provision your users in Redpanda and grant them the appropriate permissions. See xref:manage:security/authentication.adoc[] and xref:manage:security/authorization/index.adoc[].
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira 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 8d68599 and 59dd365.

📒 Files selected for processing (1)
  • modules/migrate/pages/console-v3.adoc (1 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

@JakeSCahill JakeSCahill merged commit f324697 into main Oct 2, 2025
7 checks passed
@JakeSCahill JakeSCahill deleted the JakeSCahill-patch-6 branch October 2, 2025 19:51
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.

3 participants