Skip to content

Conversation

@0xdiba
Copy link
Contributor

@0xdiba 0xdiba commented Sep 15, 2025

Just setting the REDPANDA_VERSION variable to latest.
Bumped on that when sending the docs over to a customer to create a new BYOVPC cluster

@0xdiba 0xdiba requested a review from a team as a code owner September 15, 2025 12:18
@netlify
Copy link

netlify bot commented Sep 15, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 9d9d006
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68c80430ea007d0008a2a7b0
😎 Deploy Preview https://deploy-preview-411--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 15, 2025

📝 Walkthrough

Walkthrough

  • Updated REDPANDA_VERSION from 25.1 to 25.2 in AWS BYOVPC and Azure VNet BYOC docs.
  • Added condition_tags with "redpanda-managed": "true" to byovnet.auto.tfvars.json in AWS guide.
  • Introduced a network-first provisioning flow using Cloud API in AWS guide:
    • Create network via /v1/networks and capture REDPANDA_NETWORK_ID.
    • Provided redpanda-network.json example and sample response.
    • Updated cluster creation to reference network_id with a new redpanda-cluster.json containing AWS ARNs and environment variables.
  • Added shell/JSON examples and sample outputs illustrating end-to-end network and cluster creation.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as User
  participant API as Redpanda Cloud API
  participant AWS as AWS (BYO Resources)

  Note over U,API: Network-first provisioning flow (new)

  U->>API: POST /v1/networks (redpanda-network.json)
  API-->>U: 201 Created (network_id, resource_id)

  Note over U: export REDPANDA_NETWORK_ID=<network_id>

  U->>API: POST /v1/clusters (redpanda-cluster.json with network_id and ARNs)
  API->>AWS: Validate and wire BYO resources (ARNs, SGs, buckets)
  AWS-->>API: Provisioning status
  API-->>U: Cluster creation response/status
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • david-yu
  • micheleRP
  • paulzhang97

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The PR description does not follow the repository template: it is missing the required "Resolves ..." issue line, a review deadline, Netlify page preview links, and the Checks section. The current prose only mentions the version bump and omits other non-trivial changes present in the raw summary (for example, the new AWS network/Cloud API provisioning flow, added resource tagging, and expanded JSON/examples), so reviewers cannot see the full scope from the description alone. Please update the PR body to match the repository template by adding the "Resolves" line with an issue number (or removing the placeholder), a review deadline, Netlify page preview URLs for the changed pages, and the checklist of change types; also expand the Description to enumerate the additional documentation changes from the raw summary (network-first provisioning flow, tagging, and added JSON examples) or split those changes into a separate PR if they are unrelated to the version bump.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title clearly states the primary change — updating the REDPANDA_VERSION to 25.2 — which matches the PR objectives and the version bumps present in the changed files. It is short, specific, and understandable to a teammate scanning history.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch db/latest_version

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

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: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (1)

416-419: Env var mismatch: undefined REDPANDA_CLUSTER_RESOURCE_GROUP_NAME.

Earlier you export REDPANDA_RESOURCE_GROUP_NAME, but the JSON uses REDPANDA_CLUSTER_RESOURCE_GROUP_NAME. That will expand to an empty string and break the API call.

Apply this diff:

-          "redpanda_resource_group" : { "name": "${REDPANDA_CLUSTER_RESOURCE_GROUP_NAME}" },
+          "redpanda_resource_group" : { "name": "${REDPANDA_RESOURCE_GROUP_NAME}" },
modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc (1)

60-62: Filename inconsistency: byovnet.auto.tfvars.json vs byoc.auto.tfvars.json.

You introduce the file as byovnet.auto.tfvars.json (Line 60) but the example writes byoc.auto.tfvars.json (Line 78). This will confuse users following copy/paste.

Apply this diff to make the intro match the example:

-Define a JSON file called `byovnet.auto.tfvars.json` inside the Terraform directory that contains information about the VPC.
+Define a JSON file called `byoc.auto.tfvars.json` inside the Terraform directory that contains information about the VPC.

Also applies to: 78-110

🧹 Nitpick comments (3)
modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (1)

452-456: Shell line continuation: stray backslash/spacing may break the command.

The backslash on Line 453 appears to have trailing whitespace. In POSIX shells, a backslash must be the final character on the line.

Apply this diff:

- -H "accept: application/json"\ 
+ -H "accept: application/json" \
modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc (2)

75-110: Code fence language mislabeled.

Block starts with json but contains a bash here‑doc and shell redirection. Prefer bash for accurate rendering.

Apply this diff:

-```json
+```bash
 cat > byoc.auto.tfvars.json <<EOF
 {
   ...
 }
 EOF
-```
+```

420-427: Operation vs resource ID mix‑up in status check.

This example says “using the operation ID” but queries /operations with ${REDPANDA_ID}, which holds the cluster resource_id from creation. Use an OPERATION_ID variable for /operations.

Apply this diff:

-Example using the operation ID returned from your create cluster command:
+Example using the operation ID returned from your create cluster command:
@@
-curl -X GET "https://api.redpanda.com/v1/operations/${REDPANDA_ID}" \
+export OPERATION_ID=<operation-id-from-create-cluster-response>
+curl -X GET "https://api.redpanda.com/v1/operations/${OPERATION_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 b02aef5 and 9d9d006.

📒 Files selected for processing (2)
  • modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc (1 hunks)
  • modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.061Z
Learning: In Redpanda Cloud documentation, BYOVPC and BYOVNet are different product names for different cloud providers: BYOVPC is used for AWS and GCP, while BYOVNet is used for Azure. When documentation sections cover multiple cloud providers, the combined notation "BYOVPC/BYOVNet" is correct and should not be changed to use only one term.
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.
📚 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/aws/vpc-byo-aws.adoc
📚 Learning: 2025-07-21T21:52:17.061Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#361
File: modules/networking/pages/cloud-security-network.adoc:176-179
Timestamp: 2025-07-21T21:52:17.061Z
Learning: In Redpanda Cloud documentation, BYOVPC and BYOVNet are different product names for different cloud providers: BYOVPC is used for AWS and GCP, while BYOVNet is used for Azure. When documentation sections cover multiple cloud providers, the combined notation "BYOVPC/BYOVNet" is correct and should not be changed to use only one term.

Applied to files:

  • modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.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 (2)
modules/get-started/pages/cluster-types/byoc/aws/vpc-byo-aws.adoc (1)

234-235: Approve — Redpanda 25.2 confirmed supported for BYOVPC (confirmed 2025-09-15).

Docs list Redpanda Core 25.2.x as supported for BYOVPC/BYOVNet and release notes reference features requiring 25.2+.

modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc (1)

77-77: Approve: bump to Redpanda 25.2 — GA confirmed (2025-09-15)
Redpanda 25.2 is the documented GA release supported for BYOC/BYOVNet in Redpanda Cloud as of September 15, 2025 (validated against Cloud docs, release notes, and Summer 2025 blog).

@paulohtb6 paulohtb6 merged commit d44aa27 into main Sep 15, 2025
5 checks passed
@paulohtb6 paulohtb6 deleted the db/latest_version branch September 15, 2025 16:23
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.

3 participants