Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions docs-src/astra-cli-core/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,26 @@ nav:

asciidoc:
attributes:
# General attributes
company: 'DataStax'
support-url: 'https://support.datastax.com'
# 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: '0.6'
astra: 'Astra'
db-serverless: 'Serverless (Non-Vector)'
db-serverless-vector: 'Serverless (Vector)'
db-classic: 'Classic'
astra-api: 'Data API'
url-astra: 'https://astra.datastax.com'
link-astra-portal: '{url-astra}[{astra_ui}^]'
py-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$python-client/astrapy'
ts-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$typescript-client'
java-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$java-client'
cass-short: 'Cassandra'
scb-long: Secure Connect Bundle (SCB)
scb-cap: Secure Connect Bundle
scb: SCB
devops-api: 'DevOps API'
astra-stream: 'Astra Streaming'
astra-ui: 'Astra Portal'
astra-url: 'https://astra.datastax.com'
astra-ui-link: '{astra-url}[{astra-ui}^]'
scb: 'Secure Connect Bundle (SCB)'
scb-short: 'SCB'
scb-brief: 'Secure Connect Bundle'
26 changes: 13 additions & 13 deletions docs-src/astra-cli-core/modules/ROOT/pages/administration.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
= Manage your Astra organization with the {product}
:navtitle: Manage Astra administration
= Manage your {product-short} organization with the {product}
:navtitle: Manage {product-short} administration

Use the {product} to manage your Astra organization.
Use the {product} to manage your {product-short} organization.

== Get organization details

Use the `astra org` command to get information about the current Astra organization:
Use the `astra org` command to get information about the current {product-short} organization:

[source,bash]
----
Expand Down Expand Up @@ -49,7 +49,7 @@ SYNOPSIS

== List users

Use the `astra user list` command to list all users in your Astra organization:
Use the `astra user list` command to list all users in your {product-short} organization:

[source,bash]
----
Expand Down Expand Up @@ -113,7 +113,7 @@ OPTIONS

== Add a user

Use the `astra user invite` command to invite a new user to your Astra organization:
Use the `astra user invite` command to invite a new user to your {product-short} organization:

[source,bash,subs="+quotes"]
----
Expand Down Expand Up @@ -218,7 +218,7 @@ astra user invite alice@example.com -r "Organization Administrator"

== Get user details

Use the `astra user get` or `astra user describe` command to get information about a specific user in your Astra organization:
Use the `astra user get` or `astra user describe` command to get information about a specific user in your {product-short} organization:

[source,bash,subs="+quotes"]
----
Expand Down Expand Up @@ -358,7 +358,7 @@ The user can still access their personal {astra_db} account, if they have access
If your organization uses SSO, make sure that you also remove the user from your IdP, if necessary.
====

Use the `astra user delete` command to remove a user or revoke their invitation from your Astra organization:
Use the `astra user delete` command to remove a user or revoke their invitation from your {product-short} organization:

