Skip to content

Conversation

@asimms41
Copy link
Contributor

@asimms41 asimms41 commented Apr 25, 2025

Description

Resolves DOC-1186
Review deadline: 9th May

This pull request updates documentation for Redpanda Connect and BYOVPC clusters, introduces new configuration options for AWS BYOVPC setups, and improves clarity and usability of example configurations. Below is a summary of the most important changes:

Updates to Redpanda Connect Availability

  • Updated documentation to reflect that Redpanda Connect is now in beta for BYOVPC clusters on both AWS and GCP, while it remains unavailable on Azure. This change is reflected in multiple files, including availability-message.adoc, cloud-overview.adoc, and feature-flag-rpcn.adoc [1] [2] [3] [4].

Enhancements to AWS BYOVPC Configuration

  • Added new configuration options for AWS BYOVPC clusters, such as enabling PrivateLink, preserving cluster data on deletion, and using condition tags to control resource modifications. These changes improve flexibility and customization for users. [1] [2]
  • Expanded example configurations for AWS BYOVPC to include multiple public subnets for scalability, Internet Gateway requirements, and detailed instructions for setting up environment variables. [1] [2]

Improvements to Example Files and Validation

  • Updated example JSON files (redpanda-network.json and redpanda-cluster.json) to use Terraform output variables for dynamic values, ensuring consistency and reducing manual errors. [1] [2] [3]
  • Enhanced validation checks for the rpk cloud byoc aws apply command by including additional IAM instance profile permissions, such as redpanda_connect_node_group_instance_profile.

New Documentation Section

  • Added a new section in the "What's New" page to announce the beta availability of Redpanda Connect for BYOVPC clusters on AWS and GCP, along with links to relevant quickstart guides.

Page previews

What's new
Redpanda Cloud Overview
Create a BYOVPC cluster on AWS

Checks

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

Summary by CodeRabbit

  • Documentation
    • Updated documentation to reflect that Redpanda Connect is now in beta for BYOVPC clusters on both AWS and GCP.
    • Clarified supported platforms for Redpanda Connect in feature availability and beta sections.
    • Added details about new required AWS resources for BYOVPC cluster configuration.
    • Announced that Redpanda Connect is enabled by default for new BYOVPC clusters on AWS and GCP, with a quickstart guide reference.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 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

The documentation was updated to reflect expanded support for Redpanda Connect in BYOVPC clusters, now indicating beta availability on both AWS and GCP. Updates were made across feature availability tables, beta feature announcements, and cluster configuration guides. The AWS BYOVPC cluster creation documentation was revised to include new required AWS resources and updated validation checks. Additionally, a new beta feature announcement for Redpanda Connect was added, and references to platform support were clarified throughout the documentation.

Changes

Files/Paths Change Summary
modules/develop/partials/availability-message.adoc
modules/shared/partials/feature-flag-rpcn.adoc
Updated documentation to indicate Redpanda Connect is in beta for BYOVPC clusters on both AWS and GCP.
modules/get-started/pages/cloud-overview.adoc Updated feature availability tables to clarify Redpanda Connect support for BYOVPC on AWS and GCP.
modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc Added new AWS resource requirements and updated validation checks for BYOVPC cluster creation on AWS.
modules/get-started/pages/whats-new-cloud.adoc Added a new beta feature announcement for Redpanda Connect availability in BYOVPC clusters on AWS and GCP.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    User->>Docs: Reads BYOVPC AWS/GCP cluster creation guide
    Docs-->>User: Shows updated resource requirements and validation
    User->>Docs: Checks feature availability table
    Docs-->>User: Displays Redpanda Connect beta status for AWS and GCP
    User->>Docs: Reads What's New section
    Docs-->>User: Announces Redpanda Connect beta for BYOVPC AWS/GCP
Loading

Suggested reviewers

  • frenchfrywpepper
  • Feediver1

Poem

In clusters where clouds gently roam,
Redpanda Connect now calls two clouds home.
AWS and GCP, both in beta’s embrace,
New resources and docs, all neatly in place.
With features expanded and guides all anew,
The docs hop ahead—so much more you can do!
🐇✨


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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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 Apr 25, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 31bf048
🔍 Latest deploy log https://app.netlify.com/sites/rp-cloud/deploys/681df581ea73980008cf3f0a
😎 Deploy Preview https://deploy-preview-274--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 site configuration.

@asimms41 asimms41 requested a review from tomasz-sadura April 25, 2025 13:49
@asimms41 asimms41 requested review from david-yu and jrkinley April 25, 2025 14:05
@asimms41 asimms41 marked this pull request as ready for review April 25, 2025 14:06
@asimms41 asimms41 requested a review from a team as a code owner April 25, 2025 14:06
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 (5)
modules/shared/partials/feature-flag-rpcn.adoc (1)

