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

DOC-442 | Authentication of notebooks #1322

Merged
merged 3 commits into from
Apr 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion arangograph/access-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,9 @@ The roles below are described following this pattern:
- `notebook.notebook.resume`
- `notebook.notebook.update`

**Notebook Executor** (`notebook-executor`):
- `notebook.notebook.execute`

**Notebook Viewer** (`notebook-viewer`):
- `notebook.model.list`
- `notebook.notebook.get`
Expand Down Expand Up @@ -458,6 +461,8 @@ Permissions are solely defined by the ArangoGraph API.
{% comment %}
Retrieved with the below command, with manual adjustments:
oasisctl list permissions

Note that if the tier is "internal", there is an `internal-dashboard` API that should be excluded in below list!
{% endcomment %}

| API | Kind | Verbs
Expand Down Expand Up @@ -497,7 +502,7 @@ oasisctl list permissions
| `monitoring` | `logs` | `get`
| `network` | `privateendpointservice` | `create`, `get`, `get-by-deployment-id`, `get-feature`, `update`
| `notebook` | `model` | `list`
| `notebook` | `notebook` | `create`, `delete`, `get`, `list`, `pause`, `resume`, `update`
| `notebook` | `notebook` | `create`, `delete`, `execute`, `get`, `list`, `pause`, `resume`, `update`
| `notification` | `deployment-notification` | `list`, `mark-as-read`, `mark-as-unread`
| `prepaid` | `prepaiddeployment` | `get`, `list`
| `replication` | `deploymentreplication` | `get`, `update`
Expand Down
Binary file modified arangograph/images/arangograph-notebooks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 11 additions & 5 deletions arangograph/notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,17 @@ favorite GraphML libraries with GPUs.
1. Navigate to the **Deployments** tab.
2. Open the deployment in which you want to create the notebook.
3. Go to the **Notebooks** tab and click the **Create Notebook** button.
4. Enter a name and optionally a description for your new notebook. Click **Save**.
5. The notebook's phase is set to **Initializing**. Once the phase changes to
**Running**, the notebook's endpoint will be accessible.
6. Click the **Open notebook** button to access your notebook.
7. To log in into your notebook, use the `root` password from your deployment.
4. Enter a name and optionally a description for your new notebook.
5. Select a configuration model from the dropdown menu. Click **Save**.
6. The notebook's phase is set to **Initializing**. Once the phase changes to
**Running**, the notebook's endpoint is accessible.
7. Click the **Open notebook** button to access your notebook.
8. To access your notebook, you need to be signed into ArangoGraph as a user with
the `notebook.notebook.execute` permission in your project. Organization
owners have this permission enabled by default. The `notebook-executor` role
which contains the permission can also be granted to other members of the
organization via roles. See how to create a
[role binding](access-control.html#how-to-view-edit-or-remove-role-bindings-of-a-policy).

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