Skip to content

Commit 554b932

Browse files
authored
DOC-5159 Astra role attributes (#240)
* astra role attributes * fix article
1 parent 7e065fb commit 554b932

7 files changed

Lines changed: 11 additions & 7 deletions

File tree

antora.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,8 @@ asciidoc:
5858
cass-migrator-short: 'CDM'
5959
cass-migrator-repo: 'https://github.com/datastax/cassandra-data-migrator'
6060
cass-migrator-shield: 'image:https://img.shields.io/github/v/release/datastax/cassandra-data-migrator?label=latest[alt="Latest cassandra-data-migrator release on GitHub",link="{cass-migrator-repo}/packages"]'
61-
sstable-sideloader: '{astra-db} Sideloader'
61+
sstable-sideloader: '{astra-db} Sideloader'
62+
63+
# Astra role attributes (compare with astra-vector-docs antora.yml)
64+
database-administrator-role: 'xref:astra-db-serverless:administration:rbac.adoc#database-administrator-role[Database Administrator]'
65+
read-write-user-role: 'xref:astra-db-serverless:administration:rbac.adoc#read-write-user-role[Read/Write User]'

modules/ROOT/pages/cassandra-data-migrator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Replace `**PATCH**` with your {spark-short} patch version.
8181

8282
{spark-reg} cluster::
8383
+
84-
For large (several terabytes) migrations, complex migrations, and use of {cass-migrator-short} as a long-term data transfer utility, {company} recommends that you use a {spark} cluster or {spark-short} Serverless platform.
84+
For large (several terabytes) migrations, complex migrations, and use of {cass-migrator-short} as a long-term data transfer utility, {company} recommends that you use an {spark} cluster or {spark-short} Serverless platform.
8585
+
8686
If you deploy {cass-migrator-short} on a {spark-short} cluster, you must modify your `spark-submit` commands as follows:
8787
+

modules/ROOT/pages/connect-clients-to-target.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Connections to {astra-db} are different from connections to self-managed {cass-s
4646

4747
To connect a driver to {astra-db}, you need the following:
4848

49-
* An xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token] with sufficient permissions to execute the required operations, such as the **Database Administrator** role.
49+
* An xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token] with sufficient permissions to execute the required operations, such as the {database-administrator-role} role.
5050
+
5151
You must specify one of the following sets of credentials in your driver configuration:
5252
+

modules/ROOT/pages/create-target.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ However, paid plans offer premium features that can facilitate your migration, i
3030
All databases start with an initial keyspace.
3131
If the name of this keyspace doesn't match your origin cluster's schema, you can delete the initial keyspace after recreating the schema later in this process.
3232
33-
. When your database reaches **Active** status, xref:astra-db-serverless:administration:manage-application-tokens.adoc[create an application token] with a role like *Read/Write User* or **Database Administrator**, and then store the credentials (Client ID, Client Secret, and Token) securely.
33+
. When your database reaches **Active** status, xref:astra-db-serverless:administration:manage-application-tokens.adoc[create an application token] with a role like {read-write-user-role} or {database-administrator-role}, and then store the credentials (Client ID, Client Secret, and Token) securely.
3434
+
3535
These credentials are used by the client application and {product-proxy} to read and write to your target database.
3636
Make sure the token's role has sufficient permission to perform the actions required by your client application.

modules/ROOT/pages/deploy-proxy-monitoring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ If authentication isn't enabled, no credentials are required.
9090
{astra-db}::
9191
+
9292
--
93-
For {astra-db} databases, xref:astra-db-serverless:administration:manage-application-tokens.adoc[generate an application token] with a role that can read and write to your database, such as the *Database Administrator* role, and then store the token securely.
93+
For {astra-db} databases, xref:astra-db-serverless:administration:manage-application-tokens.adoc[generate an application token] with a role that can read and write to your database, such as the {database-administrator-role} role, and then store the token securely.
9494
9595
At minimum, store the core token that is prefixed by `AstraCS:...`.
9696

modules/ROOT/pages/troubleshooting-tips.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ To resolve this issue, sign in to the {astra-ui}, and then check the xref:astra-
540540
If the database isn't in *Active* status, xref:astra-db-serverless:databases:database-statuses.adoc#hibernated[reactivate] or wait for the database to return to **Active** status, and then retry the connection.
541541

542542
If the database is in *Active* status, then the credentials likely have insufficient permissions.
543-
Try using an xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token scoped to a database], specifically a token with the *Database Administrator* role for your target database.
543+
Try using an xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token scoped to a database], specifically a token with the {database-administrator-role} role for your target database.
544544

545545
[[_async_read_timeouts_stream_id_map_exhausted]]
546546
=== Async read timeouts / stream id map exhausted

modules/sideloader/pages/migrate-sideloader.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ export dbID=*DATABASE_ID*
248248
export token=*TOKEN*
249249
----
250250
+
251-
Replace *`DATABASE_ID`* with the xref:astra-db-serverless:databases:create-database.adoc#get-db-id[database ID], and replace *`TOKEN`* with an xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token] with the *Database Administrator* role.
251+
Replace *`DATABASE_ID`* with the xref:astra-db-serverless:databases:create-database.adoc#get-db-id[database ID], and replace *`TOKEN`* with an xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token] with the {database-administrator-role} role.
252252
+
253253
[TIP]
254254
====

0 commit comments

Comments
 (0)