5-5: Clarify unsupported platform
The bullet correctly indicates beta support on AWS and GCP. To avoid ambiguity, consider appending “(not available on Azure)” so readers know Azure isn’t supported here either.

modules/develop/partials/availability-message.adoc (1)

5-5: Grammar refinement for parallelism
The phrase “but not on Azure” works, but for consistency with other bullets you might use “and not on Azure” to maintain parallel structure.

modules/get-started/pages/cloud-overview.adoc (2)

268-268: Clarify limited availability bullet
The entry “* Redpanda Connect for Dedicated and BYOC (not BYOVPC on Azure)” could read more clearly as “* Redpanda Connect on Dedicated and BYOC clusters (excluding BYOVPC on Azure)”.


280-280: Remove unnecessary comma
In “* Redpanda Connect on Serverless, and for BYOVPC on GCP and AWS”, the comma is redundant. Consider:
“* Redpanda Connect on Serverless and for BYOVPC on GCP and AWS”.

modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc (1)

351-353: Remove duplicate profile in validation list
The validation checks list connectors_node_group_instance_profile twice. Remove the duplicate and ensure it reads:
connectors_node_group_instance_profile, redpanda_connect_node_group_instance_profile, utility_node_group_instance_profile, and k8s_cluster_role.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d2545ba and 3877fcd.

📒 Files selected for processing (5)
  • modules/develop/partials/availability-message.adoc (1 hunks)
  • modules/get-started/pages/cloud-overview.adoc (2 hunks)
  • modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc (3 hunks)
  • modules/get-started/pages/whats-new-cloud.adoc (1 hunks)
  • modules/shared/partials/feature-flag-rpcn.adoc (1 hunks)
🔇 Additional comments (2)
modules/get-started/pages/whats-new-cloud.adoc (1)

38-43: Verify existing AWS BYOVPC cluster support
The update notes adding Connect to existing BYOVPC GCP clusters. Please confirm whether existing AWS BYOVPC clusters can also have Redpanda Connect added; if so, update this section for parity.

modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc (1)

225-227: Add Redpanda Connect resource entries
The new redpanda_connect_node_group_instance_profile and redpanda_connect_security_group keys are correctly inserted. Please verify these names match the Terraform output variables in the cloud-examples repo and that sample Terraform code is updated to provide these ARNs.

Also applies to: 237-239

@david-yu
Copy link
Contributor

david-yu commented May 2, 2025

@asimms41 Could you change the networks json to the following so quotes are removed? Still going through validating the workflow.

 "private_subnets": {
          "arns": ${AWS_PRIVATE_SUBNETS}
        },

@david-yu
Copy link
Contributor

david-yu commented May 2, 2025

We also need to wrap the contents of the body of then network request with "network" so it should be something like this

cat > redpanda-network.json <<EOF
{
  "network": {
     "name":"sample-redpanda-network",
     "resource_group_id": "${REDPANDA_RG_ID}",
     "cloud_provider":"CLOUD_PROVIDER_AWS",
     "region": "${AWS_REGION}",
     "cluster_type":"TYPE_BYOC",
     "customer_managed_resources": {
       "aws": {
         "management_bucket": {
           "arn": "${AWS_MANAGEMENT_BUCKET}"
         },
         "dynamodb_table": {
           "arn": "${AWS_DYNAMODB_TABLE}"
         },
         "private_subnets": {
           "arns": ${AWS_PRIVATE_SUBNETS}
         },
         "vpc": {
           "arn": "${AWS_VPC}"
         }
      }
    }
  }
} 
EOF

@asimms41
Copy link
Contributor Author

asimms41 commented May 2, 2025

We also need to wrap the contents of the body of then network request with "network" so it should be something like this

cat > redpanda-network.json <<EOF
{
  "network": {
     "name":"sample-redpanda-network",
     "resource_group_id": "${REDPANDA_RG_ID}",
     "cloud_provider":"CLOUD_PROVIDER_AWS",
     "region": "${AWS_REGION}",
     "cluster_type":"TYPE_BYOC",
     "customer_managed_resources": {
       "aws": {
         "management_bucket": {
           "arn": "${AWS_MANAGEMENT_BUCKET}"
         },
         "dynamodb_table": {
           "arn": "${AWS_DYNAMODB_TABLE}"
         },
         "private_subnets": {
           "arns": ${AWS_PRIVATE_SUBNETS}
         },
         "vpc": {
           "arn": "${AWS_VPC}"
         }
      }
    }
  }
} 
EOF

@david-yu - I've added in your updates.

@david-yu
Copy link
Contributor

david-yu commented May 2, 2025

