diff --git a/antora.yml b/antora.yml index c23c056..52eab62 100644 --- a/antora.yml +++ b/antora.yml @@ -22,7 +22,7 @@ asciidoc: product-version: '1.0' db-serverless: 'Serverless (Non-Vector)' db-serverless-vector: 'Serverless (Vector)' - db-classic: 'Classic' + db-classic: 'Managed Cluster' devops-api: 'DevOps API' astra-stream: 'Astra Streaming' astra-ui: 'Astra Portal' diff --git a/in-progress/administration.adoc b/in-progress/administration.adoc index 8c7bc6b..7456435 100644 --- a/in-progress/administration.adoc +++ b/in-progress/administration.adoc @@ -352,8 +352,8 @@ OPTIONS ==== Removing a user removes their access to your organization, but it doesn't delete their account. -The user retains their personal {astra_db} account under their associated email address, including access to their default (personal) organization and any other organizations they belong to. -The user can still access their personal {astra_db} account, if they have access to the associated xref:astra-db-serverless:administration:invite-users-to-organization.adoc#accept-the-invite[authentication method]. +The user retains their personal {product-short} account under their associated email address, including access to their default (personal) organization and any other organizations they belong to. +The user can still access their personal {product-short} account, if they have access to the associated xref:astra-db-serverless:administration:invite-users-to-organization.adoc#accept-the-invite[authentication method]. If your organization uses SSO, make sure that you also remove the user from your IdP, if necessary. ==== diff --git a/in-progress/astra-streaming-cli.adoc b/in-progress/astra-streaming-cli.adoc index bbbd236..8f3bd43 100644 --- a/in-progress/astra-streaming-cli.adoc +++ b/in-progress/astra-streaming-cli.adoc @@ -1,7 +1,7 @@ // 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 += {astra-stream} commands -Use the {product} to manage your {astra_stream} deployments. +Use the {product} to manage your {astra-stream} deployments. == Create a tenant @@ -28,7 +28,7 @@ Running `astra streaming create` without any options deploys the tenant in the d ==== Tenant names must be unique -All tenant names in {astra_stream} must be unique. +All tenant names in {astra-stream} must be unique. If the tenant name is already in use, the command fails with with the following error message: [source,console] @@ -541,9 +541,9 @@ OPTIONS ---- ==== -== Get a list of available {astra_stream} regions +== Get a list of available {astra-stream} regions -Use the `astra streaming list-regions` command to get a list of available regions that support {astra_stream}: +Use the `astra streaming list-regions` command to get a list of available regions that support {astra-stream}: [source,bash] ---- @@ -959,7 +959,7 @@ key:[null], properties:[], content:hello == Change Data Capture (CDC) -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. +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. For more information about using the {product} to configure CDC, see xref:ROOT:managing.adoc#cdc[Configure Change Data Capture]. @@ -1033,12 +1033,12 @@ 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 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. +The {product} can automatically generate a set of relevant variables for an {astra-stream} tenant that you can use in your applications. -Use the `astra streaming create-dotenv` command to generate a `.env` file containing relevant environment variables for a specific {astra_stream} tenant: +Use the `astra streaming create-dotenv` command to generate a `.env` file containing relevant environment variables for a specific {astra-stream} tenant: [source,bash,subs="+quotes"] ---- diff --git a/in-progress/change-data-capture.adoc b/in-progress/change-data-capture.adoc index 0227bfa..ddc6683 100644 --- a/in-progress/change-data-capture.adoc +++ b/in-progress/change-data-capture.adoc @@ -1,13 +1,13 @@ = 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. +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. +This page provides an end-to-end example that shows you how to use the {product} to enable CDC for an {astra} database. == Create a database -Create an {astra_db} database: +Create a database: [source,shell] ---- @@ -25,7 +25,7 @@ Database 'cdc_demo_db' has been created with id 'ce5e563c-3248-4064-b03c-5892433 == Create a streaming tenant -Create an {astra_stream} tenant in the same region as your database: +Create an {astra-stream} tenant in the same region as your database: [source,shell] ---- diff --git a/in-progress/dsbulk.adoc b/in-progress/dsbulk.adoc index d88523e..6c4cf4f 100644 --- a/in-progress/dsbulk.adoc +++ b/in-progress/dsbulk.adoc @@ -151,7 +151,7 @@ To resume the current operation, re-run it with the same settings, and add the f 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: -. Create an {astra_db} {db-serverless} database: +. Create an {astra-db} {db-serverless} database: + [source,shell] ---- diff --git a/in-progress/managing.adoc b/in-progress/managing.adoc index d9246f6..0431c50 100644 --- a/in-progress/managing.adoc +++ b/in-progress/managing.adoc @@ -1,10 +1,10 @@ // 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_db} commands += {astra-db} commands :embedding-provider-name: NVIDIA :embedding-provider-name-api: nvidia :embedding-provider-model-name-api: NV-Embed-QA -Use the {product} to manage your {astra_db} deployments. +Use the {product} to manage your {astra-db} databases. [TIP] ==== @@ -14,7 +14,7 @@ You can use `**DATABASE_NAME**` instead of `**DATABASE_ID**` in all `astra db` c == Create a database The {product} can create {db-serverless} and {db-serverless-vector} databases with on-demand (non-PCU) capacity only. -It cannot create {db-classic} databases; however, you can use the {product} to <> about your existing {db-classic} databases. +It cannot create {product-short} {db-classic} (Classic) databases; however, you can use the {product} to <> about your existing {db-classic} databases. If your organization requires that new databases to belong to a xref:astra-db-serverless:administration:provisioned-capacity-units.adoc[PCU group], you must xref:astra-db-serverless:databases:create-database.adoc[use the {astra-ui} or {devops-api} to create databases] because the {product} doesn't support PCU group assignment with database creation. @@ -171,7 +171,7 @@ astra db create **DATABASE_NAME** \ //TODO: Confirm that this no longer applies. //// -The database ID, not the database name, ensures uniqueness within your {astra_db} organization. +The database ID, not the database name, ensures uniqueness within your {product-short} organization. Consequently, if you issue the `astra db create` command multiple times, you will create multiple database instances. To ensure that you don't create a database with the same name as another existing database, use the `--if-not-exist` option: @@ -183,7 +183,7 @@ astra db create demo -r us-east-1 -k keyspace1 --if-not-exist == Manage keyspaces -{astra_db} databases store data in <> and <>, which exist inside keyspaces. +{astra-db} databases store data in <> and <>, which exist inside keyspaces. Each database must have at least one keyspace, and you can create more as needed. Use the `astra db create-keyspace` command to create a new keyspace in a database: @@ -282,7 +282,7 @@ The database enters *Maintenance* status while it deletes the keyspace along wit include::ROOT:partial$async-option-active.adoc[] -If you delete the default keyspace, {astra_db} automatically selects another keyspace to be the default keyspace. +If you delete the default keyspace, {astra-db} automatically selects another keyspace to be the default keyspace. === `db create-keyspace` options @@ -501,7 +501,7 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \ Use an {product-short}-hosted provider:: + -- -To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection. +To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{product-short} vectorize], add an embedding provider integration to your collection. Embedding provider integrations are either {product-short}-hosted or external. This option uses an {product-short}-hosted provider: @@ -552,10 +552,10 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \ Use an external provider:: + -- -To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection. +To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{product-short} vectorize], add an embedding provider integration to your collection. Embedding provider integrations are either {product-short}-hosted or external. -To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {astra_db} organization, and then you can select that embedding provider when you create a collection: +To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {product-short} organization, and then you can select that embedding provider when you create a collection: [source,bash,subs="+quotes"] ---- @@ -1920,7 +1920,7 @@ OPTIONS ---- ==== -== Get a list of available {astra_db} regions +== Get a list of available {astra-db} regions Use the `astra db list-regions-serverless` command to get a list of available regions that support {db-serverless} databases: @@ -1936,7 +1936,7 @@ Use the `astra db list-regions-vector` command to get a list of available cloud astra db list-regions-vector ---- -Use the `astra db list-regions-classic` command to get a list of available cloud provider regions that support {db-classic} databases: +Use the `astra db list-regions-classic` command to get a list of available cloud provider regions that support {product-short} {db-classic} (Classic) databases: [source,bash] ---- @@ -2057,6 +2057,11 @@ OPTIONS === `db list-regions-classic` options +[TIP] +==== +`classic` refers to {product-short} {db-classic} databases, which were previously known as {astra-db} Classic databases. +==== + .Expand to see all `db list-regions-classic` options [%collapsible] ==== @@ -3462,7 +3467,7 @@ OPTIONS 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: -. Create an {astra_db} {db-serverless} database: +. Create an {astra-db} {db-serverless} database: + [source,bash] ---- @@ -3680,11 +3685,11 @@ This command unloads row data from the `cities_by_country` table, and stores it [IMPORTANT] ==== -CDC for {astra_db} incurs billed charges based on your {astra_stream} usage. -For more information, see https://www.ibm.com/docs/en/astra-streaming?topic=astra-streaming-annual-price-plans[{astra_stream} pricing]. +CDC for {astra-db} incurs billed charges based on your {astra-stream} usage. +For more information, see https://www.ibm.com/docs/en/astra-streaming?topic=astra-streaming-annual-price-plans[{astra-stream} pricing]. ==== -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. +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. Use the `astra db create-cdc` command to create a CDC connection for a table in a {db-serverless} database: @@ -3927,7 +3932,7 @@ OPTIONS The following end-to-end example shows how to use the {product} to create a CDC connection for a table in a {db-serverless} database: -. Create an {astra_db} {db-serverless} database: +. Create an {astra-db} {db-serverless} database: + [source,bash] ---- @@ -3952,7 +3957,7 @@ get CLoud provider ---- ==== -. Create an {astra_stream} tenant in the same region as your database: +. Create an {astra-stream} tenant in the same region as your database: + [source,bash] ---- @@ -4203,7 +4208,7 @@ astra db download-scb **DATABASE_ID** -f **DESTINATION_FILE**.zip == Create environment variables -When developing applications with {astra_db} APIs, you will notice common values that are frequently reused, such as application tokens, database API endpoints, database IDs, and keyspace names. +When developing applications with {astra-db} APIs, you will notice common values that are frequently reused, such as application tokens, database API endpoints, database IDs, and keyspace names. 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 a database that you can use in your applications. diff --git a/in-progress/quickstart-databases.adoc b/in-progress/quickstart-databases.adoc index dd47d5b..7179a10 100644 --- a/in-progress/quickstart-databases.adoc +++ b/in-progress/quickstart-databases.adoc @@ -292,5 +292,5 @@ See xref:databases:create-database.adoc#get-db-id[Get your database ID]. == Find embedding providers -Get information about embedding providers for xref:databases:embedding-generation.adoc[{astra-db} vectorize], including supported providers, models, dimensions, and other configuration parameters. +Get information about embedding providers for xref:databases:embedding-generation.adoc[{product-short} vectorize], including supported providers, models, dimensions, and other configuration parameters. diff --git a/modules/ROOT/pages/install.adoc b/modules/ROOT/pages/install.adoc index 3fe5ebf..58b3415 100644 --- a/modules/ROOT/pages/install.adoc +++ b/modules/ROOT/pages/install.adoc @@ -1,9 +1,9 @@ = Install the {product} :navtitle: Install the CLI :page-aliases: ROOT:installation.adoc, ROOT:getting-started.adoc -:description: {product} makes it easier to integrate {product-short} into your applications and workflows by letting you perform common platform tasks for {astra_db} and {astra_stream} from the command line. +:description: {product} makes it easier to integrate {product-short} into your applications and workflows by letting you perform common platform tasks for {astra-db} and {astra-stream} from the command line. -Install the {product} to create and manage {astra_db} databases and {astra_stream} tenants from the command line. +Install the {product} to create and manage {astra-db} databases and {astra-stream} tenants from the command line. == Supported platforms diff --git a/modules/quickstarts/pages/cqlsh.adoc b/modules/quickstarts/pages/cqlsh.adoc index b01955d..4332b8b 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} :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} database. +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 {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].