From e17896b43c84b76c86ad9d5506f42fe8a023a362 Mon Sep 17 00:00:00 2001 From: April M Date: Thu, 13 Feb 2025 14:40:07 -0800 Subject: [PATCH 1/5] attributes pt 1 --- antora.yml | 15 ++++++++++-- modules/ROOT/pages/astream-faq.adoc | 4 ++-- .../ROOT/pages/astream-org-permissions.adoc | 19 ++++++++------- modules/ROOT/pages/index.adoc | 8 +++---- modules/apis/pages/api-operations.adoc | 16 ++++++------- modules/apis/pages/index.adoc | 6 ++--- modules/developing/pages/astra-cli.adoc | 16 ++++++------- modules/developing/pages/astream-cdc.adoc | 8 +++---- .../developing/pages/astream-functions.adoc | 2 +- modules/developing/pages/astream-kafka.adoc | 12 +++++----- modules/developing/pages/astream-rabbit.adoc | 24 +++++++++---------- .../pages/gpt-schema-translator.adoc | 16 ++++++------- modules/developing/pages/using-curl.adoc | 4 ++-- modules/getting-started/pages/index.adoc | 2 +- modules/operations/pages/astream-pricing.adoc | 10 ++++---- modules/operations/pages/astream-regions.adoc | 4 ++-- .../pages/astream-release-notes.adoc | 8 +++---- .../operations/pages/astream-token-gen.adoc | 16 ++++++------- .../pages/monitoring/integration.adoc | 2 +- .../pages/monitoring/stream-audit-logs.adoc | 20 ++++++++-------- modules/operations/pages/onboarding-faq.adoc | 6 ++--- 21 files changed, 115 insertions(+), 103 deletions(-) diff --git a/antora.yml b/antora.yml index 84d42a0..7262be8 100644 --- a/antora.yml +++ b/antora.yml @@ -12,15 +12,26 @@ nav: asciidoc: attributes: + company: 'DataStax' + astra-db: 'Astra DB' product: 'Astra Streaming' + product-short: 'Astra' + astra-cli: 'Astra CLI' + + astra-ui: 'Astra Portal' + astra-url: 'https://astra.datastax.com' + astra-ui-link: '{astra-url}[{astra-ui}^] + + devops-api: 'DevOps API' pulsar: 'Apache Pulsar' pulsar-short: 'Pulsar' pulsar-reg: 'Apache Pulsar(TM)' pulsar-version: '2.10' #DO NOT INCLUDE PATCH VERSION .. pulsar-version-patch: '2.10.1' - kafka_for_astra: 'Starlight for Kafka' - starlight_rabbitmq: 'Starlight for RabbitMQ' + kafka-for-astra: 'Starlight for Kafka' + starlight-rabbitmq: 'Starlight for RabbitMQ' gpt-schema-translator: 'GPT schema translator' + url-astra: 'https://astra.datastax.com' link-astra-portal: '{url-astra}[{astra_ui}^]' astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master' diff --git a/modules/ROOT/pages/astream-faq.adoc b/modules/ROOT/pages/astream-faq.adoc index 6c47a31..d3fe723 100644 --- a/modules/ROOT/pages/astream-faq.adoc +++ b/modules/ROOT/pages/astream-faq.adoc @@ -28,9 +28,9 @@ The pricing model also makes {product} accessible to mid market and small/medium And finally {product} offers a user-friendly interface and free tier to satisfy the needs of individual developers and technologists who want to learn more about {pulsar} and data streaming in general. -== What is CDC for {astra_db}? +== What is CDC for {astra-db}? -Change Data Capture (CDC) for {astra_db} uses a {pulsar-short} IO source connector that processes changes from the Cassandra Change Agent through a {pulsar-short} topic. +Change Data Capture (CDC) for {astra-db} uses a {pulsar-short} IO source connector that processes changes from the Cassandra Change Agent through a {pulsar-short} topic. For more information, see xref:developing:astream-cdc.adoc[]. == What are tenants, namespaces, topics, and sinks? diff --git a/modules/ROOT/pages/astream-org-permissions.adoc b/modules/ROOT/pages/astream-org-permissions.adoc index d496737..a19c9cd 100644 --- a/modules/ROOT/pages/astream-org-permissions.adoc +++ b/modules/ROOT/pages/astream-org-permissions.adoc @@ -1,18 +1,19 @@ -= Manage roles and permissions += Manage {product} roles and permissions +:navtitle: Manage roles and permissions :page-tag: astra-streaming,security,secure,pulsar -You manage role-based access control (RBAC) for {product} through your {astra_db} organization. -For information about {astra_db} RBAC, including default roles, custom roles, permissions, and user management, see xref:astra-db-serverless:administration:manage-database-access.adoc[]. +You manage role-based access control (RBAC) for {product} through your {astra-db} organization. +For information about {astra-db} RBAC, including default roles, custom roles, permissions, and user management, see xref:astra-db-serverless:administration:manage-database-access.adoc[]. == {product} permissions Permissions specific to {product} include the following: -* *Manage Streaming* (`org-stream-manage`): View, add, edit, or remove Astra Streaming configurations. +* *Manage Streaming* (`org-stream-manage`): View, add, edit, or remove {product} configurations. === Default roles for {product} -There are no default {astra_db} roles specifically scoped to {product}. +There are no default {astra-db} roles specifically scoped to {product}. However, the following default roles have the *Manage Streaming* permission: * *Organization Administrator* @@ -36,7 +37,7 @@ Additional permissions might be required, depending on the tasks the role needs To control access to specific streaming tenants, you can set granular xref:astra-db-serverless:administration:manage-database-access.adoc#role-scopes[resource scopes] on custom roles. ==== -== Authentication and authorization in {pulsar-reg} and {astra_db} +== Authentication and authorization in {pulsar-reg} and {astra-db} {pulsar-short} has the concept of https://pulsar.apache.org/docs/security-authorization/[clients with role tokens]. In {pulsar-short}, authentication is the process of verifying a provided token (JWT), and authorization is the process of determining if the role claimed in that token is allowed to complete the requested action. @@ -44,14 +45,14 @@ In {pulsar-short}, authentication is the process of verifying a provided token ( {product} uses the {company} version of {pulsar} (xref:luna-streaming::index.adoc[Luna Streaming]). The https://github.com/datastax/pulsar[Luna project] is an open fork of the {pulsar-short} project that maintains feature parity with OSS {pulsar-short}. {product}, as a managed service, abstracts some features/options of {pulsar-short} to ensure continuous, reliable service. -On a shared cluster, your {astra_db} organization has one or more tenants on a shared {pulsar-short} cluster. -Each of your tenants is secured by {pulsar-short} authentication and authorization models, as well as your {astra_db} organization's authentication and authorization ({astra_db} RBAC). +On a shared cluster, your {astra-db} organization has one or more tenants on a shared {pulsar-short} cluster. +Each of your tenants is secured by {pulsar-short} authentication and authorization models, as well as your {astra-db} organization's authentication and authorization ({astra-db} RBAC). {product} shared clusters are created and administered by {product} administrators. Each tenant is assigned a custom role and permissions limited to that tenant only. All tokens created within a tenant are assigned roles similar to the assigning tenant. -For programmatic access, you use {astra_db} application tokens or {pulsar-short} JWT, depending on the operation you need to perform. +For programmatic access, you use {astra-db} application tokens or {pulsar-short} JWT, depending on the operation you need to perform. For more information, see xref:operations:astream-token-gen.adoc[]. == See also diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index a5b1971..46aa208 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -8,9 +8,9 @@ Using {product}, customers can quickly create {pulsar-short} instances, manage their clusters, scale across cloud regions, and manage {pulsar-short} resources such as topics, connectors, functions and subscriptions. -{product} takes advantage of the core capabilities built into {astra_db} such +{product} takes advantage of the core capabilities built into {astra-db} such as SSO, IAM and billing. -Existing {astra_db} customers can augment their existing database capabilities +Existing {astra-db} customers can augment their existing database capabilities with pub/sub and streaming to address a wider range of use cases right away. With {product}, customers now have powerful capabilities to help drive key @@ -33,6 +33,6 @@ their legacy messaging technologies keep up will find {product} to be a frictionless path to modernization. *Faster Access to Data*:: No one has patience for slow loading web pages or mobile apps. -By combining {product} with {astra_db}, customers can create read-optimized -views of data that can be quickly read from {astra_db} and ensure that data is +By combining {product} with {astra-db}, customers can create read-optimized +views of data that can be quickly read from {astra-db} and ensure that data is always up to date by leveraging the event stream processing capabilities of {product}. diff --git a/modules/apis/pages/api-operations.adoc b/modules/apis/pages/api-operations.adoc index 39d0064..eae0d57 100644 --- a/modules/apis/pages/api-operations.adoc +++ b/modules/apis/pages/api-operations.adoc @@ -1,19 +1,19 @@ = API operations //TODO: Needs more work and clean up of all source blocks. -This {product} workbook is a comprehensive guide that provides detailed examples and practices for managing the {product} platform using the DevOps APIs. +This {product} workbook is a comprehensive guide that provides detailed examples and practices for managing the {product} platform using the {devops-api}s. It provides details on the most commonly used APIs for managing {product} and {pulsar-reg} instances. These details include required parameters and the expected output from the API. The workbook is designed to fill the gap between detailed API reference docs and HowTo guides. -The result is to help customers in operating and managing {product} and provide guidance on how to use DevOps API to automate many common tasks. +The result is to help customers in operating and managing {product} and provide guidance on how to use {devops-api}s to automate many common tasks. The workbook covers a wide range of topics, including provisioning of resources, monitoring, and troubleshooting. It provides instructions for various operations, such as creating a new tenant, namespace, topics, geo-replication, and access tokens, to setting up monitoring and alerting, and troubleshooting common issues. -Overall, this {product} Workbook is a valuable resource for customers who want to leverage the benefits of {product} and manage their streaming environment effectively with DevOps APIs. By following the best practices and guidelines outlined in the workbook, customers can ensure that their streaming applications are secure, performant, and reliable. +Overall, this {product} Workbook is a valuable resource for customers who want to leverage the benefits of {product} and manage their streaming environment effectively with {devops-api}s. By following the best practices and guidelines outlined in the workbook, customers can ensure that their streaming applications are secure, performant, and reliable. == Prerequisites -* An active {astra_db} account with access to {product} +* An active {product-short} account with access to {product} * Credentials and values required to xref:developing:using-curl.adoc[form HTTP requests] === Set environment variables @@ -42,9 +42,9 @@ The examples in this guide use environment variables for these values. Additionally, some examples in this guide use `python3 -mjson.tool` to format the JSON response. This is optional; it is not required to execute API requests. -== {product} DevOps API tenant operations +== {product} {devops-api} tenant operations -The following examples demonstrate how to use the {product} DevOps API to manage {product} resources. +The following examples demonstrate how to use the {product} {devops-api} to manage {product} resources. === Get tenant information @@ -842,7 +842,7 @@ curl -sS --fail --location --request POST "$WEB_SERVICE_URL/admin/v2/persistent/ No response indicates success. -== {product} DevOps API geo-replication operations +== {product} {devops-api} geo-replication operations === Get status of geo-replication @@ -1159,7 +1159,7 @@ curl --fail --location --request POST "$WEB_SERVICE_URL/admin/v3/functions/$TENA No response indicates success. -== {product} DevOps API JWT operations +== {product} {devops-api} JWT operations === List existing token IDs diff --git a/modules/apis/pages/index.adoc b/modules/apis/pages/index.adoc index a26c0e7..15f00a2 100644 --- a/modules/apis/pages/index.adoc +++ b/modules/apis/pages/index.adoc @@ -4,11 +4,11 @@ You use two APIs to manage {pulsar-reg} tenants and their resources. -== {product} DevOps API +== {product} {devops-api} -Use the xref:astra-streaming:apis:attachment$devops.html[{product} DevOps API] to manage higher-level objects associated with your account, 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. +This API uses an {astra-db} application token for authentication. == {product} {pulsar-short} Admin API diff --git a/modules/developing/pages/astra-cli.adoc b/modules/developing/pages/astra-cli.adoc index bae310c..9dace88 100644 --- a/modules/developing/pages/astra-cli.adoc +++ b/modules/developing/pages/astra-cli.adoc @@ -1,15 +1,15 @@ -= {astra_cli} overview -:navtitle: {astra_cli} -:description: {astra_cli} provides a one-stop shop for managing your Astra resources through scripts or commands in your local terminal. += {astra-cli} overview +:navtitle: {astra-cli} +:description: {astra-cli} provides a one-stop shop for managing your Astra resources through scripts or commands in your local terminal. -The xref:astra-cli:ROOT:index.adoc[{astra_db} Command-Line Interface ({astra_cli})] is a set of commands you can use to create and manage {astra_db} and {product} resources: +The xref:astra-cli:ROOT:index.adoc[{astra-db} Command-Line Interface ({astra-cli})] is a set of commands you can use to create and manage {astra-db} and {product} resources: -* Creation and management of {astra_db} databases, {astra_stream} tenants, and their associated artifacts. +* Creation and management of {astra-db} databases, {astra_stream} tenants, and their associated artifacts. * Querying and data loading. * Organization and user management. * Security and token configuration. -{astra_cli} commands are available for {astra_db} and {astra_stream}. +{astra-cli} commands are available for {astra-db} and {astra_stream}. They're designed to get you working quickly, with an emphasis on automation. For example, the following command creates an {pulsar-reg} tenant: @@ -21,8 +21,8 @@ astra streaming create **TENANT_NAME** \ --plan **PLAN_TYPE** --namespace **TENANT_INITIAL_NAMESPACE_NAME** ---- -You can use {astra_cli} instead of or in addition to the {astra_ui} and {astra_db} APIs. +You can use {astra-cli} instead of or in addition to the {astra_ui} and {astra-db} APIs. For more information, see the following: -* https://www.datastax.com/blog/introducing-cassandra-astra-cli[Accelerate your Cassandra development and automation with the {astra_cli}] +* https://www.datastax.com/blog/introducing-cassandra-astra-cli[Accelerate your Cassandra development and automation with the {astra-cli}] diff --git a/modules/developing/pages/astream-cdc.adoc b/modules/developing/pages/astream-cdc.adoc index 3579e38..3b3aa4a 100644 --- a/modules/developing/pages/astream-cdc.adoc +++ b/modules/developing/pages/astream-cdc.adoc @@ -1,14 +1,14 @@ = 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 +:description: CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data [IMPORTANT] ==== -Enabling CDC for {astra_db} databases incurs billed charges based on your {product} usage. +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. +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[]. +For instructions and more information about CDC for {astra-db}, see xref:astra-db-serverless:databases:change-data-capture.adoc[]. diff --git a/modules/developing/pages/astream-functions.adoc b/modules/developing/pages/astream-functions.adoc index 033e0c6..962e8c3 100644 --- a/modules/developing/pages/astream-functions.adoc +++ b/modules/developing/pages/astream-functions.adoc @@ -311,7 +311,7 @@ Upload your own code:: .. Based on the uploaded file, select the specific class (function) to deploy. + -{astra_db} generates a list of acceptable classes detected in the code. +{astra-db} generates a list of acceptable classes detected in the code. A file can contain multiple classes, but only one is used per deployment. + For Python scripts, the class name is the Python filename (without the extension) and the class to execute. diff --git a/modules/developing/pages/astream-kafka.adoc b/modules/developing/pages/astream-kafka.adoc index 3ac1055..ada9dde 100644 --- a/modules/developing/pages/astream-kafka.adoc +++ b/modules/developing/pages/astream-kafka.adoc @@ -1,7 +1,7 @@ -= {kafka_for_astra} += {kafka-for-astra} :page-tag: starlight-kafka,dev,admin,pulsar,kafka -{kafka_for_astra} brings native Apache Kafka(R) protocol support to {pulsar-reg}, enabling migration of existing Kafka applications and services to {pulsar-short} without modifying the code. +{kafka-for-astra} brings native Apache Kafka(R) protocol support to {pulsar-reg}, enabling migration of existing Kafka applications and services to {pulsar-short} without modifying the code. Kafka applications can leverage {pulsar-short} features such as the following: * Streamlined operations with enterprise-grade multi-tenancy @@ -9,13 +9,13 @@ Kafka applications can leverage {pulsar-short} features such as the following: * Infinite event stream retention with Apache BookKeeper(TM) and tiered storage * Serverless event processing with xref:astream-functions.adoc[{pulsar-short} Functions] -By integrating two popular event streaming ecosystems, {kafka_for_astra} unlocks new use cases and reduces barriers for users adopting {pulsar-short}. Leverage advantages from each ecosystem and build a truly unified event streaming platform with {kafka_for_astra} to accelerate the development of real-time applications and services. +By integrating two popular event streaming ecosystems, {kafka-for-astra} unlocks new use cases and reduces barriers for users adopting {pulsar-short}. Leverage advantages from each ecosystem and build a truly unified event streaming platform with {kafka-for-astra} to accelerate the development of real-time applications and services. This document will help you get started producing and consuming Kafka messages on a {pulsar-short} cluster. -== {kafka_for_astra} Quickstart +== {kafka-for-astra} Quickstart -. To start connecting {kafka_for_astra}, select *Kafka* in the {product} *Connect* tab. +. To start connecting {kafka-for-astra}, select *Kafka* in the {product} *Connect* tab. . When the popup appears, confirm you want to enable Kafka on your tenant. + @@ -99,5 +99,5 @@ image::astream-kafka-monitor.png[Monitor Kafka Activity] == See also -* https://github.com/datastax/starlight-for-kafka[{company} {kafka_for_astra} project] +* https://github.com/datastax/starlight-for-kafka[{company} {kafka-for-astra} project] * xref:getting-started:index.adoc[] diff --git a/modules/developing/pages/astream-rabbit.adoc b/modules/developing/pages/astream-rabbit.adoc index 8ee9540..01092d4 100644 --- a/modules/developing/pages/astream-rabbit.adoc +++ b/modules/developing/pages/astream-rabbit.adoc @@ -1,21 +1,21 @@ -= {starlight_rabbitmq} += {starlight-rabbitmq} :page-tag: starlight-rabbitmq,quickstart,admin,dev,pulsar -{starlight_rabbitmq} brings native RabbitMQ(R) protocol support to {pulsar-reg}, enabling migration of existing RabbitMQ applications and services to {pulsar-short} without modifying the code. +{starlight-rabbitmq} brings native RabbitMQ(R) protocol support to {pulsar-reg}, enabling migration of existing RabbitMQ applications and services to {pulsar-short} without modifying the code. RabbitMQ applications can leverage {pulsar-short} features such as the following: -* *Consistent metadata store*: {starlight_rabbitmq} uses Apache ZooKeeper(TM), so existing Zookeeper configuration stores can store {starlight_rabbitmq} metadata. -* *Security and authentication*: {starlight_rabbitmq} connects to brokers that have TLS, authentication, and/or authorization enabled, because it uses the same `AuthenticationService` as {pulsar-short}. -* *Clustering*: Launch multiple stateless {starlight_rabbitmq} instances simultaneously for scalability and high availability. -* *Multi-tenancy*: {starlight_rabbitmq} offers support for multi-tenancy, mapping an AMQP virtual host to a {pulsar-short} tenant and namespace. +* *Consistent metadata store*: {starlight-rabbitmq} uses Apache ZooKeeper(TM), so existing Zookeeper configuration stores can store {starlight-rabbitmq} metadata. +* *Security and authentication*: {starlight-rabbitmq} connects to brokers that have TLS, authentication, and/or authorization enabled, because it uses the same `AuthenticationService` as {pulsar-short}. +* *Clustering*: Launch multiple stateless {starlight-rabbitmq} instances simultaneously for scalability and high availability. +* *Multi-tenancy*: {starlight-rabbitmq} offers support for multi-tenancy, mapping an AMQP virtual host to a {pulsar-short} tenant and namespace. -By integrating two popular event streaming ecosystems, {starlight_rabbitmq} unlocks new use cases and reduces barriers for users adopting {pulsar-short}. Leverage advantages from each ecosystem and build a truly unified event streaming platform with {starlight_rabbitmq} to accelerate the development of real-time applications and services. +By integrating two popular event streaming ecosystems, {starlight-rabbitmq} unlocks new use cases and reduces barriers for users adopting {pulsar-short}. Leverage advantages from each ecosystem and build a truly unified event streaming platform with {starlight-rabbitmq} to accelerate the development of real-time applications and services. Get started producing and consuming RabbitMQ messages on a {pulsar-short} cluster. -== {starlight_rabbitmq} Quickstart +== {starlight-rabbitmq} Quickstart -. To start connecting {starlight_rabbitmq}, select *RabbitMQ* in the {product} *Connect* tab. +. To start connecting {starlight-rabbitmq}, select *RabbitMQ* in the {product} *Connect* tab. . When the popup appears, confirm you want to enable RabbitMQ on your tenant. + @@ -125,7 +125,7 @@ Your RabbitMQ messages are being published to a {pulsar-short} topic. == RabbitMQ exchanges and {pulsar-short} topics -{starlight_rabbitmq} maps RabbitMQ _exchanges_ to {pulsar-short} _topics_, as described in the following table: +{starlight-rabbitmq} maps RabbitMQ _exchanges_ to {pulsar-short} _topics_, as described in the following table: [cols="1,1,1,1"] |=== @@ -161,6 +161,6 @@ channel.basic_publish(exchange='header_logs'),` == See also -* https://github.com/datastax/starlight-for-rabbitmq[{company} {starlight_rabbitmq} project] +* https://github.com/datastax/starlight-for-rabbitmq[{company} {starlight-rabbitmq} project] * xref:getting-started:index.adoc[] -* xref:astream-kafka.adoc[{kafka_for_astra}] \ No newline at end of file +* xref:astream-kafka.adoc[{kafka-for-astra}] \ No newline at end of file diff --git a/modules/developing/pages/gpt-schema-translator.adoc b/modules/developing/pages/gpt-schema-translator.adoc index 9e0e15b..4541269 100644 --- a/modules/developing/pages/gpt-schema-translator.adoc +++ b/modules/developing/pages/gpt-schema-translator.adoc @@ -9,19 +9,19 @@ If the schema includes more complex data types, like maps and nested data struct Schema management is a complicated, tedious, and error-prone tasks that requires you to understand and translate multiple sets of schema rules. Instead, you can use the {gpt-schema-translator} to save time and reduce schema mapping toil. -This tool uses generative AI,based on the `GPT-4` model, to automatically generate schema mappings between {product} ({pulsar-short} topics) and the {astra_db} sink connector (Cassandra tables). +This tool uses generative AI,based on the `GPT-4` model, to automatically generate schema mappings between {product} ({pulsar-short} topics) and the {astra-db} sink connector (Cassandra tables). == Prerequisites * An {product} tenant with a namespace and topic. -* An {astra_db} database with a keyspace and table. -* An xref:streaming-learning:pulsar-io:connectors/sinks/astra-db.adoc[{astra_db} sink connector]. -The {gpt-schema-translator} is available for the {astra_db} sink connector only. +* An {astra-db} database with a keyspace and table. +* An xref:streaming-learning:pulsar-io:connectors/sinks/astra-db.adoc[{astra-db} sink connector]. +The {gpt-schema-translator} is available for the {astra-db} sink connector only. == JSON-to-CQL mapping example -This example uses a JSON schema for a {pulsar-short} topic, and a CQL schema for an {astra_db} table. -The {gpt-schema-translator} generates a mapping between the two schemas that the {astra_db} sink connector can use to write data from the {pulsar-short} topic to the {astra_db} table. +This example uses a JSON schema for a {pulsar-short} topic, and a CQL schema for an {astra-db} table. +The {gpt-schema-translator} generates a mapping between the two schemas that the {astra-db} sink connector can use to write data from the {pulsar-short} topic to the {astra-db} table. . In the {astra_ui} navigation menu, click *Streaming*, and then select your tenant. @@ -123,7 +123,7 @@ id=key, file1=value.file1, file2=value.file2, file3=value.file3 . Save the mapping configuration. -. After configuring your {astra_db} sink connector for the given topic and table, messages should flow between the two schemas without error. +. After configuring your {astra-db} sink connector for the given topic and table, messages should flow between the two schemas without error. You can check the {astra_ui} logs to confirm that the data is flowing into your table without errors. [#pulsar-topic-to-cql-table] @@ -369,7 +369,7 @@ This example demonstrates how you can generates schema mapping in real time. ---- ==== -. The {astra_db} sink connector writes data to the Cassandra table with a CQL schema. +. The {astra-db} sink connector writes data to the Cassandra table with a CQL schema. + .CQL schema example [%collapsible] diff --git a/modules/developing/pages/using-curl.adoc b/modules/developing/pages/using-curl.adoc index a227a1f..8b69cea 100644 --- a/modules/developing/pages/using-curl.adoc +++ b/modules/developing/pages/using-curl.adoc @@ -8,7 +8,7 @@ Each API supports different functionalities. Depending on the API you use, you need certain information to form HTTP requests: * To use the {product} {pulsar-short} Admin API and {pulsar-short} REST APIs, you need the tenant's Web Service URL and {pulsar-short} token. -* To use the {product} DevOps API, you need an xref:operations:astream-token-gen.adoc[{astra_db} application token]. +* To use the {product} {devops-api}, you need an xref:operations:astream-token-gen.adoc[{astra-db} application token]. == Get the tenant web service URL @@ -33,7 +33,7 @@ Broker Service URLs start with `pulsar(+ssl)`. [IMPORTANT] ==== -An xref:operations:astream-token-gen.adoc[{astra_db} application token] is _not_ the same as a {pulsar-short} token. +An xref:operations:astream-token-gen.adoc[{astra-db} application token] is _not_ the same as a {pulsar-short} token. ==== For information about creating {pulsar-short} tokens, see xref:operations:astream-token-gen.adoc[]. diff --git a/modules/getting-started/pages/index.adoc b/modules/getting-started/pages/index.adoc index 50d1856..7f6b400 100644 --- a/modules/getting-started/pages/index.adoc +++ b/modules/getting-started/pages/index.adoc @@ -9,7 +9,7 @@ This quickstart demonstrates how to create and use a streaming tenant running {p == Prerequisites -* Sign in or create an {url-astra}[{astra_db} account^]. +* An active {url-astra}[{product-short} account^] == Create a streaming tenant diff --git a/modules/operations/pages/astream-pricing.adoc b/modules/operations/pages/astream-pricing.adoc index 08de4c4..0fca459 100644 --- a/modules/operations/pages/astream-pricing.adoc +++ b/modules/operations/pages/astream-pricing.adoc @@ -1,13 +1,13 @@ = {product} pricing :page-tag: astra-streaming,planner,plan,pulsar -{product} is a fully-managed, software-as-a-service (SaaS) offering embedded in {astra_db}. +{product} is a fully-managed, software-as-a-service (SaaS) offering embedded in {astra-db}. {product} offers three subscription plans, as well as pricing for dedicated clusters. -An {product} subscription is associated with an {astra_db} organization, but {product} subscription plans are separate from {astra_db} organization subscription plans. +An {product} subscription is associated with an {astra-db} organization, but {product} subscription plans are separate from {astra-db} organization subscription plans. For {product} plans and pricing details, see https://www.datastax.com/pricing/astra-streaming[{product} pricing]. -For information about {astra_db} plans, billing, and usage, see xref:astra-db-serverless:administration:subscription-plans.adoc[]. +For information about {astra-db} plans, billing, and usage, see xref:astra-db-serverless:administration:subscription-plans.adoc[]. == {product} subscription plans @@ -30,7 +30,7 @@ If desired, you can opt in to <>. If you prefer not to use shared clusters, you can opt for dedicated clusters. With dedicated clusters, you have your own private {pulsar-short} cluster with all the benefits of {product} as a managed service. -You sign in to {astra_db} and use {product} in the same way that you would on shared clusters. +You sign in to {astra-db} and use {product} in the same way that you would on shared clusters. When you create a tenant, you have the option to deploy to your private cluster. This means that you can use both shared or dedicated clusters, depending on your tenants' use cases. @@ -63,7 +63,7 @@ With shared clusters, you can create tenants in any of the xref:astream-regions. Dedicated clusters are open to almost any public cloud region. For this reason, dedicated clusters offer more flexibility for xref:operations:astream-georeplication.adoc[geo-replication]. -If your preferred region isn't already available, you can contact your account representative or {support_url}[{company} Support] to request it. +If your preferred region isn't already available, you can contact your {company} account representative or {support_url}[{company} Support] to request it. == See also diff --git a/modules/operations/pages/astream-regions.adoc b/modules/operations/pages/astream-regions.adoc index 91b3cb6..64da2bf 100644 --- a/modules/operations/pages/astream-regions.adoc +++ b/modules/operations/pages/astream-regions.adoc @@ -5,8 +5,8 @@ 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. -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}. +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}. ElasticSearch and Snowflake can be in different regions than {product}. diff --git a/modules/operations/pages/astream-release-notes.adoc b/modules/operations/pages/astream-release-notes.adoc index 0234402..5c6d156 100644 --- a/modules/operations/pages/astream-release-notes.adoc +++ b/modules/operations/pages/astream-release-notes.adoc @@ -25,7 +25,7 @@ This page summarizes significant changes and updates to {product}. === {new} -* The xref:developing:gpt-schema-translator.adoc[GPT schema translator] is now available for the xref:streaming-learning:pulsar-io:connectors/sinks/astra-db.adoc[{astra_db} Sink Connector]. +* The xref:developing:gpt-schema-translator.adoc[GPT schema translator] is now available for the xref:streaming-learning:pulsar-io:connectors/sinks/astra-db.adoc[{astra-db} Sink Connector]. == June 1, 2023 @@ -127,7 +127,7 @@ Organizations on the *Free* plan can use xref:streaming-learning:functions:index [discrete] ==== {new} -* xref:developing:astream-rabbit.adoc[{starlight_rabbitmq}] is now available, bringing built-in RabbitMQ(R) protocol support to {pulsar-reg}, enabling migration of existing RabbitMQ applications and services to {pulsar-short} without modifying the code. +* xref:developing:astream-rabbit.adoc[{starlight-rabbitmq}] is now available, bringing built-in RabbitMQ(R) protocol support to {pulsar-reg}, enabling migration of existing RabbitMQ applications and services to {pulsar-short} without modifying the code. [discrete] === April 19, 2022 @@ -137,7 +137,7 @@ Organizations on the *Free* plan can use xref:streaming-learning:functions:index [discrete] ==== {new} -* xref:developing:astream-kafka.adoc[{kafka_for_astra}] is now available, bringing built-in Apache Kafka(R) protocol support to {pulsar-short}. +* xref:developing:astream-kafka.adoc[{kafka-for-astra}] is now available, bringing built-in Apache Kafka(R) protocol support to {pulsar-short}. [discrete] === March 24, 2022 @@ -147,7 +147,7 @@ Organizations on the *Free* plan can use xref:streaming-learning:functions:index [discrete] ==== {new} -* xref:developing:astream-cdc.adoc[CDC for {astra_db}] is now available, which 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. +* xref:developing:astream-cdc.adoc[CDC for {astra-db}] is now available, which 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. [discrete] === January 31, 2022 diff --git a/modules/operations/pages/astream-token-gen.adoc b/modules/operations/pages/astream-token-gen.adoc index 9de05e5..8f1ee62 100644 --- a/modules/operations/pages/astream-token-gen.adoc +++ b/modules/operations/pages/astream-token-gen.adoc @@ -1,21 +1,21 @@ = Manage tokens -{product} uses two types of tokens that you can generate in {astra_db}. +{product} uses two types of tokens that you can generate in {astra-db}. [#astra-token] -== {astra_db} application tokens +== {astra-db} application tokens -{astra_db} application tokens are access tokens for authentication to the {astra_ui} and the xref:apis:index.adoc[{product} DevOps API]. +{astra-db} application tokens are access tokens for authentication to the {astra_ui} and the xref:apis:index.adoc[{product} {devops-api}]. -You need an application token for actions related to {astra_db} organizations and databases. +You need an application token for actions related to {astra-db} organizations and databases. -For information about creating and managing {astra_db} application tokens, see xref:astra-db-serverless:administration:manage-application-tokens.adoc[]. +For information about creating and managing {astra-db} application tokens, see xref:astra-db-serverless:administration:manage-application-tokens.adoc[]. [#pulsar-token] == {product} {pulsar-short} tokens {product} {pulsar-short} token are {pulsar-reg} https://jwt.io/introduction/[JSON Web Token (JWT)] for authentication to your {product} {pulsar-short} cluster through the {pulsar-short} CLI, runtime clients, or the {pulsar-short} Admin API. -If necessary, {astra_db} forwards the JWT to the {pulsar-short} cluster for role verification. +If necessary, {astra-db} forwards the JWT to the {pulsar-short} cluster for role verification. You need a {pulsar-short} JWT for actions related to {pulsar-short} tenants, namespaces, messages, topics, and functions, as well as {pulsar-short} CLI/API commands. @@ -51,7 +51,7 @@ The following examples show how you can use the two tokens for different actions === Track monthly usage -Use an {astra_db} application token to track monthly usage. +Use an {astra-db} application token to track monthly usage. For example: [source,curl,subs="+quotes"] @@ -83,7 +83,7 @@ bin/pulsar-admin sinks status === Billing report by tenant -Use an {astra_db} application token to get tenant billing reports. +Use an {astra-db} application token to get tenant billing reports. For example: [source,curl,subs="+quotes"] diff --git a/modules/operations/pages/monitoring/integration.adoc b/modules/operations/pages/monitoring/integration.adoc index 81134f1..0283c03 100644 --- a/modules/operations/pages/monitoring/integration.adoc +++ b/modules/operations/pages/monitoring/integration.adoc @@ -8,7 +8,7 @@ This page explains how to set up a Prometheus server in a Kubernetes cluster and == Prerequisites -* An {astra_db} account +* An active {product-short} account * A Kubernetes cluster == Configure and deploy Prometheus diff --git a/modules/operations/pages/monitoring/stream-audit-logs.adoc b/modules/operations/pages/monitoring/stream-audit-logs.adoc index e01430d..c01cbfd 100644 --- a/modules/operations/pages/monitoring/stream-audit-logs.adoc +++ b/modules/operations/pages/monitoring/stream-audit-logs.adoc @@ -1,11 +1,11 @@ -= Stream {astra_db} audit logs += Stream {astra-db} audit logs -Stream your xref:astra-db-serverless:administration:view-account-audit-log.adoc[{astra_db} audit logs] through {product} to an external system. +Stream your xref:astra-db-serverless:administration:view-account-audit-log.adoc[{astra-db} audit logs] through {product} to an external system. 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 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]. + * 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]. == Create an {product} topic for audit logs @@ -29,13 +29,13 @@ You can use topics to organize audit logs by event type or other criteria. . To finalize the configuration, do one of the following: + -* Send your topic's full name and the `client.conf` file to {support_url}[{company} Support] or your account representative, and then {company} will complete the setup. -* <> +* Send your topic's full name and the `client.conf` file to {support_url}[{company} Support] or your {company} account representative, and then {company} will complete the setup. +* <> [#use-the-devops-api] -== Configure audit log streaming with 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 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. . In the {link-astra-portal}, create an application token with the **Organization Administrator** role. @@ -59,8 +59,8 @@ curl -sS --location -X POST "https://api.astra.datastax.com/v2/organizations/**O + Replace the following: + -* `**ORG_ID**`: Your {astra_db} organization ID. -* `**APPLICATION_TOKEN**`: Your {astra_db} application token. +* `**ORG_ID**`: Your {astra-db} organization ID. +* `**APPLICATION_TOKEN**`: Your {astra-db} application token. * `**BROKER_SERVICE_URL**`: The {product} broker service URL, such as `ssl://pulsar-aws-useast2.streaming.datastax.com:6651`. * `**TOPIC_FULL_NAME**`: The full name of the {product} topic where you want to stream audit logs. * The `auth_strategy` and other authentication details depend on your Pulsar configuration. diff --git a/modules/operations/pages/onboarding-faq.adoc b/modules/operations/pages/onboarding-faq.adoc index d00a5bc..430ba24 100644 --- a/modules/operations/pages/onboarding-faq.adoc +++ b/modules/operations/pages/onboarding-faq.adoc @@ -34,14 +34,14 @@ For more information, see xref:operations:astream-pricing.adoc[]. == Does {product} support single-sign on? -If your {astra_db} organization is on the *Pay As You Go* or *Enterprise* {astra_db} subscription plan, your users can use SSO to sign in to the {astra_ui}. +If your {astra-db} organization is on the *Pay As You Go* or *Enterprise* {astra-db} subscription plan, your users can use SSO to sign in to the {astra_ui}. For more information, see xref:astra-db-serverless:administration:configure-sso.adoc[]. -== How do {astra_db} roles and permissions map to {pulsar-short} roles and permissions? +== How do {astra-db} roles and permissions map to {pulsar-short} roles and permissions? See xref:ROOT:astream-org-permissions.adoc[]. -== What is the difference between {astra_db} application tokens and the {pulsar-short} tokens? +== What is the difference between {astra-db} application tokens and the {pulsar-short} tokens? See xref:operations:astream-token-gen.adoc[]. From af0837e457f7303d2623713f5bfd4944538fba7f Mon Sep 17 00:00:00 2001 From: April M Date: Thu, 13 Feb 2025 14:42:14 -0800 Subject: [PATCH 2/5] attributes pt 2 --- antora.yml | 5 ++--- .../ROOT/pages/astream-org-permissions.adoc | 4 ++-- modules/ROOT/pages/index.adoc | 2 +- modules/apis/pages/api-operations.adoc | 4 ++-- modules/developing/pages/astra-cli.adoc | 2 +- .../developing/pages/astream-functions.adoc | 16 +++++++------- .../pages/clients/spring-produce-consume.adoc | 4 ++-- .../pages/configure-pulsar-env.adoc | 2 +- .../pages/gpt-schema-translator.adoc | 8 +++---- .../pages/produce-consume-astra-portal.adoc | 8 +++---- modules/developing/pages/using-curl.adoc | 2 +- .../partials/client-variables-table.adoc | 8 +++---- modules/getting-started/pages/index.adoc | 22 +++++++++---------- .../pages/astream-georeplication.adoc | 4 ++-- modules/operations/pages/astream-limits.adoc | 6 ++--- .../pages/astream-release-notes.adoc | 2 +- .../pages/astream-scrape-metrics.adoc | 2 +- .../operations/pages/astream-token-gen.adoc | 4 ++-- .../pages/monitoring/integration.adoc | 4 ++-- .../pages/monitoring/stream-audit-logs.adoc | 6 ++--- modules/operations/pages/onboarding-faq.adoc | 2 +- 21 files changed, 58 insertions(+), 59 deletions(-) diff --git a/antora.yml b/antora.yml index 7262be8..1c5a9cb 100644 --- a/antora.yml +++ b/antora.yml @@ -21,7 +21,7 @@ asciidoc: astra-ui: 'Astra Portal' astra-url: 'https://astra.datastax.com' astra-ui-link: '{astra-url}[{astra-ui}^] - + devops-api: 'DevOps API' pulsar: 'Apache Pulsar' pulsar-short: 'Pulsar' @@ -32,8 +32,7 @@ asciidoc: starlight-rabbitmq: 'Starlight for RabbitMQ' gpt-schema-translator: 'GPT schema translator' - url-astra: 'https://astra.datastax.com' - link-astra-portal: '{url-astra}[{astra_ui}^]' + link-astra-portal: '{url-astra}[{astra-ui}^]' astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master' # LEGACY ATTRIBUTES - CONSIDER REMOVING diff --git a/modules/ROOT/pages/astream-org-permissions.adoc b/modules/ROOT/pages/astream-org-permissions.adoc index a19c9cd..2ac1b3f 100644 --- a/modules/ROOT/pages/astream-org-permissions.adoc +++ b/modules/ROOT/pages/astream-org-permissions.adoc @@ -27,8 +27,8 @@ For information about permissions assigned to default roles, see xref:astra-db-s If you xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[create custom roles] for {product}, those roles must have the following permissions, at minimum: -* *Manage Streaming* (`org-stream-manage`): View and manage {product} in the {astra_ui}. -* *View DB* (`org-db-view`): View the {astra_ui} in general. +* *Manage Streaming* (`org-stream-manage`): View and manage {product} in the {astra-ui}. +* *View DB* (`org-db-view`): View the {astra-ui} in general. Additional permissions might be required, depending on the tasks the role needs to perform. diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 46aa208..214a227 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -3,7 +3,7 @@ :page-tag: astra-streaming,planner,admin,dev,pulsar {product} is a cloud native data streaming and event stream processing -service tightly integrated into the {astra_ui} and powered by {pulsar-reg}. +service tightly integrated into the {astra-ui} and powered by {pulsar-reg}. Using {product}, customers can quickly create {pulsar-short} instances, manage their clusters, scale across cloud regions, and manage {pulsar-short} resources such as topics, connectors, functions and subscriptions. diff --git a/modules/apis/pages/api-operations.adoc b/modules/apis/pages/api-operations.adoc index eae0d57..82d45ab 100644 --- a/modules/apis/pages/api-operations.adoc +++ b/modules/apis/pages/api-operations.adoc @@ -1165,7 +1165,7 @@ No response indicates success. Get a list of Token IDs for your Cluster. With the TokenID, you can then lookup and obtain the {pulsar-short} JWT string. -The TokenIDs are also listed in the {astra_ui} for that Tenant and Cluster. +The TokenIDs are also listed in the {astra-ui} for that Tenant and Cluster. Required parameters "CLUSTER" is obtained from the "List Tenants with Details" API command. @@ -1210,7 +1210,7 @@ eyJhbGciOiJSUzI1NiIsI . . . === Create a JWT Create a new {pulsar-short} JWT. -The new JWT will also be visible in the {astra_ui} for that Tenant and Cluster. +The new JWT will also be visible in the {astra-ui} for that Tenant and Cluster. Required parameters "CLUSTER" is obtained from the "List Tenants with Details" API command. diff --git a/modules/developing/pages/astra-cli.adoc b/modules/developing/pages/astra-cli.adoc index 9dace88..a98a385 100644 --- a/modules/developing/pages/astra-cli.adoc +++ b/modules/developing/pages/astra-cli.adoc @@ -21,7 +21,7 @@ astra streaming create **TENANT_NAME** \ --plan **PLAN_TYPE** --namespace **TENANT_INITIAL_NAMESPACE_NAME** ---- -You can use {astra-cli} instead of or in addition to the {astra_ui} and {astra-db} APIs. +You can use {astra-cli} instead of or in addition to the {astra-ui} and {astra-db} APIs. For more information, see the following: diff --git a/modules/developing/pages/astream-functions.adoc b/modules/developing/pages/astream-functions.adoc index 962e8c3..9154535 100644 --- a/modules/developing/pages/astream-functions.adoc +++ b/modules/developing/pages/astream-functions.adoc @@ -230,7 +230,7 @@ If there isn't a class in the file, the `className` is the filename without the [IMPORTANT] ==== To avoid errors, make sure the `inputs` topic (declared in your configuration YAML file) has a defined message schema before you deploy the function. -You can define a topic's message schema in the {astra_ui}. +You can define a topic's message schema in the {astra-ui}. ==== + Optionally, you can declare a `logTopic` in the same way: `persistent://**TENANT_NAME**/**NAMESPACE_NAME**/**TOPIC_NAME**`. @@ -281,13 +281,13 @@ If there isn't a class in the file, the `className` is only the filename without bin/pulsar-admin functions list --tenant **TENANT_NAME** --namespace **NAMESPACE_NAME** ---- + -You can also check the {astra_ui} to confirm the function is listed on the tenant's *Functions* tab. +You can also check the {astra-ui} to confirm the function is listed on the tenant's *Functions* tab. + See <> for more information on testing and monitoring your function in {product}. -== Deploy functions in the {astra_ui} +== Deploy functions in the {astra-ui} -. In the {astra_ui} navigation menu, click *Streaming*, and then select a tenant. +. In the {astra-ui} navigation menu, click *Streaming*, and then select a tenant. . On the *Functions* tab, click *Create Function*. @@ -391,12 +391,12 @@ Your function should output the result of processing the message. [#controlling-your-function] === Stop and start functions -In the {astra_ui}, on your tenant's *Functions* tab, you can use *Function Controls* to start, stop, and restart functions. +In the {astra-ui}, on your tenant's *Functions* tab, you can use *Function Controls* to start, stop, and restart functions. === Monitor functions Functions produce logs to help you debug them. -In the {astra_ui}, on your tenant's *Functions* tab, you can view, refresh, copy, and download your functions' logs. +In the {astra-ui}, on your tenant's *Functions* tab, you can view, refresh, copy, and download your functions' logs. image::astream-function-log.png[Function Log] @@ -404,7 +404,7 @@ If you specified a log topic when deploying your function, function logs also ou === Edit functions -. In the {astra_ui}, on your tenant's *Functions* tab, click *Update Function*. +. In the {astra-ui}, on your tenant's *Functions* tab, click *Update Function*. . Edit the following settings as needed, and then click *Update*. + @@ -423,7 +423,7 @@ If you need to change any other function settings, you must delete and redeploy Deleting a function is permanent. ==== -. In the {astra_ui}, on your tenant's *Functions* tab, select the function to delete. +. In the {astra-ui}, on your tenant's *Functions* tab, select the function to delete. . Click *Delete*. diff --git a/modules/developing/pages/clients/spring-produce-consume.adoc b/modules/developing/pages/clients/spring-produce-consume.adoc index 8ebba95..78dca7c 100644 --- a/modules/developing/pages/clients/spring-produce-consume.adoc +++ b/modules/developing/pages/clients/spring-produce-consume.adoc @@ -40,7 +40,7 @@ include::{astra-streaming-examples-repo}/java/spring-boot/SpringBoot/src/main/ja ---- ==== -. Replace the following values in `DemoApplication.java` with values from your tenant's *Connect* tab in the {astra_ui}: +. Replace the following values in `DemoApplication.java` with values from your tenant's *Connect* tab in the {astra-ui}: + .DemoApplication.java [source,java,subs="+quotes"] @@ -101,7 +101,7 @@ Message received: Hello World ---- ==== -. In the {astra_ui}, go to your tenant to verify that the message appears in the specified namespace and topic. +. In the {astra-ui}, go to your tenant to verify that the message appears in the specified namespace and topic. == See also diff --git a/modules/developing/pages/configure-pulsar-env.adoc b/modules/developing/pages/configure-pulsar-env.adoc index 582d211..a66b17a 100644 --- a/modules/developing/pages/configure-pulsar-env.adoc +++ b/modules/developing/pages/configure-pulsar-env.adoc @@ -41,7 +41,7 @@ The executables in `/bin` use the configurations in `/conf` to run commands. Each tenant you create in {product} comes with its own custom configuration for SSO, endpoints, and so on. You must download the tenant configuration from {product}, and then overwrite the `./conf/client.conf` file. -. In the {astra_ui} navigation menu, click *Streaming*, and then select your tenant. +. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant. . Click the *Connect* tab, in the *{pulsar-short} CLI* section, click *Download client.conf*. diff --git a/modules/developing/pages/gpt-schema-translator.adoc b/modules/developing/pages/gpt-schema-translator.adoc index 4541269..713c9e6 100644 --- a/modules/developing/pages/gpt-schema-translator.adoc +++ b/modules/developing/pages/gpt-schema-translator.adoc @@ -23,7 +23,7 @@ The {gpt-schema-translator} is available for the {astra-db} sink connector only. This example uses a JSON schema for a {pulsar-short} topic, and a CQL schema for an {astra-db} table. The {gpt-schema-translator} generates a mapping between the two schemas that the {astra-db} sink connector can use to write data from the {pulsar-short} topic to the {astra-db} table. -. In the {astra_ui} navigation menu, click *Streaming*, and then select your tenant. +. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant. . On the *Namespaces and Topics* tab, locate the topic that you want to map to a table, and then click *Create mapping*. @@ -124,7 +124,7 @@ id=key, file1=value.file1, file2=value.file2, file3=value.file3 . Save the mapping configuration. . After configuring your {astra-db} sink connector for the given topic and table, messages should flow between the two schemas without error. -You can check the {astra_ui} logs to confirm that the data is flowing into your table without errors. +You can check the {astra-ui} logs to confirm that the data is flowing into your table without errors. [#pulsar-topic-to-cql-table] === AVRO-to-CQL mapping example @@ -410,7 +410,7 @@ This example demonstrates how you can generates schema mapping in real time. ---- ==== -. In the {astra_ui}, create a mapping for the tenant. +. In the {astra-ui}, create a mapping for the tenant. When a topic schema is available to the {gpt-schema-translator}, click *Generate Mapping*. + image::create-schema-mapping.png[Schema mapping,320,240] @@ -428,7 +428,7 @@ Notice that the `firstname` value became `firstName` because the {pulsar-short} If you don't declare a schema in the {pulsar-short} topic, the schema translator can generate a default schema mapping based on the values of your Cassandra table schema, without using GPT. -When you create the mapping in the {astra_ui}, you can click *Generate Mapping* to create a generic {pulsar-short} topic schema based on your Cassandra table schema. +When you create the mapping in the {astra-ui}, you can click *Generate Mapping* to create a generic {pulsar-short} topic schema based on your Cassandra table schema. If schema mapping isn't possible for the selected table and topic, the *Generate Mapping* button isn't available. For example, assume you have the following Cassandra table schema: diff --git a/modules/developing/pages/produce-consume-astra-portal.adoc b/modules/developing/pages/produce-consume-astra-portal.adoc index f191103..388aafa 100644 --- a/modules/developing/pages/produce-consume-astra-portal.adoc +++ b/modules/developing/pages/produce-consume-astra-portal.adoc @@ -1,11 +1,11 @@ -= Produce and consume messages in the {astra_ui} -:navtitle: {astra_ui} -:description: Use this guide to create and consume a topic message using the {astra_ui}. += Produce and consume messages in the {astra-ui} +:navtitle: {astra-ui} +:description: Use this guide to create and consume a topic message using the {astra-ui}. This guide assumes you have completed the xref:getting-started:index.adoc[{product} quickstart]. Now, it's time to produce and consume messages in your new streaming tenant. -The following steps will use the "Try Me" feature of the {astra_ui} to interact with an existing topic. +The following steps will use the "Try Me" feature of the {astra-ui} to interact with an existing topic. == Select the producer and consumer topics diff --git a/modules/developing/pages/using-curl.adoc b/modules/developing/pages/using-curl.adoc index 8b69cea..eed6727 100644 --- a/modules/developing/pages/using-curl.adoc +++ b/modules/developing/pages/using-curl.adoc @@ -12,7 +12,7 @@ Depending on the API you use, you need certain information to form HTTP requests == Get the tenant web service URL -. In the {astra_ui} navigation menu, click *Streaming*, and then select your tenant. +. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant. . Click the *Connect* tab. diff --git a/modules/developing/partials/client-variables-table.adoc b/modules/developing/partials/client-variables-table.adoc index 7ad7406..f10d539 100644 --- a/modules/developing/partials/client-variables-table.adoc +++ b/modules/developing/partials/client-variables-table.adoc @@ -4,7 +4,7 @@ |`serviceUrl` |The URL to connect to the {pulsar-short} cluster -|In the {astra_ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Connect* tab. +|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Connect* tab. In the *Details* section, get the *Broker Service URL*. |`pulsarToken` @@ -13,17 +13,17 @@ In the *Details* section, get the *Broker Service URL*. |`tenantName` |The name of your streaming tenant -|In the {astra_ui} navigation menu, click *Streaming*, select your streaming tenant. +|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant. In the *Details* section, get the *Name*. |`namespace` |The segmented area for certain topics in your streaming tenant -|In the {astra_ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Namespace and Topics* tab. +|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Namespace and Topics* tab. Choose the target namespace from the list of namespaces. |`topicName` |Topic name (not the full name) -|In the {astra_ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Namespace and Topics* tab. +|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Namespace and Topics* tab. Expand the target namespace in the list of namespaces to view the names of the topics within. Do _not_ use the *Full Name*. |=== \ No newline at end of file diff --git a/modules/getting-started/pages/index.adoc b/modules/getting-started/pages/index.adoc index 7f6b400..461362f 100644 --- a/modules/getting-started/pages/index.adoc +++ b/modules/getting-started/pages/index.adoc @@ -2,14 +2,14 @@ :navtitle: Get started :page-tag: astra-streaming,planner,quickstart,pulsar -{product} is a serverless data streaming and event stream processing service integrated in the {astra_ui} and powered by {pulsar-reg}. +{product} is a serverless data streaming and event stream processing service integrated in the {astra-ui} and powered by {pulsar-reg}. Using {product}, you can create {pulsar-short} instances, manage streaming clusters, scale across cloud regions, and manage {pulsar-short} resources such as topics, connectors, functions and subscriptions. This quickstart demonstrates how to create and use a streaming tenant running {pulsar-short}. == Prerequisites -* An active {url-astra}[{product-short} account^] +* An active {astra-url}[{product-short} account^] == Create a streaming tenant @@ -17,10 +17,10 @@ A {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]. -You can create a tenant in the {astra_ui} or programmatically. -For this quickstart, use the {astra_ui}. +You can create a tenant in the {astra-ui} or programmatically. +For this quickstart, use the {astra-ui}. -. In the {astra_ui} navigation menu, click *Streaming*. +. In the {astra-ui} navigation menu, click *Streaming*. . Click *Create a Tenant*. @@ -45,11 +45,11 @@ You can use the default namespace or create other namespaces. Tenants usually have many namespaces. To learn more about namespaces, see the https://pulsar.apache.org/docs/concepts-messaging/#namespaces[{pulsar-short} documentation]. -You can create namespaces in the {astra_ui} or programmatically. -For this quickstart, use the {astra_ui}. +You can create namespaces in the {astra-ui} or programmatically. +For this quickstart, use the {astra-ui}. For information about the {pulsar-short} CLI or APIs, see xref:developing:configure-pulsar-env.adoc[] and xref:developing:using-curl.adoc[]. -. In the {astra_ui} navigation menu, click *Streaming*, and then select your tenant. +. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant. . Click the *Namespace And Topics* tab, and then click *Create Namespace*. @@ -70,9 +70,9 @@ Consumers subscribe to topics to receive messages, and functions and connectors In {pulsar-short}, topic addresses are formatted like URLs, such as `persistent://tenant/namespace/topic`. To learn more about topics, see the https://pulsar.apache.org/docs/concepts-messaging/#topics[{pulsar-short} documentation]. -As in the previous steps, you can create topics in the {astra_ui} or programmatically. +As in the previous steps, you can create topics in the {astra-ui} or programmatically. -. In the {astra_ui} navigation menu, click *Streaming*, and then select your tenant. +. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant. . Click the *Namespace And Topics* tab. @@ -89,6 +89,6 @@ Disregard the https://pulsar.apache.org/docs/concepts-messaging/#partitioned-top Your new topic is ready to produce and consume messages. There are several different ways to do this: -* xref:developing:produce-consume-astra-portal.adoc[{astra_ui}]: Use {product}'s "Try Me" feature in the {astra_ui}. +* xref:developing:produce-consume-astra-portal.adoc[{astra-ui}]: Use {product}'s "Try Me" feature in the {astra-ui}. * xref:developing:produce-consume-pulsar-client.adoc[{pulsar-short} Client]: Use the {pulsar-short} CLI to interact with the topic. * xref:developing:clients/index.adoc[Runtime Clients]: Create a client application that interacts with {pulsar-short}. \ No newline at end of file diff --git a/modules/operations/pages/astream-georeplication.adoc b/modules/operations/pages/astream-georeplication.adoc index 0a2d72b..b8e898b 100644 --- a/modules/operations/pages/astream-georeplication.adoc +++ b/modules/operations/pages/astream-georeplication.adoc @@ -131,7 +131,7 @@ key:[null], properties:[], content:hello-from-pulsar key:[null], properties:[], content:hello-from-pulsar ---- -. In the {astra_ui}, go to your tenant's **Namespaces and Topics** tab. +. In the {astra-ui}, go to your tenant's **Namespaces and Topics** tab. . Make sure `persistent://**TENANT_NAME**/**NAMESPACE_NAME**/**TOPIC_NAME**` is visible and shows traffic across all regions. @@ -256,7 +256,7 @@ In the configuration, `isReplicated` is now `true` for this subscription. [#monitor] == Monitor replicated clusters -{product} exposes the following topic-level replication metrics, which can be viewed in the **Overview** section of **Namespaces and Topics** in the {astra_ui}: +{product} exposes the following topic-level replication metrics, which can be viewed in the **Overview** section of **Namespaces and Topics** in the {astra-ui}: include::operations:partial$georeplication-monitoring.adoc[] diff --git a/modules/operations/pages/astream-limits.adoc b/modules/operations/pages/astream-limits.adoc index 165eaf8..0c89ffe 100644 --- a/modules/operations/pages/astream-limits.adoc +++ b/modules/operations/pages/astream-limits.adoc @@ -104,7 +104,7 @@ These namespace policies are initially provisioned in the default settings for { [cols="1,1,1"] |=== -|Policy |Default Setting |Available in the {astra_ui} +|Policy |Default Setting |Available in the {astra-ui} |Max retention time |Disabled/no data retention by default @@ -259,11 +259,11 @@ The following is an example of a default namespace policy with limits set. == {product} topic and namespace actions These topic and namespace actions are provisioned in the default settings by {product}. -You can perform these actions in the {astra_ui} or programmatically with a sufficiently authorized role or authentication token. +You can perform these actions in the {astra-ui} or programmatically with a sufficiently authorized role or authentication token. [cols="1,1,1"] |=== -|Allowed Action |Default Setting |Available in the {astra_ui} +|Allowed Action |Default Setting |Available in the {astra-ui} |Terminate topic |Enabled diff --git a/modules/operations/pages/astream-release-notes.adoc b/modules/operations/pages/astream-release-notes.adoc index 5c6d156..070e602 100644 --- a/modules/operations/pages/astream-release-notes.adoc +++ b/modules/operations/pages/astream-release-notes.adoc @@ -72,7 +72,7 @@ Organizations on the *Free* plan can use xref:streaming-learning:functions:index === {new} -* Launched a refreshed {astra_ui}. +* Launched a refreshed {astra-ui}. == Previous releases diff --git a/modules/operations/pages/astream-scrape-metrics.adoc b/modules/operations/pages/astream-scrape-metrics.adoc index 2ad0762..f29f3c1 100644 --- a/modules/operations/pages/astream-scrape-metrics.adoc +++ b/modules/operations/pages/astream-scrape-metrics.adoc @@ -11,7 +11,7 @@ This doc will show you how to scrape an {product} tenant with Prometheus. == Get the configuration file from {product} -. In the {astra_ui} navigation menu, click *Streaming*, and then select your tenant. +. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant. . On the *Connect* tab, click *Prometheus* to generate a new configuration file: + diff --git a/modules/operations/pages/astream-token-gen.adoc b/modules/operations/pages/astream-token-gen.adoc index 8f1ee62..93b09c8 100644 --- a/modules/operations/pages/astream-token-gen.adoc +++ b/modules/operations/pages/astream-token-gen.adoc @@ -5,7 +5,7 @@ [#astra-token] == {astra-db} application tokens -{astra-db} application tokens are access tokens for authentication to the {astra_ui} and the xref:apis:index.adoc[{product} {devops-api}]. +{astra-db} application tokens are access tokens for authentication to the {astra-ui} and the xref:apis:index.adoc[{product} {devops-api}]. You need an application token for actions related to {astra-db} organizations and databases. @@ -21,7 +21,7 @@ You need a {pulsar-short} JWT for actions related to {pulsar-short} tenants, nam You can generate, copy, or delete {product} {pulsar-short} tokens for each of your {product} tenants: -. In the {astra_ui} navigation menu, click *Streaming*. +. In the {astra-ui} navigation menu, click *Streaming*. . Select the tenant for which you want to manage tokens. diff --git a/modules/operations/pages/monitoring/integration.adoc b/modules/operations/pages/monitoring/integration.adoc index 0283c03..7454ac5 100644 --- a/modules/operations/pages/monitoring/integration.adoc +++ b/modules/operations/pages/monitoring/integration.adoc @@ -2,7 +2,7 @@ :navtitle: Integrate external Prometheus and Grafana {product} exposes some of the {pulsar-reg} metrics through Prometheus endpoints. -The Prometheus configuration information to scrape {product} metrics into an external Prometheus server is found in the {astra_ui}. +The Prometheus configuration information to scrape {product} metrics into an external Prometheus server is found in the {astra-ui}. This page explains how to set up a Prometheus server in a Kubernetes cluster and configure it to scrape {product} metrics. @@ -15,7 +15,7 @@ This page explains how to set up a Prometheus server in a Kubernetes cluster and This example uses the https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack[Prometheus Community Kubernetes Helm Charts] to set up a Prometheus server and a Grafana server in a Kubernetes cluster. -. Download the {product} Prometheus configuration from the {astra_ui}. +. Download the {product} Prometheus configuration from the {astra-ui}. For more information, see https://docs.datastax.com/en/streaming/astra-streaming/operations/astream-scrape-metrics.html[Scrape metrics from {product}]. . Use the downloaded file to create a `config.yml`. diff --git a/modules/operations/pages/monitoring/stream-audit-logs.adoc b/modules/operations/pages/monitoring/stream-audit-logs.adoc index c01cbfd..6a4277e 100644 --- a/modules/operations/pages/monitoring/stream-audit-logs.adoc +++ b/modules/operations/pages/monitoring/stream-audit-logs.adoc @@ -12,7 +12,7 @@ To enable audit log streaming, you must do one of the following: Audit log streaming requires a streaming tenant in the AWS `us-east-2` region. You can create a new tenant with the xref:astra-streaming:getting-started:index.adoc[{product} quickstart] or use an existing {product} tenant. -. In the {link-astra-portal}, go to **Streaming**. +. In the {astra-ui-link}, go to **Streaming**. . Select an existing tenant or create a streaming tenant in AWS `us-east-2`, and then create a namespace and topic in the tenant. + @@ -23,7 +23,7 @@ For more information about creating tenants, namespaces, and topics, see xref:as . If necessary, create additional audit log topics, and then record the **Full Name** for each topic. You can use topics to organize audit logs by event type or other criteria. -. In the {link-astra-portal}, go to **Streaming**, and then click your audit log streaming tenant. +. In the {astra-ui-link}, go to **Streaming**, and then click your audit log streaming tenant. . On the *Connect* tab, click **Download client.conf**. @@ -37,7 +37,7 @@ You can use topics to organize audit logs by event type or other criteria. 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. -. In the {link-astra-portal}, create an application token with the **Organization Administrator** role. +. In the {astra-ui-link}, create an application token with the **Organization Administrator** role. . Create the audit log streaming configuration using the values from the tenant's `client.conf` file and your {pulsar-short} configuration: + diff --git a/modules/operations/pages/onboarding-faq.adoc b/modules/operations/pages/onboarding-faq.adoc index 430ba24..59b282c 100644 --- a/modules/operations/pages/onboarding-faq.adoc +++ b/modules/operations/pages/onboarding-faq.adoc @@ -34,7 +34,7 @@ For more information, see xref:operations:astream-pricing.adoc[]. == Does {product} support single-sign on? -If your {astra-db} organization is on the *Pay As You Go* or *Enterprise* {astra-db} subscription plan, your users can use SSO to sign in to the {astra_ui}. +If your {astra-db} organization is on the *Pay As You Go* or *Enterprise* {astra-db} subscription plan, your users can use SSO to sign in to the {astra-ui}. For more information, see xref:astra-db-serverless:administration:configure-sso.adoc[]. == How do {astra-db} roles and permissions map to {pulsar-short} roles and permissions? From c3f1f20d1b357df084b81342353f822cb4e8ee77 Mon Sep 17 00:00:00 2001 From: April M Date: Thu, 13 Feb 2025 14:46:03 -0800 Subject: [PATCH 3/5] attributes pt 3 --- antora.yml | 7 +++---- modules/ROOT/pages/astream-faq.adoc | 4 ++-- modules/developing/pages/astra-cli.adoc | 2 +- .../pages/gpt-schema-translator.adoc | 20 +++++++++---------- 4 files changed, 16 insertions(+), 17 deletions(-) diff --git a/antora.yml b/antora.yml index 1c5a9cb..59e32ac 100644 --- a/antora.yml +++ b/antora.yml @@ -17,12 +17,13 @@ asciidoc: product: 'Astra Streaming' product-short: 'Astra' astra-cli: 'Astra CLI' - astra-ui: 'Astra Portal' astra-url: 'https://astra.datastax.com' astra-ui-link: '{astra-url}[{astra-ui}^] - devops-api: 'DevOps API' + cass: 'Apache Cassandra' + cass-reg: 'Apache Cassandra(R)' + cass-short: 'Cassandra' pulsar: 'Apache Pulsar' pulsar-short: 'Pulsar' pulsar-reg: 'Apache Pulsar(TM)' @@ -31,8 +32,6 @@ asciidoc: kafka-for-astra: 'Starlight for Kafka' starlight-rabbitmq: 'Starlight for RabbitMQ' gpt-schema-translator: 'GPT schema translator' - - link-astra-portal: '{url-astra}[{astra-ui}^]' astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master' # LEGACY ATTRIBUTES - CONSIDER REMOVING diff --git a/modules/ROOT/pages/astream-faq.adoc b/modules/ROOT/pages/astream-faq.adoc index d3fe723..2c66007 100644 --- a/modules/ROOT/pages/astream-faq.adoc +++ b/modules/ROOT/pages/astream-faq.adoc @@ -30,7 +30,7 @@ And finally {product} offers a user-friendly interface and free tier to satisfy == What is CDC for {astra-db}? -Change Data Capture (CDC) for {astra-db} uses a {pulsar-short} IO source connector that processes changes from the Cassandra Change Agent through a {pulsar-short} topic. +Change Data Capture (CDC) for {astra-db} uses a {pulsar-short} IO source connector that processes changes from the {cass-short} Change Agent through a {pulsar-short} topic. For more information, see xref:developing:astream-cdc.adoc[]. == What are tenants, namespaces, topics, and sinks? @@ -38,7 +38,7 @@ For more information, see xref:developing:astream-cdc.adoc[]. *Tenants* are an isolated administrative unit for which an authorization scheme can be set and a set of clusters can be defined. Each tenant can have multiple *namespaces*, a logical container for creating and managing a hierarchy of topics. A *topic* is a named channel for transmitting messages from producers to consumers. -A *sink* feeds data from {product} to an external system, such as {cassandra} or Elasticsearch. +A *sink* feeds data from {product} to an external system, such as {cass-reg} or Elasticsearch. == See also diff --git a/modules/developing/pages/astra-cli.adoc b/modules/developing/pages/astra-cli.adoc index a98a385..4fe25e3 100644 --- a/modules/developing/pages/astra-cli.adoc +++ b/modules/developing/pages/astra-cli.adoc @@ -25,4 +25,4 @@ You can use {astra-cli} instead of or in addition to the {astra-ui} and {astra-d For more information, see the following: -* https://www.datastax.com/blog/introducing-cassandra-astra-cli[Accelerate your Cassandra development and automation with the {astra-cli}] +* https://www.datastax.com/blog/introducing-cassandra-astra-cli[Accelerate your {cass-short} development and automation with the {astra-cli}] diff --git a/modules/developing/pages/gpt-schema-translator.adoc b/modules/developing/pages/gpt-schema-translator.adoc index 713c9e6..3ad0c30 100644 --- a/modules/developing/pages/gpt-schema-translator.adoc +++ b/modules/developing/pages/gpt-schema-translator.adoc @@ -3,13 +3,13 @@ Systems in streaming pipelines can use different representations for schema and data types. Schema mapping is required to align congruent types in a pipeline. -For example, to send data from a CDC-enabled {cassandra} table to a {pulsar-reg} topic, you must define schema mapping between the Cassandra table and the {pulsar-short} topic. +For example, to send data from a CDC-enabled {cass-reg} table to a {pulsar-reg} topic, you must define schema mapping between the {cass-short} table and the {pulsar-short} topic. If the schema includes more complex data types, like maps and nested data structures, schema management becomes more difficult. Schema management is a complicated, tedious, and error-prone tasks that requires you to understand and translate multiple sets of schema rules. Instead, you can use the {gpt-schema-translator} to save time and reduce schema mapping toil. -This tool uses generative AI,based on the `GPT-4` model, to automatically generate schema mappings between {product} ({pulsar-short} topics) and the {astra-db} sink connector (Cassandra tables). +This tool uses generative AI,based on the `GPT-4` model, to automatically generate schema mappings between {product} ({pulsar-short} topics) and the {astra-db} sink connector ({cass-short} tables). == Prerequisites @@ -35,12 +35,12 @@ If this button isn't available, the GPT schema translator doesn't have an availa + image::two-schemas.png[Schema mapping,320,240] + -.Cassandra-to-{pulsar-short} schema mapping example +.{cass-short}-to-{pulsar-short} schema mapping example [%collapsible] ==== [cols="1,1,1"] |=== -| Cassandra table schema | {pulsar-short} JSON schema | Generated mapping +| {cass-short} table schema | {pulsar-short} JSON schema | Generated mapping a| [source,cql] @@ -369,7 +369,7 @@ This example demonstrates how you can generates schema mapping in real time. ---- ==== -. The {astra-db} sink connector writes data to the Cassandra table with a CQL schema. +. The {astra-db} sink connector writes data to the {cass-short} table with a CQL schema. + .CQL schema example [%collapsible] @@ -422,16 +422,16 @@ The {gpt-schema-translator} generates an AVRO-to-CQL schema mapping while messag passportnumber=value.passportNumber, age=value.age, firstname=value.firstName, lastname=value.lastName ---- + -Notice that the `firstname` value became `firstName` because the {pulsar-short} topic AVRO schema superseded the Cassandra table schema. +Notice that the `firstname` value became `firstName` because the {pulsar-short} topic AVRO schema superseded the {cass-short} table schema. == No schema on {pulsar-short} topic -If you don't declare a schema in the {pulsar-short} topic, the schema translator can generate a default schema mapping based on the values of your Cassandra table schema, without using GPT. +If you don't declare a schema in the {pulsar-short} topic, the schema translator can generate a default schema mapping based on the values of your {cass-short} table schema, without using GPT. -When you create the mapping in the {astra-ui}, you can click *Generate Mapping* to create a generic {pulsar-short} topic schema based on your Cassandra table schema. +When you create the mapping in the {astra-ui}, you can click *Generate Mapping* to create a generic {pulsar-short} topic schema based on your {cass-short} table schema. If schema mapping isn't possible for the selected table and topic, the *Generate Mapping* button isn't available. -For example, assume you have the following Cassandra table schema: +For example, assume you have the following {cass-short} table schema: [source,cql] ---- @@ -466,7 +466,7 @@ For example, assume you have the following Cassandra table schema: } ---- -The schema translator would generate the following {pulsar-short} JSON schema mapping based on the given Cassandra table schema: +The schema translator would generate the following {pulsar-short} JSON schema mapping based on the given {cass-short} table schema: [source,plain] ---- From f910a18fcb05958a0515fcecd7f894c2c547382e Mon Sep 17 00:00:00 2001 From: April M Date: Thu, 13 Feb 2025 15:04:55 -0800 Subject: [PATCH 4/5] syntax --- antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora.yml b/antora.yml index 59e32ac..bafe742 100644 --- a/antora.yml +++ b/antora.yml @@ -19,7 +19,7 @@ asciidoc: astra-cli: 'Astra CLI' astra-ui: 'Astra Portal' astra-url: 'https://astra.datastax.com' - astra-ui-link: '{astra-url}[{astra-ui}^] + astra-ui-link: '{astra-url}[{astra-ui}^]' devops-api: 'DevOps API' cass: 'Apache Cassandra' cass-reg: 'Apache Cassandra(R)' From 9618930d052fccce324005b4d8dce056529cb082 Mon Sep 17 00:00:00 2001 From: April M Date: Thu, 13 Feb 2025 15:34:00 -0800 Subject: [PATCH 5/5] slight changes/copying for accuracy --- modules/developing/pages/using-curl.adoc | 6 ++-- .../operations/pages/astream-token-gen.adoc | 31 ++++++++++++++++--- .../pages/monitoring/stream-audit-logs.adoc | 2 +- 3 files changed, 30 insertions(+), 9 deletions(-) diff --git a/modules/developing/pages/using-curl.adoc b/modules/developing/pages/using-curl.adoc index eed6727..cc95d74 100644 --- a/modules/developing/pages/using-curl.adoc +++ b/modules/developing/pages/using-curl.adoc @@ -2,13 +2,13 @@ :navtitle: Form HTTP requests :description: Interact with {product} over HTTP, such as with curl commands. -You can use the xref:apis:index.adoc[{product} APIs] and https://pulsar.apache.org/docs/reference-rest-api-overview/[{pulsar-reg} REST APIs] to programmatically interact with your tenants and related {product} configurations. +You can use the xref:apis:index.adoc[{devops-api}s] and https://pulsar.apache.org/docs/reference-rest-api-overview/[{pulsar-reg} REST APIs] to programmatically interact with your tenants and related {product} configurations. Each API supports different functionalities. Depending on the API you use, you need certain information to form HTTP requests: * To use the {product} {pulsar-short} Admin API and {pulsar-short} REST APIs, you need the tenant's Web Service URL and {pulsar-short} token. -* To use the {product} {devops-api}, you need an xref:operations:astream-token-gen.adoc[{astra-db} application token]. +* To use the {devops-api}s, you need an xref:operations:astream-token-gen.adoc[{astra-db} application token]. == Get the tenant web service URL @@ -16,7 +16,7 @@ Depending on the API you use, you need certain information to form HTTP requests . Click the *Connect* tab. -. In the *Details* section, locate the *Tenant Details*. +. Locate the *Tenant Details* section. Here you can find the essential information you need to communicate with your {pulsar-short} tenant, including the *Web Service URL*. + image:tenant-details.png[Tenant details in {product}] diff --git a/modules/operations/pages/astream-token-gen.adoc b/modules/operations/pages/astream-token-gen.adoc index 93b09c8..17e4c42 100644 --- a/modules/operations/pages/astream-token-gen.adoc +++ b/modules/operations/pages/astream-token-gen.adoc @@ -3,13 +3,11 @@ {product} uses two types of tokens that you can generate in {astra-db}. [#astra-token] -== {astra-db} application tokens +== Application tokens -{astra-db} application tokens are access tokens for authentication to the {astra-ui} and the xref:apis:index.adoc[{product} {devops-api}]. +{astra-db} application tokens are access tokens for authentication to the {astra-ui} and the xref:apis:index.adoc[{devops-api}s]. -You need an application token for actions related to {astra-db} organizations and databases. - -For information about creating and managing {astra-db} application tokens, see xref:astra-db-serverless:administration:manage-application-tokens.adoc[]. +To create an {astra-db} application token, see xref:astra-db-serverless:administration:manage-application-tokens.adoc[]. [#pulsar-token] == {product} {pulsar-short} tokens @@ -45,6 +43,29 @@ The token is shown only once. Ensure you update your application with a new, valid {pulsar-short} token before deletion. Applications using the deleted {pulsar-short} token will no longer be able to connect to {product}. +== Set environment variables + +Create environment variables for your tenant's {pulsar-short} token and tenant web service URL: + +. Create a <>. + +. On your tenant's *Connect* tab, copy the *Web Service URL*. + +. Set environment variables: ++ +[source,shell,subs="attributes+"] +---- +export WEB_SERVICE_URL= +export ASTRA_STREAMING_TOKEN= +---- + +. Use these values to form curl commands: ++ +[source,shell,subs="attributes+"] +---- +curl "$WEB_SERVICE_URL/admin/v3/sinks/builtinsinks" -H "Authorization: $ASTRA_STREAMING_TOKEN" +---- + == Usage examples The following examples show how you can use the two tokens for different actions. diff --git a/modules/operations/pages/monitoring/stream-audit-logs.adoc b/modules/operations/pages/monitoring/stream-audit-logs.adoc index 6a4277e..0455160 100644 --- a/modules/operations/pages/monitoring/stream-audit-logs.adoc +++ b/modules/operations/pages/monitoring/stream-audit-logs.adoc @@ -37,7 +37,7 @@ You can use topics to organize audit logs by event type or other criteria. 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. -. In the {astra-ui-link}, create an application token with the **Organization Administrator** role. +. In the {astra-ui-link}, create an {astra-db} application token with the **Organization Administrator** role. . Create the audit log streaming configuration using the values from the tenant's `client.conf` file and your {pulsar-short} configuration: +