Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit 0695e87

Browse files
nerpaulaSimran-B
andauthored
DOC-442 | Authentication of notebooks (#1322)
* accessing notebooks updates * Formatting, review feedback * Update permission and role lists with notebook execution --------- Co-authored-by: Simran Spiller <simran@arangodb.com>
1 parent 6ef0e6f commit 0695e87

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

arangograph/access-control.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,9 @@ The roles below are described following this pattern:
342342
- `notebook.notebook.resume`
343343
- `notebook.notebook.update`
344344

345+
**Notebook Executor** (`notebook-executor`):
346+
- `notebook.notebook.execute`
347+
345348
**Notebook Viewer** (`notebook-viewer`):
346349
- `notebook.model.list`
347350
- `notebook.notebook.get`
@@ -458,6 +461,8 @@ Permissions are solely defined by the ArangoGraph API.
458461
{% comment %}
459462
Retrieved with the below command, with manual adjustments:
460463
oasisctl list permissions
464+
465+
Note that if the tier is "internal", there is an `internal-dashboard` API that should be excluded in below list!
461466
{% endcomment %}
462467

463468
| API | Kind | Verbs
@@ -497,7 +502,7 @@ oasisctl list permissions
497502
| `monitoring` | `logs` | `get`
498503
| `network` | `privateendpointservice` | `create`, `get`, `get-by-deployment-id`, `get-feature`, `update`
499504
| `notebook` | `model` | `list`
500-
| `notebook` | `notebook` | `create`, `delete`, `get`, `list`, `pause`, `resume`, `update`
505+
| `notebook` | `notebook` | `create`, `delete`, `execute`, `get`, `list`, `pause`, `resume`, `update`
501506
| `notification` | `deployment-notification` | `list`, `mark-as-read`, `mark-as-unread`
502507
| `prepaid` | `prepaiddeployment` | `get`, `list`
503508
| `replication` | `deploymentreplication` | `get`, `update`
27.4 KB
Loading

arangograph/notebooks.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,17 @@ favorite GraphML libraries with GPUs.
4444
1. Navigate to the **Deployments** tab.
4545
2. Open the deployment in which you want to create the notebook.
4646
3. Go to the **Notebooks** tab and click the **Create Notebook** button.
47-
4. Enter a name and optionally a description for your new notebook. Click **Save**.
48-
5. The notebook's phase is set to **Initializing**. Once the phase changes to
49-
**Running**, the notebook's endpoint will be accessible.
50-
6. Click the **Open notebook** button to access your notebook.
51-
7. To log in into your notebook, use the `root` password from your deployment.
47+
4. Enter a name and optionally a description for your new notebook.
48+
5. Select a configuration model from the dropdown menu. Click **Save**.
49+
6. The notebook's phase is set to **Initializing**. Once the phase changes to
50+
**Running**, the notebook's endpoint is accessible.
51+
7. Click the **Open notebook** button to access your notebook.
52+
8. To access your notebook, you need to be signed into ArangoGraph as a user with
53+
the `notebook.notebook.execute` permission in your project. Organization
54+
owners have this permission enabled by default. The `notebook-executor` role
55+
which contains the permission can also be granted to other members of the
56+
organization via roles. See how to create a
57+
[role binding](access-control.html#how-to-view-edit-or-remove-role-bindings-of-a-policy).
5258

5359
{% hint 'info' %}
5460
Depending on the tier your organization belongs to, different limitations apply:

0 commit comments

Comments
 (0)