diff --git a/antora.yml b/antora.yml index f90f839..1129196 100644 --- a/antora.yml +++ b/antora.yml @@ -8,17 +8,12 @@ nav: asciidoc: attributes: - # General attributes company: 'DataStax' - # Other product attributes - cass-reg: 'Apache Cassandra(R)' - cass: 'Apache Cassandra' - cass-short: 'Cassandra' - # Astra DB attributes astra-db: 'Astra DB' product: 'Astra CLI' product-short: 'Astra' product-version: '1.0' + product-repo: 'https://github.com/datastax/astra-cli' db-serverless: 'Serverless (non-vector)' db-serverless-vector: 'Serverless (vector)' db-classic: 'Managed Cluster' @@ -30,3 +25,8 @@ asciidoc: scb: 'Secure Connect Bundle (SCB)' scb-short: 'SCB' scb-brief: 'Secure Connect Bundle' + dsbulk: 'DataStax Bulk Loader (DSBulk)' + dsbulk-short: 'DSBulk' + cql: 'Cassandra Query Language (CQL)' + cql-shell: 'CQL shell' + pulsar-short: 'Pulsar' \ No newline at end of file diff --git a/in-progress/astra-streaming-cli.adoc b/in-progress/astra-streaming-cli.adoc index 8f3bd43..90e7cdd 100644 --- a/in-progress/astra-streaming-cli.adoc +++ b/in-progress/astra-streaming-cli.adoc @@ -283,7 +283,7 @@ astra streaming status **TENANT_NAME** ---- ==== -Use the `astra streaming pulsar-token` command to get the Pulsar token for a specific tenant: +Use the `astra streaming pulsar-token` command to get the {pulsar-short} token for a specific tenant: [source,bash,subs="+quotes"] ---- @@ -722,14 +722,14 @@ OPTIONS ---- ==== -== Use the Pulsar shell +== Use the {pulsar-short} shell -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 https://pulsar.apache.org/docs/next/administration-pulsar-shell/[{pulsar-short} shell] is an interactive command-line interface tool for managing and interacting with {pulsar-short} clusters. +It is designed to allow developers and administrators to execute {pulsar-short} 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 wrapping the `pulsar-shell` utility. +The {product} provides built-in {pulsar-short} 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: +Use the `astra streaming pulsar-shell` command to start the {pulsar-short} shell in interactive mode: [source,bash,subs="+quotes"] ---- @@ -756,7 +756,7 @@ default(pulsar-aws-useast2.streaming.datastax.com)> ---- ==== -Type `exit` and press kbd:[Enter] to exit the Pulsar shell. +Type `exit` and press kbd:[Enter] to exit the {pulsar-short} 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-*`). @@ -825,7 +825,7 @@ OPTIONS ---- ==== -Use the `-e`/`--execute` option to execute a Pulsar shell command: +Use the `-e`/`--execute` option to execute a {pulsar-short} shell command: [source,bash,subs="+quotes"] ---- @@ -834,7 +834,7 @@ astra streaming pulsar-shell **TENANT_NAME** -e "admin namespaces list **TENANT_ // TODO: Add the output of the command. The command reported a Java-related error. Determine if more java prerequisites are needed. -Use the `-f`/`--file` option to execute Pulsar shell commands from a file: +Use the `-f`/`--file` option to execute {pulsar-short} shell commands from a file: [source,bash,subs="+quotes"] ---- @@ -843,9 +843,9 @@ astra streaming pulsar-shell **TENANT_NAME** -f sample.txt // TODO: Add sample.txt content and the output of the command. -=== Pulsar shell example +=== {pulsar-short} shell example -The following procedure shows an example of how to use the {product}'s built-in Pulsar shell support to write and read in a topic with a client: +The following procedure shows an example of how to use the {product}'s built-in {pulsar-short} shell support to write and read in a topic with a client: . Create a tenant: + @@ -864,7 +864,7 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant ---- ==== -. In two separate terminals, run the following command to start the Pulsar shell in each terminal: +. In two separate terminals, run the following command to start the {pulsar-short} shell in each terminal: + [source,bash] ---- @@ -1033,7 +1033,7 @@ OPTIONS == Create environment variables -When developing applications with {astra-stream} APIs, you will notice common values that are frequently reused, such as Pulsar tokens, broker URLs, and web service URLs. +When developing applications with {astra-stream} APIs, you will notice common values that are frequently reused, such as {pulsar-short} tokens, broker URLs, and web service URLs. It's a good practice to store these values in environment variables to facilitate reuse in your scripts, simplify token rotation, and increase security by keeping sensitive information separate from your core application code. The {product} can automatically generate a set of relevant variables for an {astra-stream} tenant that you can use in your applications. diff --git a/in-progress/dsbulk.adoc b/in-progress/dsbulk.adoc index 6c4cf4f..37b0d7f 100644 --- a/in-progress/dsbulk.adoc +++ b/in-progress/dsbulk.adoc @@ -1,10 +1,10 @@ -= Run DataStax Bulk Loader (DSBulk) commands -:navtitle: DSBulk quickstart += Run {dsbulk} commands +:navtitle: {dsbulk-short} quickstart -xref:dsbulk:overview:dsbulk-about.adoc[DataStax Bulk Loader (DSBulk)] is a utility that you can use to load, unload, and count data in your database tables. -The {product} provides embedded DSBulk support by downloading, installing, configuring, and wrapping the `dsbulk` utility. +xref:dsbulk:overview:dsbulk-about.adoc[{dsbulk}] is a utility that you can use to load, unload, and count data in your database tables. +The {product} provides embedded {dsbulk-short} support by downloading, installing, configuring, and wrapping the `dsbulk` utility. -The {product} exposes DSBulk functionality through the following commands: +The {product} exposes {dsbulk-short} functionality through the following commands: * `xref:commands:astra-db-dsbulk-load.adoc[]` * `xref:commands:astra-db-dsbulk-unload.adoc[]` @@ -147,9 +147,9 @@ To resume the current operation, re-run it with the same settings, and add the f ---- ==== -== Complete DSBulk example +== Complete {dsbulk-short} example -The following end-to-end example shows how to use the {product}'s built-in DSBulk support to load data into a database, get information about the data, and unload the data into CSV files: +The following end-to-end example shows how to use the {product}'s built-in {dsbulk-short} support to load data into a database, get information about the data, and unload the data into CSV files: . Create an {astra-db} {db-serverless} database: + diff --git a/in-progress/managing.adoc b/in-progress/managing.adoc index abc9805..649fa81 100644 --- a/in-progress/managing.adoc +++ b/in-progress/managing.adoc @@ -2774,9 +2774,9 @@ OPTIONS ==== [#cqlsh] -== Use cqlsh +== Use `cqlsh` -`cqlsh` is an interface that you can use to issue xref:astra@cql:ROOT:index.adoc[{cass-short} Query Language (CQL)] commands to your database. +`cqlsh` is an interface that you can use to issue xref:astra@cql:ROOT:index.adoc[{cql}] commands to your database. The {product} provides built-in `cqlsh` support by downloading, installing, configuring, and wrapping the `cqlsh` utility. This can act as a convenient alternative to installing and configuring a xref:astra-db-serverless:cql:develop-with-cql.adoc#connect-to-the-cql-shell[standalone cqlsh]. @@ -3021,12 +3021,12 @@ astra db cqlsh **DATABASE_ID** -e "SOURCE 'sample.cql'" ==== ====== -== Use DataStax Bulk Loader +== Use {dsbulk} -The xref:dsbulk:overview:dsbulk-about.adoc[DataStax Bulk Loader (DSBulk)] lets you load, unload, and count data in your database tables. -The {product} provides built-in DSBulk support by downloading, installing, configuring, and wrapping the `dsbulk` utility. +The xref:dsbulk:overview:dsbulk-about.adoc[{dsbulk}] lets you load, unload, and count data in your database tables. +The {product} provides built-in {dsbulk-short} support by downloading, installing, configuring, and wrapping the `dsbulk` utility. -The {product} exposes DSBulk functionality through the `astra db load`, `astra db unload`, and `astra db count` commands. +The {product} exposes {dsbulk-short} functionality through the `astra db load`, `astra db unload`, and `astra db count` commands. The first time you run `astra db load`, `astra db unload`, or `astra db count` commands, the {product} downloads and installs the `dsbulk` utility to the {product} installation directory (`~/.astra/dsbulk-*`). The {product} also downloads the {scb} for each database you connect to and stores the {scb-short} zip files in the `~/.astra/scb` directory. @@ -3462,9 +3462,9 @@ OPTIONS ---- ==== -=== Complete DSBulk example +=== Complete {dsbulk-short} example -The following end-to-end example shows how to use the {product}'s built-in DSBulk support to load data into a database, get information about the data, and unload the data into CSV files: +The following end-to-end example shows how to use the {product}'s built-in {dsbulk-short} support to load data into a database, get information about the data, and unload the data into CSV files: . Create an {astra-db} {db-serverless} database: + diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 9cd3302..a2b57ed 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -11,8 +11,8 @@ include::ROOT:partial$partial-nav.adoc[] .Release notes -* https://github.com/datastax/astra-cli?tab=readme-ov-file#whats-changed[Release notes] +* {product-repo}?tab=readme-ov-file#whats-changed[Release notes] //- -* https://github.com/datastax/astra-cli[GitHub repository] +* {product-repo}[GitHub repository] diff --git a/modules/ROOT/pages/install.adoc b/modules/ROOT/pages/install.adoc index 58b3415..e7ee741 100644 --- a/modules/ROOT/pages/install.adoc +++ b/modules/ROOT/pages/install.adoc @@ -79,7 +79,7 @@ The response includes available commands and options for the {product}. Binary installation:: + -- -. Download the appropriate binary archive for your OS and CPU architecture from https://github.com/datastax/astra-cli/releases[GitHub]. +. Download the appropriate binary archive for your OS and CPU architecture from {product-repo}/releases[GitHub]. . Extract the archive into the directory where you want to install the {product}. For example: @@ -173,7 +173,7 @@ The response includes available commands and options for the {product}. Binary installation:: + -- -. Download the `windows` zip file from https://github.com/datastax/astra-cli/releases[GitHub]. +. Download the `windows` zip file from {product-repo}/releases[GitHub]. . Extract the zip file into the directory where you want to install the {product}: + diff --git a/modules/ROOT/pages/manage-cli.adoc b/modules/ROOT/pages/manage-cli.adoc index a10a280..5693a24 100644 --- a/modules/ROOT/pages/manage-cli.adoc +++ b/modules/ROOT/pages/manage-cli.adoc @@ -563,7 +563,7 @@ The {product} home folder contains the following items: * Cache files for <> * Logs -For more information about `ASTRA_HOME`, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#home-folder-location[{product} README]. +For more information about `ASTRA_HOME`, see the {product-repo}?tab=readme-ov-file#home-folder-location[{product} README]. |`.astrarc` a|The {product} configuration file. @@ -576,7 +576,7 @@ _Default location_: The {product} uses this file to store your <> and their associated application tokens. -For more information about the {product} configuration file, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#astrarc-location[{product} README]. +For more information about the {product} configuration file, see the {product-repo}?tab=readme-ov-file#astrarc-location[{product} README]. |=== === Override the default home folder location diff --git a/modules/ROOT/pages/upgrade-pre-1.0.adoc b/modules/ROOT/pages/upgrade-pre-1.0.adoc index f961baa..f989495 100644 --- a/modules/ROOT/pages/upgrade-pre-1.0.adoc +++ b/modules/ROOT/pages/upgrade-pre-1.0.adoc @@ -56,5 +56,5 @@ However, there are some changes that might break certain scripted usage, such as * New standardized xref:ROOT:manage-cli.adoc#output-formats[JSON and CSV output formats and exit codes]. * Minor command and flag name changes. -For a full list of name changes, see the https://github.com/datastax/astra-cli?tab=readme-ov-file#whats-changed[release notes]. +For a full list of name changes, see the {product-repo}?tab=readme-ov-file#whats-changed[release notes]. ==== diff --git a/modules/quickstarts/pages/cqlsh.adoc b/modules/quickstarts/pages/cqlsh.adoc index 3d06ec0..5a87f86 100644 --- a/modules/quickstarts/pages/cqlsh.adoc +++ b/modules/quickstarts/pages/cqlsh.adoc @@ -1,7 +1,7 @@ -= Issue CQL commands with cqlsh in the {product} += Issue CQL commands with {cql-shell} in the {product} :navtitle: CQL quickstart -The {cass-short} Query Language Shell (`cqlsh`) is a utility that you can use to issue xref:astra@cql:reference:cql-quick-reference.adoc[CQL commands] to your {astra-db} databases. +The {cql-shell} (`cqlsh`) is a utility that you can use to issue xref:astra@cql:reference:cql-quick-reference.adoc[{cql} commands] to your {astra-db} databases. The {product} provides embedded `cqlsh` support by downloading and installing the `cqlsh` utility in the background and exposing it through the `xref:commands:astra-db-cqlsh.adoc[]` commands. This can act as a convenient alternative to installing and configuring a xref:astra-db-serverless:cql:develop-with-cql.adoc#connect-to-the-cql-shell[standalone cqlsh].