Skip to content

Commit e16dc12

Browse files
Merge pull request #850 from lavianalon/v2.18-RUN-18432-Data-Volumes
V2.18 run 18432 data volumes
2 parents e723b8e + 188f1ab commit e16dc12

File tree

2 files changed

+40
-15
lines changed

2 files changed

+40
-15
lines changed

docs/developer/admin-rest-api/data-volumes.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Data Volumes are snapshots of datasets stored in Kubernetes Persistent Volume Cl
1919
!!! Note
2020
Data volumes are not versioned.
2121

22+
![data-volumes-architecture](../img/data-volumes-arch.svg)
23+
2224
## Data volumes use cases
2325

2426
The following are typical use cases for Data Volumes:
@@ -30,6 +32,9 @@ The following are typical use cases for Data Volumes:
3032

3133
There is now a new role called `Data Volumes Administrator` which contains the following two sets of permissions and allows you to manage your Data Volumes easily.
3234

35+
!!! Note
36+
CRUD = *Create*, *Read*, *Update*, and *Delete*.
37+
3338
Data Volumes administrator contains two permission entities:
3439

3540
* Data volumes - CRUD
@@ -39,8 +44,8 @@ Data volumes (should have the origin project in the scope)
3944

4045
* Can create DV in the scope
4146
* Can read DV in the scope
42-
* Can update DV  in the scope
43-
* Can delete DV in the scope (even if DV is shared out of its scope)
47+
* Can update DV in the scope
48+
* Can delete DV in the scope
4449

4550
Data volumes - sharing list
4651

@@ -75,20 +80,19 @@ Data volumes - sharing list
7580
### Data volume permissions for each role
7681

7782
| Role | DV permissions |
78-
| --- | --- |
83+
| --- |------------|
7984
| Data volume administrator | DV CRUD, Sharing CRUD |
8085
| System administrator | DV CRUD, Sharing CRUD |
8186
| Department admin | DV CRUD, Sharing CRUD |
82-
| Department viewer | DV R, Sharing R |
87+
| Department viewer | DV R |
8388
| Researcher manager | DV CRUD, Sharing CRUD |
84-
| Editor | DV CRUD |
85-
| L1 | DV CRUD |
86-
| L2 | DV R |
87-
| ML engineer | DV R |
88-
| Assets admins  | DV R |
89-
| Application admin | DV R |
90-
| Cloud operator  | DV CRUD, Sharing CRUD |
91-
| Viewer | DV R |
89+
| Editor | DV CRUD, Sharing CRUD |
90+
| L1 | DV CRUD |
91+
| L2 | DV R |
92+
| ML engineer | DV R |
93+
| Assets admins  | DV R |
94+
| Application admin | DV R |
95+
| Viewer | DV R |
9296

9397
## Using Data volumes
9498

@@ -97,13 +101,13 @@ This section outlines the procedure for creating, sharing, and submitting (Resea
97101
### Creating Data Volumes
98102

99103
!!! Note
100-
Data volume admins can create data volumes within specific projects. Since data volumes are created from PVs, there has to be a PV in the namespace of a run:ai project for Run:Ai to have access to it and create the Data volume from it. Once the DV is created, the admin manages its sharing configurations.
104+
Data volume admins can create data volumes within specific projects. Since data volumes are created from PVCs, there has to be a PVC in the namespace of a run:ai project, and a PV bound to it, for Run:Ai to have access to it and create the Data volume from it. Once the DV is created, the admin manages its sharing configurations.
101105

102106
Data Volumes are created using the API endpoint. For more information, see [Data Volumes](https://app.run.ai/api/docs#tag/Data-Volumes)
103107

104108
### Sharing Data volumes
105109

106-
Sharing permissions is a sub-entity of the Data volume management permissions. Meaning they can be assigned independently. A user can have permission to create a DV but not to share it and vice versa. A data volume can be shared with one or multiple scopes. In all the scopes that the DV is shared, it can be used by the users in their workloads.
110+
Sharing permissions is a sub-entity of the Data volume management permissions. Meaning they can be assigned independently. A user can have permission to create a DV but not to share it. A data volume can be shared with one or multiple scopes. In all the scopes that the DV is shared, it can be used by the users in their workloads.
107111

108112
Data Volumes are shared using the API endpoint. For more information, see [Data Volumes](https://app.run.ai/api/docs#tag/Data-Volumes).
109113

@@ -113,6 +117,6 @@ You can attach a data volume to a workload during submission in the same way oth
113117

114118
Researchers can list available data volumes within their permitted scopes for easy selection.
115119

116-
For more information on using a data volume when submitting a workload, see [Submitting Worklodas]().
120+
For more information on using a data volume when submitting a workload, see [Submitting Workloads](../../admin/workloads/submitting-workloads.md).
117121

118122
You can also add a data volumes to your workload when submitting a workload via the API. For more information, see [Workloads](https://app.run.ai/api/docs#tag/Workloads).

docs/developer/img/data-volumes-arch.svg

Lines changed: 21 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)