Skip to content

Commit 4e9ba32

Browse files
More commands and refinement
1 parent 49bd608 commit 4e9ba32

File tree

3 files changed

+744
-576
lines changed

3 files changed

+744
-576
lines changed

docs-src/astra-cli-core/modules/ROOT/pages/administration.adoc

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
= Manage Astra organizations and users
1+
= Manage your Astra organization with the {product}
22
:navtitle: Astra administration
33

4-
Use the {product} to manage your Astra organizations and users.
4+
Use the {product} to manage your Astra organization's users, roles, and tokens.
55

66
== Get organization details
77

@@ -105,7 +105,7 @@ OPTIONS
105105

106106
== Add a user
107107

108-
Use `astra user invite` to invite a new user to your Astra organization:
108+
Use the `astra user invite` command to invite a new user to your Astra organization:
109109

110110
[source,bash,subs="+quotes"]
111111
----
@@ -206,16 +206,16 @@ astra user invite [email protected] -r "Organization Administrator"
206206

207207
== Get user details
208208

209-
Use the `astra user describe` or `astra user get` command to get information about a specific user in your Astra organization:
209+
Use the `astra user get` or `astra user describe` command to get information about a specific user in your Astra organization:
210210

211211
[source,bash,subs="+quotes"]
212212
----
213-
astra user describe **USER**
213+
astra user get **USER**
214214
----
215215

216216
[source,bash,subs="+quotes"]
217217
----
218-
astra user get **USER**
218+
astra user describe **USER**
219219
----
220220

221221
Replace `**USER**` with the email address or ID of the user you want to get information about.
@@ -238,15 +238,15 @@ Replace `**USER**` with the email address or ID of the user you want to get info
238238
----
239239
====
240240

241-
=== `user describe` options
241+
=== `user get` options
242242

243243
[source,console]
244244
----
245245
NAME
246-
astra user describe - Show user details
246+
astra user get - Show user details
247247
248248
SYNOPSIS
249-
astra user describe [ {-cf | --config-file} <CONFIG_FILE> ]
249+
astra user get [ {-cf | --config-file} <CONFIG_FILE> ]
250250
[ {-conf | --config} <CONFIG_SECTION> ] [ --env <Environment> ]
251251
[ --no-color ] [ {-o | --output} <FORMAT> ]
252252
[ --token <AUTH_TOKEN> ] [ {-v | --verbose} ] [--] <EMAIL>
@@ -282,15 +282,15 @@ OPTIONS
282282
User Email
283283
----
284284

285-
=== `user get` options
285+
=== `user describe` options
286286

287287
[source,console]
288288
----
289289
NAME
290-
astra user get - Show user details
290+
astra user describe - Show user details
291291
292292
SYNOPSIS
293-
astra user get [ {-cf | --config-file} <CONFIG_FILE> ]
293+
astra user describe [ {-cf | --config-file} <CONFIG_FILE> ]
294294
[ {-conf | --config} <CONFIG_SECTION> ] [ --env <Environment> ]
295295
[ --no-color ] [ {-o | --output} <FORMAT> ]
296296
[ --token <AUTH_TOKEN> ] [ {-v | --verbose} ] [--] <EMAIL>
@@ -338,7 +338,7 @@ The user can still access their personal {astra_db} account, if they have access
338338
If your organization uses SSO, make sure that you also remove the user from your IdP, if necessary.
339339
====
340340

341-
Use `astra user delete` to remove a user or revoke their invitation from your Astra organization:
341+
Use the `astra user delete` command to remove a user or revoke their invitation from your Astra organization:
342342

343343
[source,bash,subs="+quotes"]
344344
----
@@ -477,16 +477,16 @@ OPTIONS
477477

478478
== Get role details
479479

480-
Use the `astra role describe` or `astra role get` command to get information about a specific role in your Astra organization:
480+
Use the `astra role get` or `astra role describe` command to get information about a specific role in your Astra organization:
481481

482482
[source,bash,subs="+quotes"]
483483
----
484-
astra role describe "**ROLE**"
484+
astra role get "**ROLE**"
485485
----
486486

487487
[source,bash,subs="+quotes"]
488488
----
489-
astra role get "**ROLE**"
489+
astra role describe "**ROLE**"
490490
----
491491

