Skip to content

Commit

Permalink
Add references to the Cloud costs page from cdc docs (#19223)
Browse files Browse the repository at this point in the history
  • Loading branch information
kathancox authored Dec 16, 2024
1 parent c777649 commit b672e6b
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 15 deletions.
1 change: 1 addition & 0 deletions src/current/_includes/common/cdc-cloud-costs-link.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If you're using a CockroachDB {{ site.data.products.cloud }} cluster, refer to [Understand CockroachDB Cloud Costs]({% link cockroachcloud/costs.md %}) for detail on how CDC is billed monthly based on usage.
1 change: 1 addition & 0 deletions src/current/_includes/common/define-watched-cdc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The main feature of {% if page.name == "change-data-capture-overview.md" %} CockroachDB CDC {% else %} [CockroachDB CDC]({% link {{site.current_cloud_version}}/change-data-capture-overview.md %}) {% endif %} is the _changefeed_, which targets an allowlist of tables, known as _watched tables_.
32 changes: 18 additions & 14 deletions src/current/cockroachcloud/costs.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This table summarizes key details about how costs are calculated for each plan t
<tr>
<th style="text-align: left"></th>
<th style="text-align: left; white-space: nowrap; vertical-align: top;"><strong>CockroachDB Basic</strong><br><br>Usage-based billing only</th>
<th style="text-align: left; vertical-align: top;"><strong>CockroachDB Standard</strong><br><br>Provisioned compute, usage-based storage, data transfer, backups, and Change Data Capture (CDC)</th>
<th style="text-align: left; vertical-align: top;"><strong>CockroachDB Standard</strong><br><br>Provisioned compute, usage-based storage, data transfer, backups, and Change data capture (CDC)</th>
<th style="text-align: left; vertical-align: top;"><strong>CockroachDB Advanced</strong><br><br>Provisioned compute, storage, and IOPS with usage-based billing for data transfer, backups, and CDC</th>
</tr>
</thead>
Expand All @@ -60,8 +60,8 @@ This table summarizes key details about how costs are calculated for each plan t
<tr>
<td style="text-align: left"><a href="#backups">Backups</a></td>
<td style="text-align: left">Usage-based via Request Units.</td>
<td style="text-align: left">Usage-based.<br><br><a href='/docs/cockroachcloud/managed-backups.html'>Managed Backups</a> storage rates vary per cloud provider, region, and backup frequency.<br><br><a href='/docs/cockroachcloud/take-and-restore-self-managed-backups.html'>Self-Managed Backups</a> fee incurred per GiB transferred to your own object storage.</td>
<td style="text-align: left">Usage-based.<br><br><a href='/docs/cockroachcloud/managed-backups.html'>Managed Backups</a> storage rates vary per cloud provider, region, backup frequency, and whether security add-on is enabled.<br><br><a href='/docs/cockroachcloud/take-and-restore-self-managed-backups.html'>Self-Managed Backups</a> fee incurred per GiB transferred to your own object storage. Rate varies depending on whether security add-on is enabled.</td>
<td style="text-align: left">Usage-based.<br><br><a href='/docs/cockroachcloud/managed-backups.html'>Managed backups</a> storage rates vary per cloud provider, region, and backup frequency.<br><br><a href='/docs/cockroachcloud/take-and-restore-self-managed-backups.html'>Self-managed backups</a> fee incurred per GiB transferred to your own object storage.</td>
<td style="text-align: left">Usage-based.<br><br><a href='/docs/cockroachcloud/managed-backups.html'>Managed backups</a> storage rates vary per cloud provider, region, backup frequency, and whether security add-on is enabled.<br><br><a href='/docs/cockroachcloud/take-and-restore-self-managed-backups.html'>Self-managed backups</a> fee incurred per GiB transferred to your own object storage. Rate varies depending on whether security add-on is enabled.</td>
</tr>
<tr>
<td style="text-align: left"><a href="#data-transfer">Data transfer</a></td>
Expand All @@ -70,7 +70,7 @@ This table summarizes key details about how costs are calculated for each plan t
<td style="text-align: left">Usage-based; rates vary per cloud provider and data transfer type.</td>
</tr>
<tr>
<td style="text-align: left"><a href="#change-data-capture-changefeeds">Change Data Capture</a></td>
<td style="text-align: left"><a href="#change-data-capture-changefeeds">Change data capture</a></td>
<td style="text-align: left">Usage-based via Request Units.</td>
<td style="text-align: left">Usage-based, per GiB-hour watched across all changefeeds.</td>
<td style="text-align: left">Usage-based, per GiB-hour watched across all changefeeds. Rates vary depending on whether security add-on is enabled.</td>
Expand Down Expand Up @@ -187,19 +187,19 @@ Backups on Basic clusters are included in the Request Unit costs. Managed backup

<section class="filter-content" markdown="1" data-scope="standard">

[Managed Backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, and backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily). The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher.
[Managed backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, and backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily). The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher.

[Self-Managed Backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. This option provides an advanced backup scheduler and additional control over backup storage placement.
[Self-managed backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. This option provides an advanced backup scheduler and additional control over backup storage placement.

For further details, refer to CockroachDB Cloud [Pricing](https://www.cockroachlabs.com/pricing/new/).

</section>

<section class="filter-content" markdown="1" data-scope="advanced">

[Managed Backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily), and whether the Advanced security add-on is enabled. The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher.
[Managed backups]({% link cockroachcloud/managed-backups.md %}) are charged per-GiB storage rates that vary per cloud provider, region, backup [frequency]({% link cockroachcloud/managed-backups.md %}#frequency) (daily vs. more than daily), and whether the Advanced security add-on is enabled. The per-GiB unit prices are tiered, based on the amount of backup data stored: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 500 GiB-Month, 500 to 1000 GiB-Month, or 1000 GiB-Month and higher.

[Self-Managed Backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. The rate varies depending on whether the Advanced security add-on is enabled. Self-Managed Backups offer additional control over backup storage placement, and an advanced backup scheduler.
[Self-managed backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) to your own object storage are charged a per-GiB fee for the data transferred. The rate varies depending on whether the Advanced security add-on is enabled. Self-managed backups offer additional control over backup storage placement, and an advanced backup scheduler.

For further details, refer to CockroachDB Cloud [Pricing](https://www.cockroachlabs.com/pricing/new/).
</section>
Expand Down Expand Up @@ -232,7 +232,7 @@ Cross-region data transfer includes:
- CockroachDB replication across nodes that are in different regions.
- Data egress from the CockroachDB Cloud cluster via supported [private connectivity]({% link cockroachcloud/connect-to-your-cluster.md %}#establish-private-connectivity) services to a private endpoint in another region.
- [Managed backup]({% link cockroachcloud/backup-and-restore-overview.md %}#managed-backups) and [Self-managed backup]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) data transfer to another region.
- Change Data Capture (changefeed) data transfer to another region.
- Change data capture (changefeed) data transfer to another region.

Customers are charged the cloud service provider’s (CSP) list price for metered cross-region data transfer.

Expand Down Expand Up @@ -266,7 +266,7 @@ Cross-region data transfer includes:
- CockroachDB replication across nodes that are in different regions.
- Data egress from the CockroachDB Cloud cluster via supported [private connectivity]({% link cockroachcloud/connect-to-your-cluster.md %}#establish-private-connectivity) services to a private endpoint in another region.
- [Managed backup]({% link cockroachcloud/backup-and-restore-overview.md %}#managed-backups) and [Self-managed backup]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) data transfer to another region.
- Change Data Capture (changefeed) data transfer to another region.
- Change data capture (changefeed) data transfer to another region.

Customers are charged the cloud service provider’s (CSP) list price for metered cross-region data transfer.

Expand All @@ -278,9 +278,9 @@ This is the usage for any data leaving CockroachDB such as SQL data being sent t

</section>

### Change Data Capture (Changefeeds)
### Change data capture (changefeeds)

For Change Data Capture (CDC), all CockroachDB {{ site.data.products.cloud }} clusters can use [Enterprise Changefeeds]({% link {{ site.current_cloud_version}}/how-does-an-enterprise-changefeed-work.md %}).
For change data capture (CDC), all CockroachDB {{ site.data.products.cloud }} clusters can use [Enterprise changefeeds]({% link {{ site.current_cloud_version}}/how-does-an-enterprise-changefeed-work.md %}).

<section class="filter-content" markdown="1" data-scope="basic">

Expand All @@ -289,13 +289,17 @@ In CockroachDB {{ site.data.products.basic }}, CDC cost is usage-based via Reque

<section class="filter-content" markdown="1" data-scope="standard">

In CockroachDB {{ site.data.products.standard }}, CDC is billed monthly based on usage, determined by the total GiB-Month watched across all of a cluster’s changefeeds. The per-GiB unit price is tiered, based on the total watched: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher.
{% include common/define-watched-cdc.md %}

In CockroachDB {{ site.data.products.standard }}, CDC is billed monthly based on the total size in GiB-Month of all of a cluster's watched tables. The per-GiB unit price is tiered, based on the size of watched data: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher.

</section>

<section class="filter-content" markdown="1" data-scope="advanced">

In CockroachDB {{ site.data.products.advanced }}, CDC is billed monthly based on usage, determined by the total GiB-Month watched across all of a cluster’s changefeeds and whether the Advanced security add-on is enabled. The per-GiB unit price is tiered, based on the total watched: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher.
{% include common/define-watched-cdc.md %}

In CockroachDB {{ site.data.products.advanced }}, CDC is billed monthly based on the total size of a cluster's watched tables and whether the {{ site.data.products.advanced }} security add-on is enabled. The per-GiB unit price is tiered, based on the size of watched data: Less than 5 GiB-Month, 5 to 100 GiB-Month, 100 to 250 GiB-Month, 250 to 500 GiB-Month, or 500 GiB-Month and higher.

</section>

Expand Down
1 change: 1 addition & 0 deletions src/current/v23.2/create-and-configure-changefeeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This page describes:
1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions.
1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table.
1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds](#system-resources-and-running-changefeeds) and [Recommendations for the number of target tables](#recommendations-for-the-number-of-target-tables).
- {% include common/cdc-cloud-costs-link.md %}
1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data.
1. Read the [Considerations](#considerations) section that provides information on changefeed interactions that could affect how you configure or run your changefeed.

Expand Down
1 change: 1 addition & 0 deletions src/current/v24.1/create-and-configure-changefeeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This page describes:
1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions.
1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table.
1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds](#system-resources-and-running-changefeeds) and [Recommendations for the number of target tables](#recommendations-for-the-number-of-target-tables).
- {% include common/cdc-cloud-costs-link.md %}
1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data.
1. Read the [Considerations](#considerations) section that provides information on changefeed interactions that could affect how you configure or run your changefeed.

Expand Down
1 change: 1 addition & 0 deletions src/current/v24.2/create-and-configure-changefeeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This page describes:
1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions.
1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table.
1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds](#system-resources-and-running-changefeeds) and [Recommendations for the number of target tables](#recommendations-for-the-number-of-target-tables).
- {% include common/cdc-cloud-costs-link.md %}
1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data.
1. Read the [Considerations](#considerations) section that provides information on changefeed interactions that could affect how you configure or run your changefeed.

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.3/change-data-capture-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For example, you might want to:
- Export a snaphot of tables to backfill new applications.
- Send updates to data stores for machine learning models.

The main feature of CockroachDB CDC is the _changefeed_, which targets an allowlist of tables, or "watched tables".
{% include common/define-watched-cdc.md %}

## Stream row-level changes with changefeeds

Expand Down
4 changes: 4 additions & 0 deletions src/current/v24.3/changefeed-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ toc: true

This page describes best practices to consider when starting changefeeds on a CockroachDB cluster. We recommend referring to this information while planning your cluster's changefeeds and following the links in each of the sections for more details on a topic.

{{site.data.alerts.callout_info}}
To help in planning your cluster's changefeeds on CockroachDB {{ site.data.products.cloud }} clusters, refer to the [Understand CockroachDB Cloud Costs]({% link cockroachcloud/costs.md %}) page for detail on how CDC is billed monthly based on usage.
{{site.data.alerts.end}}

## Plan the number of watched tables for a single changefeed

When creating a changefeed, it's important to consider the number of changefeeds versus the number of tables to include in a single changefeed:
Expand Down
1 change: 1 addition & 0 deletions src/current/v24.3/create-and-configure-changefeeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This page describes:
1. Enable rangefeeds on CockroachDB {{ site.data.products.advanced }} and CockroachDB {{ site.data.products.core }}. Refer to [Enable rangefeeds](#enable-rangefeeds) for instructions.
1. Decide on whether you will run an {{ site.data.products.enterprise }} or basic changefeed. Refer to the [Overview]({% link {{ page.version.version }}/change-data-capture-overview.md %}) page for a comparative capability table.
1. Plan the number of changefeeds versus the number of tables to include in a single changefeed for your cluster. {% include {{ page.version.version }}/cdc/changefeed-number-limit.md %} Refer to [System resources and running changefeeds]({% link {{ page.version.version }}/changefeed-best-practices.md %}#maintain-system-resources-and-running-changefeeds) and [Recommendations for the number of target tables]({% link {{ page.version.version }}/changefeed-best-practices.md %}#plan-the-number-of-watched-tables-for-a-single-changefeed).
- {% include common/cdc-cloud-costs-link.md %}
1. Consider whether your {{ site.data.products.enterprise }} [changefeed use case](#create) would be better served by [change data capture queries]({% link {{ page.version.version }}/cdc-queries.md %}) that can filter data on a single table. CDC queries can improve the efficiency of changefeeds because the job will not need to encode as much change data.
1. Read the following:
- The [Changefeed Best Practices]({% link {{ page.version.version }}/changefeed-best-practices.md %}) reference for details on planning changefeeds, monitoring basics, and schema changes.
Expand Down

0 comments on commit b672e6b

Please sign in to comment.