Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Sep 25, 2025

Description

This pull request updates references from "Redpanda Connectors" to "Kafka Connect connectors".

  • Updated references from "Redpanda Connectors" to "Kafka Connect connectors" in the managed connectors documentation to align with industry terminology.
  • Renamed service account and custom role titles and descriptions from "Redpanda Connectors" to "Kafka Connect" in GCP setup instructions for clarity and consistency. [1] [2]

Resolves https://redpandadata.atlassian.net/browse/DOC-1700
Review deadline:

Page previews

Create BYOVPC on GCP
Set property keys (Kafka Connect)

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner September 25, 2025 21:13
@netlify
Copy link

netlify bot commented Sep 25, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 6c2923c
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68d5b83d65301b0009055525
😎 Deploy Preview https://deploy-preview-424--rp-cloud.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 Sep 25, 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

This 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

  • tomasz-sadura
  • david-yu
  • Feediver1

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes Check ⚠️ Warning Beyond the requested renaming and capitalization adjustments, the GCP documentation file introduces entirely new sections on service-account ID extraction, workload identity bindings, and validation commands which were not part of the DOC-1700 objectives. These additions extend the scope of the pull request into broader tutorial enhancements rather than strictly applying the requested terminology changes. Please remove or isolate the new instructional content related to account-ID derivation and binding commands into a separate PR focused on tutorial improvements and restrict this PR to the terminology edits specified by DOC-1700.
✅ Passed checks (4 passed)
Check name Status Explanation
Title Check ✅ Passed The title “DOC-1700 edit Redpanda Connector to Kafka Connect” directly describes the primary change of replacing Redpanda Connector terminology with Kafka Connect and clearly aligns with the contents of the PR. This concise, single sentence highlights the key update without including extraneous detail.
Linked Issues Check ✅ Passed The changes systematically replace all instances of “Redpanda Connectors” with “Kafka Connect connectors” in both managed connectors and GCP setup documentation, including service account names, role descriptions, and example commands, fully addressing the objectives outlined in DOC-1700.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The pull request description adheres to the repository’s template by including the required headings, a clear summary with the “Resolves” link, valid page preview URLs, and the checks section marked appropriately, with the only minor omission being the review deadline date which remains blank.

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: 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-operator consistently; 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 82c0435 and 717590a.

📒 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-connectors and KSA pattern connectors-<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 remain redpanda-connectors and redpanda_connectors_role; no leftover “Redpanda Connector(s)” references.

@micheleRP micheleRP merged commit 5d5deed into main Sep 26, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-1700-edit-Redpanda-Connector-to-Kafka-Connect branch September 26, 2025 17:33
@coderabbitai coderabbitai bot mentioned this pull request Oct 6, 2025
4 tasks
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.

5 participants