DOC-893 Document feature UBB-BYOC #350
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 📝 WalkthroughWalkthroughThe changes reorganize and expand the billing documentation for Redpanda Cloud. The navigation structure under the "Billing" section is restructured into hierarchical categories: Serverless, BYOC, Dedicated, and Redpanda Connect, each with their own subpages. New documentation pages are added for BYOC, Dedicated, and Redpanda Connect usage metrics, detailing how billing is calculated for each offering. The Serverless billing document is refocused to cover only Serverless usage metrics. Additional minor clarifications are made in the cloud overview documentation regarding BYOC and Dedicated sign-up processes. Sequence Diagram(s)sequenceDiagram
participant User
participant DocsNav
participant BillingSection
User->>DocsNav: Open Billing Documentation
DocsNav->>BillingSection: Display categories (Serverless, BYOC, Dedicated, Redpanda Connect)
User->>BillingSection: Select category (e.g., BYOC)
BillingSection->>User: Show relevant billing metrics and info page
Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
* DOC-1497 update Customer-managed to BYOVPC * minor edit
* DOC-1478 update consumer group lag in Cloud * Clarified/simplified wording in prereqs * minor edit
* DOC-1507. Add Azure CLI and Subscription * copyedit and coderabbit suggestions * add `az login` step * remove coderabbit suggestions --------- Co-authored-by: micheleRP <[email protected]>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (8)
modules/billing/pages/byoc/index.adoc (1)
1-3: Add a short intro or redirect to improve discoverabilityThis index currently contains only metadata. Readers landing here see a blank page. Add one-sentence context and a link to the detailed metrics page (
byoc-billing.adoc) so the section isn’t an empty stub.:page-layout: index + +Learn what metrics drive Bring Your Own Cloud (BYOC) charges and how to estimate your bill. +See xref:billing:byoc/byoc-billing.adoc[BYOC usage metrics] for the full breakdown.modules/billing/pages/serverless/index.adoc (1)
1-3: Provide minimal landing-page copySame concern as the BYOC index: an empty body looks broken in the UI. Add a one-liner and a pointer to the metrics page to keep the navigation experience consistent.
modules/billing/pages/dedicated/index.adoc (1)
1-3: Populate the Dedicated billing indexConsider adding a brief description and link to
dedicated-billing.adocso users aren’t greeted by a blank screen.modules/billing/pages/billing.adoc (1)
19-34: Minor clarity nit – units columnThe metrics table omits a units column, so readers must infer (GB, hours, etc.) from descriptions. Adding an explicit Units column improves scannability.
modules/ROOT/nav.adoc (1)
447-450: Avoid duplicating Marketplace pages under multiple sub-sections
aws-pay-as-you-go.adocand the various*-commit.adocpages are already listed under Serverless.
Listing them again under Dedicated creates duplicate TOC entries that render as separate nodes in the sidebar and makes maintenance harder when the target filenames change.If you want a single physical page to appear in multiple logical places, prefer an xref alias page or a short index page that links back rather than inserting the identical file twice.
*** xref:billing:aws-pay-as-you-go.adoc[AWS: Use Pay As You Go] *** xref:billing:aws-commit.adoc[AWS: Use Commits] *** xref:billing:azure-commit.adoc[Azure: Use Commits] *** xref:billing:gcp-commit.adoc[GCP: Use Commits]Replace with a short
index.adocunderbilling/dedicated/that links to the marketplace pages, or omit entirely and rely on Serverless links.modules/get-started/pages/cloud-overview.adoc (1)
61-63: Minor style tweak increases clarityThe phrase “With a usage-based billing commitment, you sign up for a minimum spend amount.” can be mis-read as two commitments.
Consider making the dependency explicit:-With a usage-based billing commitment, you sign up for a minimum spend amount. +Usage-based billing requires committing to a minimum monthly spend.modules/billing/pages/dedicated/dedicated-billing.adoc (1)
31-34: Glossary macro contains spaces
glossterm:Tiered Storage[]will not resolve. Use the kebab-case anchor liketiered-storage.-Replication to object storage is implemented with glossterm:Tiered Storage[]. +Replication to object storage is implemented with glossterm:tiered-storage[].Run a quick link check to catch any other glossary IDs with spaces.
modules/billing/pages/byoc/byoc-billing.adoc (1)
31-34: Glossary macro contains spacesSame issue as in the Dedicated metrics page—
Tiered Storageshould use a kebab-case glossary ID.-Replication to object storage is implemented with glossterm:Tiered Storage[]. +Replication to object storage is implemented with glossterm:tiered-storage[].
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
modules/ROOT/nav.adoc(1 hunks)modules/billing/pages/billing.adoc(2 hunks)modules/billing/pages/byoc/byoc-billing.adoc(1 hunks)modules/billing/pages/byoc/index.adoc(1 hunks)modules/billing/pages/dedicated/dedicated-billing.adoc(1 hunks)modules/billing/pages/dedicated/index.adoc(1 hunks)modules/billing/pages/rpcn-billing.adoc(1 hunks)modules/billing/pages/serverless/index.adoc(1 hunks)modules/get-started/pages/cloud-overview.adoc(2 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
modules/billing/pages/billing.adoc (2)
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
modules/billing/pages/rpcn-billing.adoc (1)
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
modules/get-started/pages/cloud-overview.adoc (3)
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#334
File: modules/networking/partials/psc-api2.adoc:15-16
Timestamp: 2025-06-18T21:02:38.074Z
Learning: In the Redpanda Cloud documentation system, cross-reference anchors using the format `#patch-/v1/clusters/-cluster.id-` work correctly for referencing API endpoints, even with dashes instead of curly braces around parameter names.
🔇 Additional comments (2)
modules/billing/pages/billing.adoc (1)
37-37: Serverless limits cross-reference is validThe file
modules/get-started/pages/cluster-types/serverless.adocdefines the heading:== Serverless usage limits
which automatically generates the
#serverless-usage-limitsanchor. Therefore your existing link:xref:get-started:cluster-types/serverless.adoc#serverless-usage-limits[Serverless limits]
will resolve correctly and does not need adjustment.
modules/billing/pages/rpcn-billing.adoc (1)
15-16: Resource-management.adoc xref path validated
- The file
modules/develop/pages/connect/configuration/resource-management.adocexists.- It contains the “Understanding compute units” section and multiple references to “compute units,” so the link target is present.
The xref will resolve correctly; no changes are needed.
| == Iceberg metrics | ||
|
|
||
| Pricing per pipeline depends on: | ||
|
|
||
| - | ||
| - | ||
|
|
||
| |=== | ||
| | Metric | Description | ||
|
|
||
| | ? | ? | ||
|
|
||
| |=== |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Unfinished placeholder block for Iceberg metrics
The table is currently empty, which renders as a malformed table in HTML and PDF outputs.
Either remove the section until it is ready or fill in the metric rows before publishing.
🤖 Prompt for AI Agents
In modules/billing/pages/byoc/byoc-billing.adoc between lines 37 and 49, the
Iceberg metrics section contains an empty table with placeholders, causing
malformed HTML and PDF output. To fix this, either remove the entire Iceberg
metrics section until the content is ready or populate the table with actual
metric names and descriptions to ensure proper rendering.
…age (#357) * Update terraform-provider.adoc * Update modules/manage/pages/terraform-provider.adoc Co-authored-by: Paulo Borges <[email protected]> * add fix --------- Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Paulo Borges <[email protected]>
| * All pricing is set in US dollars (USD). | ||
| * All billing computations are conducted in Coordinated Universal Time (UTC). Billing accrues at hourly intervals. Any usage that is less than an hour is billed for the full hour. | ||
|
|
||
| NOTE: Pricing information is available on https://www.redpanda.com/price-estimator[redpanda.com^]. For questions about billing, contact [email protected]. |
There was a problem hiding this comment.
The user experience for BYOC on this destination page is a bit frustrating--go to this calculator, then, sorry, there is no calculator for you. Why send those users there? Have you considered a note that explains the calculator is not available for BYOC customers? Would save them the frustration. @deniscoady
|
|
||
| == BYOC metrics | ||
|
|
||
| Pricing for BYOC clusters depends on the time the instance is up, the data in, data out, and data stored. |
There was a problem hiding this comment.
Why not just call data in and data out "ingress" and "egress", as they appear below? Same for Uptime?
| Pricing for BYOC clusters depends on the time the instance is up, the data in, data out, and data stored. | ||
|
|
||
| |=== | ||
| | Metric | Description |
There was a problem hiding this comment.
I'm finding this BYOC billing metrics guidance a bit frustrating, and am wondering if our users will too.
- The calculator does not work for them
- This table generally describes that ingress/egress/uptime are all billed. But beyond that, there are no specifics that help customers to better understand just how they are billed. For example, where can they find the rate $$ or AZ cost variances (there's no visibility into how they vary by region). More of a question for PM I guess. @deniscoady
|
|
||
| All Kafka protocol responses generated by the cluster (_including_ message headers) are counted as egress as soon as the cluster processes the request, even if the client drops the connection before they are delivered. | ||
|
|
||
| The cost varies based on the number of availability zones (AZ) you select for your cluster. |
There was a problem hiding this comment.
Is there a way for users to see how this cost varies by AZ? Does it show in the UI?
| |=== | ||
| | Metric | Description | ||
|
|
||
| | ? | ? |
There was a problem hiding this comment.
Looks like this is not finished
| * All pricing is set in US dollars (USD). | ||
| * All billing computations are conducted in Coordinated Universal Time (UTC). Billing accrues at hourly intervals. Any usage that is less than an hour is billed for the full hour. | ||
|
|
||
| NOTE: Pricing information is available on https://www.redpanda.com/price-estimator[redpanda.com^]. For questions about billing, contact [email protected]. |
There was a problem hiding this comment.
I don't see any option to select Dedicated on the destination page. If users cannot find that on the page, why would we send them there?
* DOC-1511 add south-north port * minor edit * update quick reference table * apply suggestion
* DOC-1168 Private Link for Azure in UI # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc * coderabbit suggestions * rename file to include azure for better search * remove LA from Azure Private Link * update What's New * remove section to enable on existing cluster * edits from UI fix * incorporate review feedback * left-align screenshot in Access section
* mTLS+SASL support on AWS * Apply suggestions from automated review * Rework authentication method bullet points * Missing placeholder value * Minor edit * Minor edit per review * Apply suggestions from code review Co-authored-by: Joyce Fee <[email protected]> --------- Co-authored-by: Joyce Fee <[email protected]>
* DOC-241 doc all possible cluster states * incorporate review feedback * edits * typo * combine BYOC/Dedicated tab * remove the Unspecified state * reorder rows * Update modules/manage/pages/cluster-maintenance/cluster-state.adoc Co-authored-by: Santiago Jimenez Giraldo <[email protected]> * incorporate Santi's feedback * minor edit, putting suspended last * Add cc to turn Suspended back to Ready state * Santi's feedback for failed state * Update modules/manage/pages/cluster-maintenance/cluster-state.adoc Co-authored-by: Paulo Borges <[email protected]> * Update modules/manage/pages/cluster-maintenance/cluster-state.adoc Co-authored-by: Paulo Borges <[email protected]> * put all cluster states in bold font * minor edits --------- Co-authored-by: Santiago Jimenez Giraldo <[email protected]> Co-authored-by: Paulo Borges <[email protected]>
|
|
||
| |=== | ||
|
|
||
| == Iceberg metrics |
There was a problem hiding this comment.
We track ingress to iceberg topics separately from normal traffic.
* fix table * add |
…da-data/cloud-docs into DOC-893-Document-feature-UBB-BYOC
|
What's the latest status on this one @micheleRP ? |
it's on hold |
Description
This pull request reorganizes billing-related content into distinct sections for Serverless, BYOC, Dedicated, and Redpanda Connect usage metrics, while also refining descriptions and adding clarity to the billing process. Below are the key changes grouped by theme:
BYOC Billing:
modules/billing/pages/byoc/byoc-billing.adocdetailing BYOC usage metrics, including uptime, ingress, egress, and storage.modules/billing/pages/byoc/index.adocto introduce BYOC billing and guide users on getting started.Navigation and Structure Updates:
modules/ROOT/nav.adocto include new subsections for Serverless, BYOC, Dedicated, and Redpanda Connect billing, providing a clearer hierarchy for billing documentation.Serverless Billing:
modules/billing/pages/billing.adocfrom "Usage Metrics" to "Serverless Usage Metrics" to align with the new structure.modules/billing/pages/billing.adocand added a reference to Serverless limits, streamlining the content to focus solely on Serverless billing.Dedicated Billing:
modules/billing/pages/dedicated/dedicated-billing.adocdetailing Dedicated cluster metrics, similar to BYOC metrics.modules/billing/pages/dedicated/index.adocto introduce Dedicated billing and guide users on getting started.Redpanda Connect Billing:
modules/billing/pages/rpcn-billing.adocdetailing Redpanda Connect pipeline metrics, including compute unit usage.General Refinements:
modules/get-started/pages/cloud-overview.adocto clarify BYOC and Dedicated billing processes, including annual committed use and marketplace integration. [1] [2]Resolves https://redpandadata.atlassian.net/browse/DOC-893
Review deadline: July 25, if Aug 1 GA
Page previews
Billing
Checks