Skip to content

Commit 9395480

Browse files
authored
DOC-5749 add specific token permissions for sideloader (#243)
* add specific permissions for sideloader token * Apply suggestion from @aimurphy
1 parent ceb8188 commit 9395480

3 files changed

Lines changed: 20 additions & 5 deletions

File tree

antora.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,7 @@ asciidoc:
6464
# Astra role attributes (compare with astra-vector-docs antora.yml)
6565
database-administrator-role: 'xref:astra-db-serverless:administration:rbac.adoc#database-administrator-role[Database Administrator]'
6666
read-write-user-role: 'xref:astra-db-serverless:administration:rbac.adoc#read-write-user-role[Read/Write User]'
67+
68+
# Astra permission attributes (compare with astra-vector-docs antora.yml)
69+
create-db-permission: 'xref:astra-db-serverless:administration:rbac.adoc#create-db-permission[Create DB]'
70+
view-db-permission: 'xref:astra-db-serverless:administration:rbac.adoc#view-db-permission[View DB]'

modules/sideloader/pages/migrate-sideloader.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,16 @@ See xref:astra-db-serverless:databases:database-limits.adoc[] for more informati
233233
[source,bash,subs="+quotes"]
234234
----
235235
export dbID=*DATABASE_ID*
236-
export token=*TOKEN*
236+
export token=*APPLICATION_TOKEN*
237237
----
238238
+
239-
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.
239+
Replace the following:
240+
+
241+
--
242+
* *`DATABASE_ID`*: The xref:astra-db-serverless:databases:create-database.adoc#get-db-id[database ID] of your target {astra-db} database.
243+
* *`APPLICATION_TOKEN`*: An xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token] with a role that has the required permissions for {sstable-sideloader}, which are {create-db-permission} and {view-db-permission}.
244+
You can use a built-in role, such as the {database-administrator-role} role, or a xref:astra-db-serverless:administration:rbac.adoc#custom-roles[custom role] with the required permissions.
245+
--
240246
+
241247
[TIP]
242248
====

modules/sideloader/pages/prepare-sideloader.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,14 @@ To minimize costs, you can xref:sideloader:cleanup-sideloader.adoc[manually clea
4242
Your target database must be an {astra-db} Serverless database.
4343
{sstable-sideloader} isn't compatible with {db-classic} databases.
4444

45-
If you haven't done so already, xref:astra-db-serverless:databases:create-database.adoc[create a database].
46-
You can use either a {db-serverless} or {db-serverless-vector} database.
47-
{db-serverless-vector} databases support both fixed-schema tables and dynamic-schema collections.
45+
If you haven't done so already, xref:astra-db-serverless:databases:create-database.adoc[create an {astra-db} database].
46+
{sstable-sideloader} supports both {db-serverless} and {db-serverless-vector} databases.
47+
Both types support CQL tables.
48+
However, you must create a {db-serverless-vector} database if you want to use the xref:astra-db-serverless:api-reference:dataapiclient.adoc[{data-api}] or xref:astra-db-serverless:databases:manage-collections.adoc[dynamic-schema collections].
49+
50+
To call the {sstable-sideloader} endpoints, you need the xref:astra-db-serverless:databases:create-database.adoc#get-db-id[database ID] and an xref:astra-db-serverless:administration:manage-application-tokens.adoc[{astra} application token] with a sufficiently privileged role.
51+
The required permissions for {sstable-sideloader} are {create-db-permission} and {view-db-permission}.
52+
You can use a built-in role, such as the {database-administrator-role} role, or a xref:astra-db-serverless:administration:rbac.adoc#custom-roles[custom role] with the required permissions.
4853

4954
=== PCU group requirement
5055

0 commit comments

Comments
 (0)