Skip to content

Commit 0779a23

Browse files
authored
add role and permission attributes (#172)
1 parent 5b7b675 commit 0779a23

5 files changed

Lines changed: 21 additions & 11 deletions

File tree

antora.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,14 @@ asciidoc:
5555
scb-short: 'SCB'
5656
scb-brief: 'Secure Connect Bundle'
5757

58+
# Astra role attributes (compare with astra-vector-docs antora.yml)
59+
organization-administrator-role: 'xref:astra-db-serverless:administration:rbac.adoc#organization-administrator-role[Organization Administrator]'
60+
administrator-service-account-role: 'xref:astra-db-serverless:administration:rbac.adoc#administrator-service-account-role[Administrator Service Account]'
61+
api-administrator-service-account-role: 'xref:astra-db-serverless:administration:rbac.adoc#api-administrator-service-account-role[API Administrator Service Account]'
62+
api-administrator-user-role: 'xref:astra-db-serverless:administration:rbac.adoc#api-administrator-user-role[API Administrator User]'
63+
64+
# Astra permission attributes (compare with astra-vector-docs antora.yml)
65+
manage-streaming-permission: 'xref:astra-db-serverless:administration:rbac.adoc#manage-streaming-permission[Manage Streaming]'
66+
view-db-permission: 'xref:astra-db-serverless:administration:rbac.adoc#view-db-permission[View DB]'
67+
5868
# For more attributes, see release.yml in the datastax-docs-site repo

modules/ROOT/pages/astream-org-permissions.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,26 @@ For information about {astra} RBAC, including default roles, custom roles, permi
88

99
Permissions specific to {product} include the following:
1010

11-
* *Manage Streaming* (`org-stream-manage`): View, add, edit, or remove {product} configurations.
11+
* {manage-streaming-permission} (`org-stream-manage`): View, add, edit, or remove {product} configurations.
1212

1313
=== Default roles for {product}
1414

1515
There are no default {astra} roles specifically scoped to {product}.
16-
However, the following default roles have the *Manage Streaming* permission:
16+
However, the following default roles have the {manage-streaming-permission} permission:
1717

18-
* *Organization Administrator*
19-
* *Administrator Service Account*
20-
* *API Administrator Service Account*
21-
* *API Administrator User*
18+
* {organization-administrator-role}
19+
* {administrator-service-account-role}
20+
* {api-administrator-service-account-role}
21+
* {api-administrator-user-role}
2222

2323
For information about permissions assigned to default roles, see xref:astra-db-serverless:administration:manage-database-access.adoc[].
2424

2525
=== Custom roles for {product}
2626

2727
If you xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[create custom roles] for {product}, those roles must have the following permissions, at minimum:
2828

29-
* *Manage Streaming* (`org-stream-manage`): View and manage {product} in the {astra-ui}.
30-
* *View DB* (`org-db-view`): View the {astra-ui} in general.
29+
* {manage-streaming-permission} (`org-stream-manage`): View and manage {product} in the {astra-ui}.
30+
* {view-db-permission} (`org-db-view`): View the {astra-ui} in general.
3131

3232
Additional permissions might be required, depending on the tasks the role needs to perform.
3333

modules/developing/pages/astream-cdc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ To enable CDC for {astra-db}, you need the following:
179179

180180
* An active {astra-url}[{astra} account] with access to an organization that has an {product} subscription plan.
181181
+
182-
You need a role that grants permission to manage streaming tenants, such as the *Organization Administrator* role.
182+
You need a role that grants permission to manage streaming tenants, such as the {organization-administrator-role} role.
183183

184184
* An active xref:astra-db-serverless:databases:create-database.adoc[database] with at least one xref:astra-db-serverless:databases:manage-keyspaces.adoc[keyspace].
185185

modules/getting-started/pages/real-time-data-pipelines-tutorial.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ CREATE TABLE click_data.product_clicks (
205205
* **Name**: Enter `all-clicks`.
206206
* **Input topic**: Select your `all-clicks` topic in your `production` namespace.
207207
* **Database**: Select your `webstore-clicks` database.
208-
* **Token**: Click the link to create an {astra} application token with the **Organization Administrator** role, and then enter the token in the sink's **Token** field.
208+
* **Token**: Click the link to create an {astra} application token with the {organization-administrator-role} role, and then enter the token in the sink's **Token** field.
209209
Store the token securely, you will use it multiple times during this tutorial.
210210
* **Keyspace**: Enter `click_data`.
211211
* **Table Name**: Enter `all_clicks`.

modules/operations/pages/monitoring/stream-audit-logs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ You can use the {devops-api-ref-url}#tag/Organization-Operations/operation/confi
3939

4040
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Admin*.
4141

42-
. Click **Tokens**, and then create an xref:astra-db-serverless:administration:manage-application-tokens.adoc[{astra} application token] with the **Organization Administrator** role.
42+
. Click **Tokens**, and then create an xref:astra-db-serverless:administration:manage-application-tokens.adoc[{astra} application token] with the {organization-administrator-role} role.
4343

4444
. Create the audit log streaming configuration using the values from the tenant's `client.conf` file and your {pulsar-short} configuration:
4545
+

0 commit comments

Comments
 (0)