Thanks could you also please make sure we do the following to create the payload for the create cluster API call? The json is not correct with v1 and we should populate the field via env variables from Terraform.

export AWS_ZONES='["use2-az1", "use2-az2", "use2-az3"]'
export REDPANDA_CLUSTER_NAME=sample-redpanda-cluster
export REDPANDA_VERSION=25.1
export REDPANDA_THROUGHPUT_TIER=tier-1-aws-v3-arm
export AGENT_INSTANCE_PROFILE_ARN="$(terraform output -raw agent_instance_profile_arn)"
export CONNECTORS_NODE_GROUP_INSTANCE_PROFILE="$(terraform output -raw connectors_node_group_instance_profile_arn)"
export REDPANDA_NODE_GROUP_INSTANCE_PROFILE="$(terraform output -raw redpanda_node_group_instance_profile_arn)"
export REDPANDA_CONNECT_NODE_GROUP_INSTANCE_PROFILE="$(terraform output -raw redpanda_connect_node_group_instance_profile_arn)"
export UTILITY_NODE_GROUP_INSTANCE_PROFILE="$(terraform output -raw utility_node_group_instance_profile_arn)"
export CONNECTORS_SECURITY_GROUP="$(terraform output -raw connectors_security_group_arn)" 
export REDPANDA_CONNECT_SECURITY_GROUP="$(terraform output -raw redpanda_connect_security_group_arn)"
export NODE_SECURITY_GROUP="$(terraform output -raw node_security_group_arn)"
export UTILITY_SECURITY_GROUP="$(terraform output -raw utility_security_group_arn)"
export REDPANDA_AGENT_SECURITY_GROUP="$(terraform output -raw redpanda_agent_security_group_arn)"
export REDPANDA_NODE_GROUP_SECURITY_GROUP="$(terraform output -raw redpanda_node_group_security_group_arn)"
export CLUSTER_SECURITY_GROUP="$(terraform output -raw cluster_security_group_arn)"
export K8S_CLUSTER_ROLE="$(terraform output -raw k8s_cluster_role_arn)"
export CLOUD_STORAGE_BUCKET="$(terraform output -raw cloud_storage_bucket_arn)"
export PERMISSIONS_BOUNDARY_POLICY="$(terraform output -raw permissions_boundary_policy_arn)"

cat > redpanda-cluster.json <<EOF
{
  "cluster": {
    "cloud_provider":"CLOUD_PROVIDER_AWS",
    "connection_type":"CONNECTION_TYPE_PRIVATE",
    "name": "${REDPANDA_CLUSTER_NAME}",
    "resource_group_id": "${REDPANDA_RG_ID}",
    "network_id": "${REDPANDA_NETWORK_ID}",
    "region": "${AWS_REGION}",
    "throughput_tier": "${REDPANDA_THROUGHPUT_TIER}",
    "type": "TYPE_BYOC",
    "zones": ${AWS_ZONES},
    "redpanda_version": "${REDPANDA_VERSION}",
    "customer_managed_resources": {
      "aws": {
        "agent_instance_profile": {
          "arn": "${AGENT_INSTANCE_PROFILE_ARN}"
        },
        "connectors_node_group_instance_profile": {
          "arn": "${CONNECTORS_NODE_GROUP_INSTANCE_PROFILE}"
        },
        "redpanda_connect_node_group_instance_profile": {
          "arn": "${REDPANDA_CONNECT_NODE_GROUP_INSTANCE_PROFILE}"
        },
        "redpanda_node_group_instance_profile": {
          "arn": "${REDPANDA_NODE_GROUP_INSTANCE_PROFILE}"
        },
        "utility_node_group_instance_profile": {
          "arn": "${UTILITY_NODE_GROUP_INSTANCE_PROFILE}"
        },
        "connectors_security_group": {
          "arn": "${CONNECTORS_SECURITY_GROUP}"
        },
        "redpanda_connect_security_group": {
          "arn": "${REDPANDA_CONNECT_SECURITY_GROUP}"
        },
        "node_security_group": {
          "arn": "${NODE_SECURITY_GROUP}"
        },
        "utility_security_group": {
          "arn": "${UTILITY_SECURITY_GROUP}"
        },
        "redpanda_agent_security_group": {
          "arn": "${REDPANDA_AGENT_SECURITY_GROUP}"
        },
        "redpanda_node_group_security_group": {
          "arn": "${REDPANDA_NODE_GROUP_SECURITY_GROUP}"
        },
        "cluster_security_group": {
          "arn": "${CLUSTER_SECURITY_GROUP}"
        },
        "k8s_cluster_role": {
          "arn": "${K8S_CLUSTER_ROLE}"
        },
        "cloud_storage_bucket": {
          "arn": "${CLOUD_STORAGE_BUCKET}"
        },
        "permissions_boundary_policy": {
          "arn": "${PERMISSIONS_BOUNDARY_POLICY}"
        }
      }
    }
  }
}
EOF