[source,bash,subs="+quotes"]
----
Expand Down Expand Up @@ -427,7 +427,7 @@ OPTIONS
[#list-roles]
== List roles

Use the `astra role list` command to list all xref:astra-db-serverless:administration:manage-database-access.adoc#default-roles[default roles] and xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom roles] in your Astra organization:
Use the `astra role list` command to list all xref:astra-db-serverless:administration:manage-database-access.adoc#default-roles[default roles] and xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom roles] in your {product-short} organization:

[source,bash]
----
Expand Down Expand Up @@ -505,7 +505,7 @@ OPTIONS

== Get role details

Use the `astra role get` or `astra role describe` command to get information about a specific role in your Astra organization:
Use the `astra role get` or `astra role describe` command to get information about a specific role in your {product-short} organization:

[source,bash,subs="+quotes"]
----
Expand Down Expand Up @@ -680,7 +680,7 @@ OPTIONS
[#list-tokens]
== Get a list of tokens

Use the `astra token list` command to list all of the application tokens in your Astra organization:
Use the `astra token list` command to list all of the application tokens in your {product-short} organization:

[source,bash]
----
Expand Down Expand Up @@ -741,7 +741,7 @@ OPTIONS

== Create an application token

Use the `astra token create` command to create a new application token in your Astra organization:
Use the `astra token create` command to create a new application token in your {product-short} organization:

[source,bash,subs="+quotes"]
----
Expand Down Expand Up @@ -875,7 +875,7 @@ OPTIONS
Application tokens never expire.
====

Use the `astra token delete` or `astra token revoke` command to delete an application token from your Astra organization:
Use the `astra token delete` or `astra token revoke` command to delete an application token from your {product-short} organization:

[source,bash,subs="+quotes"]
----
Expand Down
52 changes: 18 additions & 34 deletions docs-src/astra-cli-core/modules/ROOT/pages/astra-streaming-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant

Running `astra streaming create` without any options deploys the tenant in the default cloud provider (`aws`), region (`useast2`), plan (`free`) and namespace (`default`).

[NOTE]
======
[TIP]
====
Tenant names 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:

Expand All @@ -40,6 +42,7 @@ You can use the `--if-not-exist` option to only create the tenant if it doesn't
----
astra streaming create **TENANT_NAME** --if-not-exist
----
====

.Result
[%collapsible]
Expand Down Expand Up @@ -67,7 +70,6 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant
[OK] Tenant 'my-streaming-tenant' exists.
----
====
======

=== `streaming create` options

Expand Down Expand Up @@ -541,7 +543,7 @@ OPTIONS

== Get a list of available {astra_stream} regions

Use the `astra streaming list-regions` command to get a list of available cloud provider 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]
----
Expand All @@ -550,34 +552,19 @@ astra streaming list-regions

.Result
[%collapsible]
======
[source,console]
====
The result is a table with `Cloud Provider`, `Region`, and `Full Name` columns.
`Full Name` can be empty or contain the region's name and location (city, state, or country).

[source,console,subs="+quotes"]
----
+-----------------+---------------------+-------------------------------+
| Cloud Provider | Region | Full Name |
+-----------------+---------------------+-------------------------------+
| aws | apsouth1 | |
| aws | apsoutheast1 | |
| aws | apsoutheast2 | |
| aws | eucentral1 | |
| aws | euwest1 | |
| aws | useast1 | |
| aws | useast2 | |
| aws | uswest2 | |
| azure | australiaeast | |
| azure | eastus | |
| azure | westeurope | |
| azure | westus2 | |
| gcp | australiase1 | |
| gcp | europewest1 | |
| gcp | uscentral1 | |
| gcp | useast1 | |
| gcp | useast4 | |
| **PROVIDER** | **REGION** | **NAME** |
+-----------------+---------------------+-------------------------------+
----

include::ROOT:partial$regions-change-admonition.adoc[]
======
====

=== `streaming list-regions` options

Expand Down Expand Up @@ -1080,13 +1067,16 @@ ASTRA_STREAMING_WEBSOCKET_URL="wss://pulsar-aws-useast2.streaming.datastax.com:8

[WARNING]
====
The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to Astra.
The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to {product-short}.

The {scb} contains sensitive information that establishes a connection to your database, including key pairs and certificates.
====

=== `streaming create-dotenv` options

The directory must already exist before you run the `streaming create-dotenv` command.
If the directory doesn't exist, the command fails with the error `INVALID_ARGUMENT: Destination folder has not been found`.

.Expand to see all `streaming create-dotenv` options
[%collapsible]
====
Expand Down Expand Up @@ -1152,10 +1142,4 @@ astra streaming create-dotenv **TENANT_NAME** -d ~/tmp
----
[OK] File '/Users/USERNAME/tmp/.env' has been created/amended
----
====

[NOTE]
====
The directory must already exist before you run the command.
If the directory doesn't exist, the {product} will report the following error: `INVALID_ARGUMENT: Destination folder has not been found`.
====
====
Loading