492492
Replace `**ROLE**` with the name or ID of the role you want to get information about.
@@ -553,15 +553,15 @@ Replace `**ROLE**` with the name or ID of the role you want to get information a
553553
----
554554
====
555555

556-
=== `role describe` options
556+
=== `role get` options
557557

558558
[source,console]
559559
----
560560
NAME
561-
astra role describe - Show role details
561+
astra role get - Show role details
562562
563563
SYNOPSIS
564-
astra role describe [ {-cf | --config-file} <CONFIG_FILE> ]
564+
astra role get [ {-cf | --config-file} <CONFIG_FILE> ]
565565
[ {-conf | --config} <CONFIG_SECTION> ] [ --env <Environment> ]
566566
[ --no-color ] [ {-o | --output} <FORMAT> ]
567567
[ --token <AUTH_TOKEN> ] [ {-v | --verbose} ] [--] <ROLE>
@@ -597,15 +597,15 @@ OPTIONS
597597
Role name or identifier
598598
----
599599

600-
=== `role get` options
600+
=== `role describe` options
601601

602602
[source,console]
603603
----
604604
NAME
605-
astra role get - Show role details
605+
astra role describe - Show role details
606606
607607
SYNOPSIS
608-
astra role get [ {-cf | --config-file} <CONFIG_FILE> ]
608+
astra role describe [ {-cf | --config-file} <CONFIG_FILE> ]
609609
[ {-conf | --config} <CONFIG_SECTION> ] [ --env <Environment> ]
610610
[ --no-color ] [ {-o | --output} <FORMAT> ]
611611
[ --token <AUTH_TOKEN> ] [ {-v | --verbose} ] [--] <ROLE>

docs-src/astra-cli-core/modules/ROOT/pages/astra-streaming-cli.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Use the {product} to manage your {astra_stream} tenants.
55

66
== List tenants
77

8-
Use `astra streaming list` to get a list of all tenants in your organization:
8+
Use the `astra streaming list` command to get a list of all tenants in your organization:
99

1010
[source,bash]
1111
----
@@ -103,7 +103,7 @@ astra streaming list -o json
103103

104104
== Create a tenant
105105

106-
Use `astra streaming create` to create a new tenant:
106+
Use the `astra streaming create` command to create a new tenant:
107107

108108
[source,bash,subs="+quotes"]
109109
----
@@ -229,7 +229,7 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant
229229

230230
== Get tenant details
231231

232-
Use `astra streaming get` to get information about a tenant:
232+
Use the `astra streaming get` command to get information about a tenant:
233233

234234
[source,bash,subs="+quotes"]
235235
----
@@ -367,7 +367,7 @@ eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3MzQ2MjY4MjAsImlzcyI6ImRhdGFzdGF
367367

368368
== Delete a tenant
369369

370-
Use `astra streaming delete` to delete a tenant:
370+
Use the `astra streaming delete` command to delete a tenant:
371371

372372

373373
[source,bash,subs="+quotes"]
@@ -430,7 +430,7 @@ OPTIONS
430430

431431
== List regions
432432

433-
Use `astra streaming list-regions` to list the cloud provider regions that currently support {astra_stream}:
433+
Use the `astra streaming list-regions` command to list the cloud provider regions that currently support {astra_stream}:
434434

435435
[source,bash]
436436
----
@@ -609,7 +609,7 @@ It is designed to allow developers and administrators to execute Pulsar commands
609609

610610
The {product} provides built-in Pulsar shell support by downloading, installing, configuring, and wapping the `pulsar-shell` utility.
611611

612-
Use `astra streaming pulsar-shell` to start the Pulsar shell in interactive mode:
612+
Use the `astra streaming pulsar-shell` command to start the Pulsar shell in interactive mode:
613613

614614
[source,bash,subs="+quotes"]
615615
----
@@ -839,7 +839,7 @@ It's a good practice to store these values in environment variables to facilitat
839839

840840
The {product} can automatically generate a set of relevant variables for an {astra_stream} tenant that you can use in your applications.
841841

842-
Use `astra streaming create-dotenv` to generate a `.env` file containing relevant environment variables for a specific {astra_stream} tenant:
842+
Use the `astra streaming create-dotenv` command to generate a `.env` file containing relevant environment variables for a specific {astra_stream} tenant:
843843

844844
[source,bash,subs="+quotes"]
845845
----

0 commit comments

Comments
 (0)