-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-1700 edit Redpanda Connector to Kafka Connect #424
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
DOC-1700 edit Redpanda Connector to Kafka Connect #424
Conversation
✅ Deploy Preview for rp-cloud 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 📝 WalkthroughWalkthroughThis PR updates documentation to standardize terminology from “Redpanda Connectors” to “Kafka Connect” and adjusts related naming across service accounts, custom roles, and examples. It modifies the managed connectors converters page with a single wording change. In the BYOC GCP guide, it revises role and service account names, updates example gcloud commands, clarifies account ID derivation from service account emails, and adds/expands sections on binding service accounts and validating BYOC GCP configurations. Formatting tweaks improve consistency in terminology and code blocks. No code or API changes are introduced. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Comment |
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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc (3)
351-353: Fix broken line continuation (trailing space after backslash).The space after the backslash prevents shell line continuation, breaking the command.
Apply:
-gcloud iam service-accounts create redpanda-connect-api \ +gcloud iam service-accounts create redpanda-connect-api \
116-123: Invalid JSON: trailing comma in includedPermissions.The trailing comma makes the role file invalid JSON; gcloud will fail to load it.
Use:
"compute.networks.getRegionEffectiveFirewalls", - "compute.networks.getEffectiveFirewalls", + "compute.networks.getEffectiveFirewalls" ] }
596-599: Placeholder naming typo (underscore vs hyphen).Use
redpanda-operatorconsistently; underscores here will confuse readers.Apply:
-gcloud iam service-accounts add-iam-policy-binding <redpanda_operator-gcp-sa-account-id>@<service-project-id>.iam.gserviceaccount.com \ +gcloud iam service-accounts add-iam-policy-binding <redpanda-operator-gcp-sa-account-id>@<service-project-id>.iam.gserviceaccount.com \ --role roles/iam.workloadIdentityUser \ - --member "serviceAccount:<service-project-id>.svc.id.goog[redpanda-system/<redpanda_operator-gcp-sa-account-id>]" + --member "serviceAccount:<service-project-id>.svc.id.goog[redpanda-system/<redpanda-operator-gcp-sa-account-id>]"
📜 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.
📒 Files selected for processing (2)
modules/develop/pages/managed-connectors/converters-and-serialization.adoc(1 hunks)modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc(6 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-07T16:36:45.111Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#377
File: modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc:35-71
Timestamp: 2025-08-07T16:36:45.111Z
Learning: In Redpanda Cloud documentation, NAT subnet and firewall rule creation commands for GCP Private Service Connect are producer-side infrastructure steps that only BYOC (Bring Your Own Cloud) customers need to perform, since they manage their own VPC. Dedicated cluster customers don't need these steps because Redpanda manages the infrastructure for them. The ifdef::env-byoc[] guard correctly hides these commands from Dedicated users.
Applied to files:
modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc
⏰ 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 - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (4)
modules/get-started/pages/cluster-types/byoc/gcp/vpc-byo-gcp.adoc (4)
289-295: Casing alignment in description looks good.Description updated to sentence case without altering role semantics.
326-333: Operator role description casing LGTM.No permission changes; only wording consistency.
631-640: Kafka Connect binding: verify namespace/KSA naming.Confirm the namespace
redpanda-connectorsand KSA patternconnectors-<connectors-gcp-sa-account-id>match what the platform creates.
437-463: Approve Kafka Connect renaming. Display names and role titles/descriptions updated to “Kafka Connect”; resource IDs remainredpanda-connectorsandredpanda_connectors_role; no leftover “Redpanda Connector(s)” references.
Description
This pull request updates references from "Redpanda Connectors" to "Kafka Connect connectors".
Resolves https://redpandadata.atlassian.net/browse/DOC-1700
Review deadline:
Page previews
Create BYOVPC on GCP
Set property keys (Kafka Connect)
Checks