Skip to content

Add Redpanda Connect support for Azure BYOVPC#308

Merged
kbatuigas merged 5 commits intomainfrom
ts/add-rpcn-support-for-aws-byovpc
Jun 4, 2025
Merged

Add Redpanda Connect support for Azure BYOVPC#308
kbatuigas merged 5 commits intomainfrom
ts/add-rpcn-support-for-aws-byovpc

Conversation

@tomasz-sadura
Copy link
Copy Markdown
Contributor

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

Checks

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

@netlify
Copy link
Copy Markdown

netlify bot commented May 26, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit cd1176d
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/683eb417cb38f00008e6ccfb
😎 Deploy Preview https://deploy-preview-308--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
Copy Markdown
Contributor

coderabbitai bot commented May 26, 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

The changes introduce two new user-assigned identity variables for Redpanda Connect and Redpanda Connect API in the Terraform variable JSON configuration file. The "create_resource_groups" variable is set to "false". Example output variables for these new identities are added. In the network configuration, a subnet name reference is corrected to use the appropriate variable. The cluster configuration is updated to include the two new user-assigned identities under the "user_assigned_identities" object. These updates extend identity management for Redpanda Connect components and correct a subnet naming inconsistency.

Suggested reviewers

  • micheleRP

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.

@tomasz-sadura tomasz-sadura marked this pull request as ready for review May 28, 2025 10:26
@tomasz-sadura tomasz-sadura requested a review from a team as a code owner May 28, 2025 10:26
Copy link
Copy Markdown
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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0d7eb35 and 37c984c.

📒 Files selected for processing (1)
  • modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (5 hunks)
🔇 Additional comments (3)
modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (3)

99-99: Inconsistent naming and type for new Terraform variables
The variables

  • "create_resource_groups": "false"
  • "kafka_connect_identity_name": "kafka-connect-uai"
  • "redpanda_connect_identity_name": "redpanda-connect-uai"
  • "redpanda_connect_api_identity_name": "redpanda-connect-api-uai"

need to be checked against your Terraform definitions:

  1. If create_resource_groups is declared as a boolean in *.tf, it should be false (no quotes) rather than "false".
  2. The identity variables here (*_identity_name) should exactly match the names used in your .tf variable declarations and the placeholders in your JSON snippets ($kafka_connect_assigned_identity_name, etc.).

Please verify the variable declarations in your Terraform code and adjust the naming and types to ensure consistency.

Also applies to: 112-114


314-314: Approved: Corrected subnet reference
The subnet mapping for rp_1_vnet is now using $rp_1_vnet_subnet_name instead of the incorrect $rp_2_vnet_subnet_name. This aligns the JSON with the intended VNet configuration.


392-394: Added new user-assigned identities
You’ve correctly introduced entries for

  • "kafka_connect_assigned_identity": { "name": "$kafka_connect_assigned_identity_name" }
  • "redpanda_connect_assigned_identity": { "name": "$redpanda_connect_assigned_identity_name" }
  • "redpanda_connect_api_assigned_identity": { "name": "$redpanda_connect_api_assigned_identity_name" }

Ensure that the corresponding variables exist in your Terraform code and that their names align exactly with these placeholders.

Comment on lines +226 to +227
redpanda_connect_user_assigned_identity_name = "my-redpanda-connect-uai"
redpanda_connect_api_user_assigned_identity_name = "my-redpanda-connect-api-uai"
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot May 28, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

Mismatch between Terraform outputs and JSON placeholders
The example output shows:

redpanda_connect_user_assigned_identity_name = "my-redpanda-connect-uai"
redpanda_connect_api_user_assigned_identity_name = "my-redpanda-connect-api-uai"

but the JSON snippets expect $redpanda_connect_assigned_identity_name and $redpanda_connect_api_assigned_identity_name. The extra user_assigned segment in the output variables doesn’t align with the placeholders. This discrepancy will cause variable interpolation failures when creating the cluster. Please reconcile these names across your Terraform outputs, variable definitions, and JSON templates.

🤖 Prompt for AI Agents
In modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc around
lines 226 to 227, the Terraform output variable names include "user_assigned"
(redpanda_connect_user_assigned_identity_name and
redpanda_connect_api_user_assigned_identity_name), but the JSON placeholders use
redpanda_connect_assigned_identity_name and
redpanda_connect_api_assigned_identity_name without "user_assigned". To fix
this, rename the Terraform output variables to match the JSON placeholders by
removing "user_" from their names, ensuring consistent naming across Terraform
outputs, variable definitions, and JSON templates to avoid interpolation errors.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@tomasz-sadura would you mind double checking this and confirming whether or not the lines 393-394 below need to also be changed?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

do you mean to keep the vars naming matching the terraform output? We can do this, I will commit.

@kbatuigas kbatuigas self-assigned this Jun 2, 2025
@kbatuigas kbatuigas self-requested a review June 2, 2025 17:13
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

@tomasz-sadura Just one comment to double check, thank you

Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

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

Looks good, thank you @tomasz-sadura ! I will go ahead and merge for you.

@kbatuigas kbatuigas merged commit f9ed0f7 into main Jun 4, 2025
5 checks passed
@kbatuigas kbatuigas deleted the ts/add-rpcn-support-for-aws-byovpc branch June 4, 2025 16:18
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.

2 participants