From 28549d0f22fe9b7a61d6051fbd852f2b5af310a6 Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 11:53:17 -0700 Subject: [PATCH 01/10] capitalization --- modules/apis/pages/index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/apis/pages/index.adoc b/modules/apis/pages/index.adoc index 15f00a2..d515eca 100644 --- a/modules/apis/pages/index.adoc +++ b/modules/apis/pages/index.adoc @@ -6,7 +6,7 @@ You use two APIs to manage {pulsar-reg} tenants and their resources. == {product} {devops-api} -Use the xref:astra-streaming:apis:attachment$devops.html[{product} {devops-api}] to manage higher-level {product} objects associated with your {astra-db} organization, such as the change data capture (CDC) settings, {pulsar-short} tenants, geo-replications, {pulsar-short} stats, and {pulsar-short} tokens. +Use the xref:astra-streaming:apis:attachment$devops.html[{product} {devops-api}] to manage higher-level {product} objects associated with your {astra-db} organization, such as the Change Data Capture (CDC) settings, {pulsar-short} tenants, geo-replications, {pulsar-short} stats, and {pulsar-short} tokens. This API uses an {astra-db} application token for authentication. From 370823215609efe8d8bf2f40bed37a701f563c49 Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 12:26:25 -0700 Subject: [PATCH 02/10] replace cdc content with docs-common --- modules/developing/nav.adoc | 3 +-- modules/developing/pages/astream-cdc.adoc | 17 ++++------------- modules/operations/nav.adoc | 1 + 3 files changed, 6 insertions(+), 15 deletions(-) diff --git a/modules/developing/nav.adoc b/modules/developing/nav.adoc index 05dd2e2..a6ab320 100644 --- a/modules/developing/nav.adoc +++ b/modules/developing/nav.adoc @@ -20,7 +20,6 @@ *** xref:ROOT:astream-subscriptions-shared.adoc[] *** xref:ROOT:astream-subscriptions-failover.adoc[] *** xref:ROOT:astream-subscriptions-keyshared.adoc[] -* xref:gpt-schema-translator.adoc[] -* xref:astra-cli.adoc[] * xref:astream-cdc.adoc[] +* xref:gpt-schema-translator.adoc[] * xref:streaming-learning:pulsar-io:connectors/index.adoc[IO connectors] \ No newline at end of file diff --git a/modules/developing/pages/astream-cdc.adoc b/modules/developing/pages/astream-cdc.adoc index 3b3aa4a..518042f 100644 --- a/modules/developing/pages/astream-cdc.adoc +++ b/modules/developing/pages/astream-cdc.adoc @@ -1,14 +1,5 @@ -= Create a Change Data Capture (CDC) connector -:description: CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data += Enable Change Data Capture for {astra-db} +:navtitle: Enable Change Data Capture (CDC) +:description: CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data to {product}. -[IMPORTANT] -==== -Enabling CDC for {astra-db} databases incurs billed charges based on your {product} usage. -See https://www.datastax.com/pricing/astra-streaming[{product} pricing] and https://www.datastax.com/products/datastax-astra/cdc-for-astra-db[CDC metering rates]. -==== - -CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data into {product} where it can be processed by client applications or sent to downstream systems. - -{product} processes data changes via an {pulsar-reg} topic. By design, the Change Data Capture (CDC) component is simple, with a 1:1 correspondence between the table and a single {pulsar-short} topic. - -For instructions and more information about CDC for {astra-db}, see xref:astra-db-serverless:databases:change-data-capture.adoc[]. +include::common:streaming:partial$cdc/cdc-for-astra-db.adoc[] \ No newline at end of file diff --git a/modules/operations/nav.adoc b/modules/operations/nav.adoc index b1748e4..56c3c45 100644 --- a/modules/operations/nav.adoc +++ b/modules/operations/nav.adoc @@ -3,6 +3,7 @@ * xref:operations:astream-pricing.adoc[] * xref:operations:astream-regions.adoc[] * xref:operations:astream-georeplication.adoc[] +* xref:astra-cli.adoc[] * Monitor streaming tenants ** xref:operations:monitoring/index.adoc[] ** xref:operations:astream-scrape-metrics.adoc[] From a1298d270914326bbc4cff29aaf568576ef77282 Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 12:54:24 -0700 Subject: [PATCH 03/10] add attribute to pass build --- local-preview-playbook.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/local-preview-playbook.yml b/local-preview-playbook.yml index f1426a8..00ae651 100644 --- a/local-preview-playbook.yml +++ b/local-preview-playbook.yml @@ -56,6 +56,7 @@ asciidoc: company: 'DataStax' astra_db: 'Astra DB' astra_stream: 'Astra Streaming' + astra-stream: 'Astra Streaming' astra_ui: 'Astra Portal' astra_cli: 'Astra CLI' astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master' From 52331523d147b0dfb4e676d4f82eb0cd67f6a4fb Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 12:57:18 -0700 Subject: [PATCH 04/10] Revert "add attribute to pass build" This reverts commit a1298d270914326bbc4cff29aaf568576ef77282. --- local-preview-playbook.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/local-preview-playbook.yml b/local-preview-playbook.yml index 00ae651..f1426a8 100644 --- a/local-preview-playbook.yml +++ b/local-preview-playbook.yml @@ -56,7 +56,6 @@ asciidoc: company: 'DataStax' astra_db: 'Astra DB' astra_stream: 'Astra Streaming' - astra-stream: 'Astra Streaming' astra_ui: 'Astra Portal' astra_cli: 'Astra CLI' astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master' From 9e35bdc42ea93ee5929c5156346a666145cc9465 Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 13:31:35 -0700 Subject: [PATCH 05/10] fix link --- modules/operations/nav.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/operations/nav.adoc b/modules/operations/nav.adoc index 56c3c45..b11f26b 100644 --- a/modules/operations/nav.adoc +++ b/modules/operations/nav.adoc @@ -3,7 +3,7 @@ * xref:operations:astream-pricing.adoc[] * xref:operations:astream-regions.adoc[] * xref:operations:astream-georeplication.adoc[] -* xref:astra-cli.adoc[] +* xref:developing:astra-cli.adoc[] * Monitor streaming tenants ** xref:operations:monitoring/index.adoc[] ** xref:operations:astream-scrape-metrics.adoc[] From d4b46ad706e137e037ce42370093124b0e40ca5b Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 14:19:17 -0700 Subject: [PATCH 06/10] add attribute --- antora.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/antora.yml b/antora.yml index f598e6c..de826d2 100644 --- a/antora.yml +++ b/antora.yml @@ -20,6 +20,7 @@ asciidoc: astra-ui: 'Astra Portal' astra-url: 'https://astra.datastax.com' astra-ui-link: '{astra-url}[{astra-ui}^]' + db-serverless-vector: 'Serverless (Vector)' devops-api: 'DevOps API' cass: 'Apache Cassandra' cass-reg: 'Apache Cassandra(R)' From 29f46882dd0aea28e62c5f68e1e5e6953f787e40 Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 14:33:37 -0700 Subject: [PATCH 07/10] small typos --- modules/developing/pages/produce-consume-pulsar-client.adoc | 2 +- modules/developing/pages/using-curl.adoc | 2 +- modules/getting-started/pages/index.adoc | 2 +- modules/operations/pages/monitoring/index.adoc | 2 +- modules/operations/pages/private-connectivity.adoc | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/developing/pages/produce-consume-pulsar-client.adoc b/modules/developing/pages/produce-consume-pulsar-client.adoc index 7c729db..d8462b2 100644 --- a/modules/developing/pages/produce-consume-pulsar-client.adoc +++ b/modules/developing/pages/produce-consume-pulsar-client.adoc @@ -4,7 +4,7 @@ You can use the `pulsar-client` CLI to produce and consume messages in your {product} tenants. -. xref:getting-started:index.adoc[Create a {product} tenant.] +. xref:getting-started:index.adoc[Create an {product} tenant.] . xref:developing:configure-pulsar-env.adoc[Configure {pulsar-reg} binaries for {product}.] diff --git a/modules/developing/pages/using-curl.adoc b/modules/developing/pages/using-curl.adoc index cc95d74..088d87b 100644 --- a/modules/developing/pages/using-curl.adoc +++ b/modules/developing/pages/using-curl.adoc @@ -29,7 +29,7 @@ Web Service URLs start with `http`. Broker Service URLs start with `pulsar(+ssl)`. ==== -== Create a {product} {pulsar-short} token +== Create an {product} {pulsar-short} token [IMPORTANT] ==== diff --git a/modules/getting-started/pages/index.adoc b/modules/getting-started/pages/index.adoc index 461362f..80db8c9 100644 --- a/modules/getting-started/pages/index.adoc +++ b/modules/getting-started/pages/index.adoc @@ -13,7 +13,7 @@ This quickstart demonstrates how to create and use a streaming tenant running {p == Create a streaming tenant -A {product} tenant is a portion of {company}-managed {pulsar} that is only yours. +An {product} tenant is a portion of {company}-managed {pulsar} that is only yours. Within tenants, you create namespaces, topics, functions, and more. To learn more about the concept of tenancy, see the https://pulsar.apache.org/docs/concepts-multi-tenancy/[{pulsar-short} documentation]. diff --git a/modules/operations/pages/monitoring/index.adoc b/modules/operations/pages/monitoring/index.adoc index 6da05d0..9980b23 100644 --- a/modules/operations/pages/monitoring/index.adoc +++ b/modules/operations/pages/monitoring/index.adoc @@ -84,7 +84,7 @@ Do _not_ aggregate metrics on shared clusters because one cluster can be shared For more information, see xref:astream-limits.adoc[] and xref:operations:astream-pricing.adoc[]. ==== -Each externally exposed raw {product} metric is reported at a very low level, at each individual server instance (the `exported_instance` label) and each topic partition (the `topic` label). The same raw metrics could come from multiple server instances. From a {product} user's perspective, the direct monitoring of raw metrics is not really useful. Raw metrics need to be aggregated first - for example, by averaging or summing the raw metrics over a period of time. +Each externally exposed raw {product} metric is reported at a very low level, at each individual server instance (the `exported_instance` label) and each topic partition (the `topic` label). The same raw metrics could come from multiple server instances. From an {product} user's perspective, the direct monitoring of raw metrics is not really useful. Raw metrics need to be aggregated first - for example, by averaging or summing the raw metrics over a period of time. The following example shows some raw metrics for a {pulsar-short} message backlog (`pulsar_msg_backlog`) scraped from an {product} cluster in the Google Cloud `us-central1` region: diff --git a/modules/operations/pages/private-connectivity.adoc b/modules/operations/pages/private-connectivity.adoc index cc8b1c8..650a2a0 100644 --- a/modules/operations/pages/private-connectivity.adoc +++ b/modules/operations/pages/private-connectivity.adoc @@ -47,7 +47,7 @@ The private link service pattern is the same across cloud providers, but the hos On a case-by-case basis, {product} can support private outbound traffic flowing from {product} to your private endpoint. The outbound traffic pattern creates a private endpoint in {product} that connects to your private link service. -{company} opens a port on the tenant's firewall to allow connectors and functions running in a dedicated namespace on a {product} cluster to connect to your private network. +{company} opens a port on the tenant's firewall to allow connectors and functions running in a dedicated namespace on an {product} cluster to connect to your private network. Each tenant has its own firewall. [#credentials] From fec373f2472faec855e8a0c9d239dcf52e57b702 Mon Sep 17 00:00:00 2001 From: April M Date: Tue, 8 Apr 2025 15:24:15 -0700 Subject: [PATCH 08/10] regions --- modules/operations/pages/astream-regions.adoc | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/modules/operations/pages/astream-regions.adoc b/modules/operations/pages/astream-regions.adoc index 64da2bf..46daaf0 100644 --- a/modules/operations/pages/astream-regions.adoc +++ b/modules/operations/pages/astream-regions.adoc @@ -22,6 +22,9 @@ ElasticSearch and Snowflake can be in different regions than {product}. |`ap-southeast-1` |Singapore +// |`ap-southeast-2` +// |Sydney + |`eu-central-1` |Frankfurt @@ -67,18 +70,21 @@ ElasticSearch and Snowflake can be in different regions than {product}. |Region |Location |`australia-southeast1` -|Sydney, Australia +|Sydney |`europe-west1` -|St. Ghislain, Belgium +|Belgium + +// |`europe-west3` +// |Frankfurt |`us-central1` -|Council Bluffs, Iowa +|Iowa |`us-east1` -|Moncks Corner, South Carolina +|South Carolina |`us-east4` -|Ashburn, Virginia +|Virginia |=== \ No newline at end of file From 9997c581bac0399ce3c3e96d0c4defe26a660ec5 Mon Sep 17 00:00:00 2001 From: April M Date: Wed, 9 Apr 2025 06:49:16 -0700 Subject: [PATCH 09/10] region list touchups --- modules/operations/pages/astream-regions.adoc | 66 ++++++++++--------- 1 file changed, 35 insertions(+), 31 deletions(-) diff --git a/modules/operations/pages/astream-regions.adoc b/modules/operations/pages/astream-regions.adoc index 46daaf0..cbb38a0 100644 --- a/modules/operations/pages/astream-regions.adoc +++ b/modules/operations/pages/astream-regions.adoc @@ -1,16 +1,16 @@ = {product} regions :page-tag: astra-streaming,admin,manage,pulsar +:description: {product} is available in specific AWS, Microsoft Azure, and Google Cloud regions. -When you create a tenant, you must choose a region for your tenant. -{product} supports AWS, Microsoft Azure, and Google Cloud regions. -For optimal performance, choose a region that is geographically close to your users. +{product} is available in a subset of the xref:astra-db-serverless:databases:regions.adoc[{astra-db} regions], including AWS, Microsoft Azure, and Google Cloud regions. -These regions also support CDC for {astra-db}. -You can only use xref:developing:astream-cdc.adoc[CDC for {astra-db}] in regions that support both {product} and {astra-db}. +{astra-stream} tenants are regionally isolated. +The region you select when you create a tenant determines which databases that tenant can support. +For example, to enable xref:developing:astream-cdc.adoc[CDC for {astra-db}], your tenant must be in the same region as the relevant database. -ElasticSearch and Snowflake can be in different regions than {product}. +Your ElasticSearch and Snowflake deployments can be in different regions than your {product} tenants. -== AWS +== AWS regions for {product} [cols="1,1"] |=== @@ -41,29 +41,7 @@ ElasticSearch and Snowflake can be in different regions than {product}. |Oregon |=== -== Microsoft Azure - -[cols="1,1"] -|=== -|Region |Location - -|`australiaeast` -|New South Wales - -|`eastus` -|Virginia - -// |`eastus2` -// |Virginia - -|`westeurope` -|Netherlands - -|`westus2` -|Washington -|=== - -== Google Cloud +== Google Cloud regions for {product} [cols="1,1"] |=== @@ -87,4 +65,30 @@ ElasticSearch and Snowflake can be in different regions than {product}. |`us-east4` |Virginia -|=== \ No newline at end of file +|=== + +== Microsoft Azure regions for {product} + +[cols="1,1"] +|=== +|Region |Location + +|`australiaeast` +|New South Wales + +|`eastus` +|Virginia + +// |`eastus2` +// |Virginia + +|`westeurope` +|Netherlands + +|`westus2` +|Washington +|=== + +== Request a region + +If your preferred region isn't available, contact your {company} account representative or {support_url}[{company} Support]. \ No newline at end of file From b2e7effe4d662643d001bda71610215b5a2c07e6 Mon Sep 17 00:00:00 2001 From: April M Date: Fri, 11 Apr 2025 08:41:00 -0700 Subject: [PATCH 10/10] devops-api-ref-url attribute --- antora.yml | 1 + modules/operations/pages/monitoring/stream-audit-logs.adoc | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/antora.yml b/antora.yml index de826d2..d721fb5 100644 --- a/antora.yml +++ b/antora.yml @@ -22,6 +22,7 @@ asciidoc: astra-ui-link: '{astra-url}[{astra-ui}^]' db-serverless-vector: 'Serverless (Vector)' devops-api: 'DevOps API' + devops-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$devops-api/index.html' cass: 'Apache Cassandra' cass-reg: 'Apache Cassandra(R)' cass-short: 'Cassandra' diff --git a/modules/operations/pages/monitoring/stream-audit-logs.adoc b/modules/operations/pages/monitoring/stream-audit-logs.adoc index 0455160..480ab80 100644 --- a/modules/operations/pages/monitoring/stream-audit-logs.adoc +++ b/modules/operations/pages/monitoring/stream-audit-logs.adoc @@ -5,7 +5,7 @@ Stream your xref:astra-db-serverless:administration:view-account-audit-log.adoc[ To enable audit log streaming, you must do one of the following: * Provide the **Full Name** of your {product} topic and the streaming tenant's `client.conf` file to {support_url}[{company} Support] or your {company} account representative. - * POST your configuration to the xref:astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry[{astra-db} {devops-api} telemetry endpoint]. + * POST your configuration to the {devops-api-ref-url}#tag/Organization-Operations/operation/configureTelemetry[{astra-db} {devops-api} telemetry endpoint]. == Create an {product} topic for audit logs @@ -35,7 +35,7 @@ You can use topics to organize audit logs by event type or other criteria. [#use-the-devops-api] == Configure audit log streaming with the {devops-api} -You can use the xref:astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry[{astra-db} {devops-api} telemetry endpoint] to configure audit log streaming instead of providing the configuration details to {company} Support. +You can use the {devops-api-ref-url}#tag/Organization-Operations/operation/configureTelemetry[{astra-db} {devops-api} telemetry endpoint] to configure audit log streaming instead of providing the configuration details to {company} Support. . In the {astra-ui-link}, create an {astra-db} application token with the **Organization Administrator** role. @@ -102,4 +102,4 @@ curl -sS --location -X GET "https://api.astra.datastax.com/v2/organizations/**OR == Delete an audit log streaming configuration -To delete an audit log streaming configuration, xref:astra-api-docs:ROOT:attachment$devops-api/index.html#tag/Organization-Operations/operation/deleteTelemetryConfig[send a DELETE request]. \ No newline at end of file +To delete an audit log streaming configuration, {devops-api-ref-url}#tag/Organization-Operations/operation/deleteTelemetryConfig[send a DELETE request]. \ No newline at end of file