Astra CLI 1.0 Release

antora.yml

@@ -19,7 +19,7 @@ asciidoc:
     astra-db: 'Astra DB'
     product: 'Astra CLI'
     product-short: 'Astra'
-    product-version: '0.6'
+    product-version: '1.0'
     db-serverless: 'Serverless (Non-Vector)'
     db-serverless-vector: 'Serverless (Vector)'
     db-classic: 'Classic'

modules/ROOT/pages/administration.adoc → in-progress/administration.adoc

@@ -1,5 +1,5 @@
-= Manage your {product-short} organization with the {product}
-:navtitle: Manage {product-short} administration
+// Writer's note: This page is no longer published but there is still content that should be retained and reformatted for Astra CLI 1.0.
+= {product-short} administration commands
 
 Use the {product} to manage your {product-short} organization.
 

modules/ROOT/pages/astra-streaming-cli.adoc → in-progress/astra-streaming-cli.adoc

@@ -1,5 +1,5 @@
-= Manage {astra_stream} with the {product}
-:navtitle: Manage {astra_stream}
+// Writer's note: This page is no longer published but there is still content that should be retained and reformatted for Astra CLI 1.0.
+= {astra_stream} commands
 
 Use the {product} to manage your {astra_stream} deployments.
 
@@ -727,7 +727,7 @@ OPTIONS
 The https://pulsar.apache.org/docs/next/administration-pulsar-shell/[Pulsar shell] is an interactive command-line interface tool for managing and interacting with Pulsar clusters.
 It is designed to allow developers and administrators to execute Pulsar commands interactively or in a script-like fashion, facilitating tasks such as creating topics, producing and consuming messages, managing schemas, and more.
 
-The {product} provides built-in Pulsar shell support by downloading, installing, configuring, and wapping the `pulsar-shell` utility.
+The {product} provides built-in Pulsar shell support by downloading, installing, configuring, and wrapping the `pulsar-shell` utility.
 
 Use the `astra streaming pulsar-shell` command to start the Pulsar shell in interactive mode:
 
@@ -756,7 +756,7 @@ default(pulsar-aws-useast2.streaming.datastax.com)>
 ----
 ====
 
-Type `exit` and press kbd:[Return] to exit the Pulsar shell.
+Type `exit` and press kbd:[Enter] to exit the Pulsar shell.
 
 The first time you use the `astra streaming pulsar-shell` commands, the {product} downloads and installs the `pulsar-shell` utility to the {product} installation directory (`~/.astra/lunastreaming-shell-*`).
 

in-progress/change-data-capture.adoc

@@ -0,0 +1,153 @@
+= Configure Change Data Capture (CDC) with the {product}
+:navtitle:  Change Data Capture quickstart
+
+Change Data Capture (CDC) for {astra_db} automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into xref:astra-streaming:ROOT:index.adoc[{astra_stream}] where it can be processed by client applications or sent to downstream systems.
+
+This page provides an end-to-end example that shows you how to use the {product} to enable CDC for an {astra-db} database.
+
+== Create a database
+
+Create an {astra_db} database:
+
+[source,shell]
+----
+astra db create cdc_demo_db -r us-east1 -k cdc_demo_keyspace
+----
+
+.Result
+[%collapsible]
+====
+[source,console]
+----
+Database 'cdc_demo_db' has been created with id 'ce5e563c-3248-4064-b03c-5892433a1347'. It is now active after waiting 422 seconds.
+----
+====
+
+== Create a streaming tenant
+
+Create an {astra_stream} tenant in the same region as your database:
+
+[source,shell]
+----
+astra streaming create cdc-demo-tenant -c gcp -r useast1
+----
+
+.Result
+[%collapsible]
+====
+[source,console]
+----
+https://api.astra.datastax.com/v2/streaming/tenants/cdc-demo-tenant
+[OK]    Tenant 'cdc-demo-tenant' has being created.
+----
+====
+
+== Create a table in your database
+
+Use `xref:commands:astra-db-cqlsh-exec.adoc[]` to create a table with a primary key column in your database:
+
+[source,shell]
+----
+astra db cqlsh exec cdc_demo_db \
+    "CREATE TABLE IF NOT EXISTS cdc_demo_keyspace.cdc_demo_table ( \
+        key text PRIMARY KEY, \
+        c1 text \
+    );"
+----
+
+.Result
+[%collapsible]
+====
+[source,console]
+----
+[INFO]  Cqlsh is starting, please wait for connection establishment...
+----
+====
+
+Confirm table creation:
++
+[source,shell]
+----
+astra db cqlsh exec cdc_demo_db \
+    "SELECT * FROM cdc_demo_keyspace.cdc_demo_table"
+----
+
+.Result
+[%collapsible]
+====
+[source,console]
+----
+[INFO]  Cqlsh is starting, please wait for connection establishment...
+
+ key | c1
+-----+----
+
+(0 rows)
+----
+====
+
+== Create a CDC connection
+
+Use `xref:commands:astra-db-create-cdc.adoc[]` to create a CDC connection between your database table and streaming tenant:
+
+[source,shell]
+----
+astra db create-cdc cdc_demo_db \
+    -k cdc_demo_keyspace \
+    --table cdc_demo_table \
+    --tenant cdc-demo-tenant
+----
++
+////
+// TODO: The command is not working as expected. Must investigate and figure out why it is reporting the following error: [ERROR] INVALID_ARGUMENT: Error Code=422(422) Invalid information provided to create DB: 422 Unprocessable Entity: databaseId, keyspace, tableName, and orgId are mandatory fields
+.Result
+[%collapsible]
+====
+[source,console]
+----
+
+----
+====
+////
+
+Use `xref:commands:astra-db-list-cdcs.adoc[]` to confirm CDC details for the database and tenant:
+
+[source,shell]
+----
+astra db list-cdcs cdc_demo_db
+----
+
+.Result
+[%collapsible]
+====
+[source,console]
+----
++-----------------------+-------------------+----------------+----------------+--------------------+----------------+----------------+
+| id                    | keyspace          | table          | tenant         | cluster            | namespace      | Status         |
++-----------------------+-------------------+----------------+----------------+--------------------+----------------+----------------+
+| 57a3024f-cdcdemotable | cdc_demo_keyspace | cdc_demo_table | cdc-demo-tenant| pulsar-aws-useast1 | astracdc       | Running        |
++-----------------------+-------------------+----------------+----------------+--------------------+----------------+----------------+
+----
+====
+
+[source,shell]
+----
+astra streaming list-cdc cdc-demo-tenant
+----
+
+.Result
+[%collapsible]
+====
+[source,console]
+----
++--------------------+----------------+----------------+-------------------+----------------+----------------+
+| cluster            | namespace      | database       | keyspace          | table          | status         |
++--------------------+----------------+----------------+-------------------+----------------+----------------+
+| pulsar-aws-useast1 | astracdc       | cdc_demo_db    | cdc_demo_keyspace | cdc_demo_table | running        |
++--------------------+----------------+----------------+-------------------+----------------+----------------+
+----
+====
+
+== Connect a sink
+
+After you enable CDC on your {db-serverless} database, you're ready to xref:astra-streaming:developing:astream-cdc.adoc#connect-a-sink[connect a sink].