@david-yu
Copy link
Contributor

david-yu commented May 2, 2025

Please also update the byoc.auto.tfvars.json file with the following contents otherwise the cluster will fail. At least one public subnet is required to provision the NAT Gateway for the cluster to connect back to the control plane.

cat > byoc.auto.tfvars.json <<EOF
{
  "aws_account_id": "${AWS_ACCOUNT_ID}",
  "region": "${AWS_REGION}",
  "common_prefix": "${REDPANDA_COMMON_PREFIX}",
  "condition_tags": {
  },
  "default_tags": {
  },
  "ignore_tags": [
  ],
  "vpc_id": "${AWS_VPC_ID}",
  "zones": [],
  "enable_private_link": true,
  "create_rpk_user": true,
  "force_destroy_cloud_storage": true,
  "public_subnet_cidrs": ["10.0.1.0/24"]
}
EOF

@david-yu
Copy link
Contributor

david-yu commented May 2, 2025

Currently stuck on provisioning a NAT gateway after public subnet is specified.

@david-yu
Copy link
Contributor

david-yu commented May 5, 2025

For API calls please ensure we are using v1 endpoints

curl -X POST "https://api.redpanda.com/v1/networks" \
 -H "accept: application/json" \
 -H "content-type: application/json" \
 -H "authorization: Bearer ${BEARER_TOKEN}" \
 --data-binary @redpanda-network.json

instead of

curl -X POST "https://api.redpanda.com/v1beta2/networks" \
 -H "accept: application/json" \
 -H "content-type: application/json" \
 -H "authorization: Bearer ${BEARER_TOKEN}" \
 --data-binary @redpanda-network.json

@david-yu
Copy link
Contributor

david-yu commented May 5, 2025

Ignore, I didn't realize the docs were also recently updated to use v1.

@david-yu
Copy link
Contributor

david-yu commented May 5, 2025

Found an issue

export REDPANDA_NETWORK_ID=$(curl -X POST "https://api.redpanda.com/v1/networks" \
 -H "accept: application/json" \
 -H "content-type: application/json" \
 -H "authorization: Bearer ${BEARER_TOKEN}" \
 --data-binary @redpanda-network.json | jq -r '.operation.id')

should be

export REDPANDA_NETWORK_ID=$(curl -X POST "https://api.redpanda.com/v1/networks" \
 -H "accept: application/json" \
 -H "content-type: application/json" \
 -H "authorization: Bearer ${BEARER_TOKEN}" \
 --data-binary @redpanda-network.json | jq -r '.operation.resource_id')

@david-yu
Copy link
Contributor

david-yu commented May 6, 2025

For force_destroy_cloud_storage we should note that customers should only set this to true if they do not want to keep a copy of their data after destroying the Redpanda Cluster. This is optional and not required.

  "force_destroy_cloud_storage": true,

@david-yu
Copy link
Contributor

david-yu commented May 6, 2025

Related to

Currently stuck on provisioning a NAT gateway after public subnet is specified.

The issue was that we needed to provision an Internet Gateway and specify at least 6 public CIDR ranges to automatically create public subnets.

resource "aws_internet_gateway" "redpanda" {
  count  = 1
  vpc_id = data.aws_vpc.redpanda.id
}

resource "aws_route" "public" {
  count                  = 1
  route_table_id         = aws_route_table.main.id
  destination_cidr_block = "0.0.0.0/0"
  gateway_id             = aws_internet_gateway.redpanda[0].id
}

@asimms41
Copy link
Contributor Author

asimms41 commented May 7, 2025

Hi @david-yu, I think I have updated the PR with your comments except for this last one:

resource "aws_internet_gateway" "redpanda" {
  count  = 1
  vpc_id = data.aws_vpc.redpanda.id
}

resource "aws_route" "public" {
  count                  = 1
  route_table_id         = aws_route_table.main.id
  destination_cidr_block = "0.0.0.0/0"
  gateway_id             = aws_internet_gateway.redpanda[0].id
}

Where does this fit in the workflow. Also, is the use of Private Link a known limitation. It's difficult to tell from the Slack thread.

@asimms41 asimms41 requested a review from david-yu May 8, 2025 12:42
@david-yu
Copy link
Contributor

david-yu commented May 8, 2025

@asimms41 asimms41 requested a review from david-yu May 8, 2025 17:25
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.

Added a couple clarifying suggestions, but lgtm

@asimms41 asimms41 merged commit 16667a5 into main May 9, 2025
6 checks passed
@asimms41 asimms41 deleted the DOC-1186_AWS_BYOVPC_for_RPCN branch May 9, 2025 12:39
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