Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Jun 30, 2025

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1462
Review deadline: July 22

This pull request introduces updates to the documentation for deploying, managing, and monitoring Kafka Connect and Redpanda in Kubernetes. The changes include reorganization and clarification of Helm chart details, updates to connector management workflows, and improvements to monitoring instructions. Below are the key changes grouped by theme:

Deployment and Helm Chart Updates:

  • Updated the Redpanda Helm chart to version 25.1.1 (GA), removing references to the beta version and clarifying that Kafka Connect is no longer bundled as a subchart. Users are now directed to install the connectors Helm chart separately. [1] [2] [3]
  • Added instructions for unified installation of the Redpanda Operator and CRDs using a single Helm command.

Kafka Connect Management Enhancements:

  • Expanded documentation on verifying Kafka Connect accessibility, including commands to check pod status, test the REST API, and list available connector plugins.
  • Introduced a detailed guide for managing connectors through Redpanda Console, including troubleshooting connectivity and using the REST API for automation.

Monitoring Improvements:

  • Updated the monitoring prerequisites to include Kafka Connect deployment with monitoring enabled and clarified the required tools (kubectl and Helm).
  • Fixed the :env-kubernetes: metadata in the monitoring connectors page to ensure proper rendering for Kubernetes-specific content.

Miscellaneous Updates:

  • Corrected a typo in an example configuration field from liables to pandas and updated error messaging for invalid fields.
  • Removed unused :page-context-links: metadata from multiple files for consistency. [1] [2]

These changes improve the clarity and usability of the documentation for users managing Kafka Connect and Redpanda in Kubernetes environments.

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 June 30, 2025 08:30
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 30, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.


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
🪧 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.
    • Explain this complex logic.
    • 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. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

Documentation and Community

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

@netlify
Copy link

netlify bot commented Jun 30, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 800ce9e
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/687a045ecd8cc200087bfcad
😎 Deploy Preview https://deploy-preview-1186--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.

@JakeSCahill JakeSCahill requested review from chrisseto and removed request for a team June 30, 2025 08:30
@chrisseto chrisseto requested a review from david-yu June 30, 2025 13:40
Copy link
Contributor

@chrisseto chrisseto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this PR, I wonder if we should include instructions on how to get started with RPCN when we send out the connectors TSB. WDYT @david-yu ?

PR LGTM!

@JakeSCahill JakeSCahill requested a review from a team July 2, 2025 14:26
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.

pls check my comments but looks good!

@JakeSCahill JakeSCahill requested a review from chrisseto July 17, 2025 07:56
Copy link
Contributor

@chrisseto chrisseto 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 7177b07 into beta Jul 18, 2025
7 checks passed
@JakeSCahill JakeSCahill deleted the DOC-1462 branch July 18, 2025 08:27
paulohtb6 pushed a commit that referenced this pull request Jul 30, 2025
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