Skip to content

Commit 88f8218

Browse files
authored
DOC: corrections in user access doc (#1688)
* corrections in user access doc * correction for edit chart group * correction for edit chart group
1 parent 3378c55 commit 88f8218

File tree

1 file changed

+44
-32
lines changed

1 file changed

+44
-32
lines changed

docs/user-guide/global-configurations/user-access.md

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -9,46 +9,50 @@ Like any enterprise product, Devtron supports fine grained access control to the
99

1010
Access can be added to the User either directly or via Groups.
1111

12-
## Access Levels
12+
## Role-based Access Levels
1313

14-
Devtron supports 5 levels of access
14+
Devtron supports 5 levels of access:
1515

1616
1. **View**: User with `view` only access has the least privilege. This user can only view combination of environments, applications and helm charts on which access has been granted to the user. This user cannot view sensitive data like secrets used in applications or charts.
1717
2. **Build and Deploy**: In addition to `view` privilege mentioned in above, user with `build and deploy` permission can build and deploy the image of permitted applications and helm charts to permitted environments.
1818
3. **Admin**: User with `admin` access can create, edit, delete and view permitted applications in permitted projects.
1919
4. **Manager**: User with `manager` access can do everything that an `admin` type user can do, in addition they can also give and revoke access of users for the applications and environments of which they are `manager`.
20-
5. **Super Admin**: User with `super admin` privilege has unrestricted access to all Devtron resources. Super admin can create, modify, delete and view any Devtron resource without any restriction; its like Superman without the weakness of Kryptonite. Super Admin can also add and delete user access across any Devtron resource, add delete git repository credentials, docker registry credentials, cluster and environment.
20+
5. **Super Admin**: User with `super admin` privilege has unrestricted access to all Devtron resources. Super admin can create, modify, delete and view any Devtron resource without any restriction; its like Superman without the weakness of Kryptonite. Super Admin can also add and delete user access across any Devtron resource, add delete git repository credentials, container registry credentials, cluster and environment.
2121

22-
| Access Level | View App | Create App | Edit App | Delete App | Trigger App |
23-
| ---------------- | -------- | ---------- | -------- | ---------- | ----------- |
24-
| View | Yes | No | No | No | No |
25-
| Build and Deploy | Yes | No | No | No | Yes |
26-
| Admin | Yes | Yes | Yes | Yes | Yes |
27-
| Manager | Yes | Yes | Yes | Yes | Yes |
28-
| Super Admin | Yes | Yes | Yes | Yes | Yes |
22+
## User Roles And Permissions
2923

30-
<br/>
24+
### 1. Custom Applications
3125

32-
| Access Level | View Charts | Install Charts | Edit Charts | Delete Charts |
33-
| ---------------- | ----------- | -------------- | ----------- | ------------- |
34-
| View | Yes | No | No | No |
26+
| User Roles | View | Create | Edit | Delete | Build & Deploy|
27+
| :--- | :---: | :---: | :---: | :---: | :---: |
28+
| View | Yes | No | No | No | No |
29+
| Build and Deploy | Yes | No | No | No | Yes |
30+
| Admin | Yes | Yes | Yes | Yes | Yes |
31+
| Manager | Yes | Yes | Yes | Yes | Yes |
32+
| Super Admin | Yes | Yes | Yes | Yes | Yes |
33+
34+
### 2. Helm Charts
35+
36+
| User Roles | View | Deploy | Edit | Delete |
37+
| :---: | :---: | :---: | :---: | :---: |
38+
| View Only | Yes | No | No | No |
3539
| Build and Deploy | Yes | No | No | No |
3640
| Admin | Yes | Yes | Yes | Yes |
3741
| Manager | Yes | Yes | Yes | Yes |
3842
| Super Admin | Yes | Yes | Yes | Yes |
3943

40-
<br/>
44+
#### 3. User Access
4145

42-
| Access Level | Add User Access | Edit User Access | Delete User Access |
43-
| ------------ | --------------- | ---------------- | ------------------ |
46+
| User Roles | Add User Access | Edit User Access | Delete User Access |
47+
| :--- | :---: | :---: | :---: |
4448
| Manager | Yes | Yes | Yes |
4549
| Super Admin | Yes | Yes | Yes |
4650

47-
<br/>
51+
#### 4. Global Configurations
4852

49-
| Access Level | Add Global Config | Edit Global Config | Delete Global Config |
50-
| ------------ | ----------------- | ------------------ | -------------------- |
51-
| Super Admin | Yes | Yes |
53+
| User Role | Add Global Config | Edit Global Config | Delete Global Config |
54+
| :--- | :---: | :---: | :---: |
55+
| Super Admin | Yes | Yes | Yes |
5256

5357
To control the access of User and Group-
5458

@@ -89,7 +93,7 @@ In the `Email address` box, you have to provide the mail ID of the user to whom
8993

9094
### Assign super admin permissions
9195

92-
If you check the option `Assign super admin permissions`, the user will get full access to your system and the rest of the options will disappear. Please check [above](#access-levels) to see permission levels.
96+
If you check the option `Assign super admin permissions`, the user will get full access to your system and the rest of the options will disappear. Please check [above](#access-levels) to see permission levels. Only users with super admin permissions can assign super admin permissions to a user.
9397

9498
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/user-access/add-user-2.jpg)
9599

@@ -133,7 +137,7 @@ There are four different view access levels/Role available for both User and Gro
133137

134138
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/user-access/user-access-permission_1.JPG)
135139

136-
You can add multiple rows, for Devtron App Permission.
140+
You can add multiple rows, for Devtron app permission.
137141

138142
Once you have finished assigning the appropriate permissions for the listed users, Click on `Save`.
139143

@@ -167,26 +171,34 @@ There are four different view access levels/Role available for both User and Gro
167171

168172
### Chart Group Permissions
169173

170-
You can also manage the access of users to Chart Groups in your project. By default, user has the `View` permission for the charts deployed in the environments on which he/she has at least `view` access to any application.
174+
You can also manage the access of users to Chart Groups in your project.
171175

172-
You can either give the users permission to `Create` or `Edit`.
176+
**NOTE:** You can only give users the ability to `create` or `edit`, not both.
173177

174-
Click on the checkbox of `Create`, if you want the users to create, view, edit, or delete all the chart groups.
178+
Click on the checkbox of `Create`, if you want the users to create, view, edit, or delete the chart groups.
175179

176180
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/user-access/chart+group+permission_create_3.JPG)
177181

178-
Click on the checkbox of `Edit`, if you want to `allow` or `deny` users to edit the chart groups.
182+
To permit a user to only `edit` the chart groups, check `Specific chart group` from `Edit` drop-down. In the following field, select the chart group for which you want to grant the user edit permission.
179183

180-
Select on `Deny` option from the drop-down menu, if you want to restrict the users to edit the chart groups.
184+
Go to `Edit` drop-down, if you want to `allow` or `deny` users to edit the chart groups.
185+
186+
Select on `Deny` option from the drop-down, if you want to restrict the users to edit the chart groups.
181187

182188
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/user-access/chart+group+permission_edit_4.JPG)
183189

184-
Select the `Specific Charts` option from the drop-down menu, and then select the chart groups for which you want to allow users to edit, from the other drop-down menu.
190+
Select the `Specific Charts` option from the drop-down and then select the chart groups for which you want to allow users to edit, from the other drop-down menu.
185191

186192
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/user-access/chart+group+permission_edit+specific+chart_5.JPG)
187193

188194
Click on `Save`, once you have configured all the required permissions for the users.
189195

196+
| Action | Permissions |
197+
| :--- | :--- |
198+
| View | Only can view chart groups |
199+
| Create | Can create, view, edit or delete |
200+
| Edit | <ul><br/><li>**Deny:** Can't edit chart groups</li><li>**Specific chart groups:** can edit specific chart group</li></ul> |
201+
190202
### 3. Edit User Permissions
191203

192204
You can edit the user permissions, by clicking on the `downward arrow`.
@@ -197,9 +209,9 @@ Then you can edit the user permissions here.
197209

198210
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/user-access/edit+user+permission_devtron+app_2.JPG)
199211

200-
After you have done editing the user permissions. Click on `Save`.
212+
After you have done editing the user permissions, click on `Save`.
201213

202-
If you want to delete the user/users with particular permissions. Click on `Delete`.
214+
If you want to delete the user/users with particular permissions, click on `Delete`.
203215

204216
## Groups
205217

@@ -209,7 +221,7 @@ You can select the group which you are creating in the `Group permissions` secti
209221

210222
### 1. Add new Group
211223

212-
Click on `Add Group`, to create a new group.
224+
Go to `Groups` and click on `Add Group`, to create a new group.
213225

214226
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/user-access/Add+group+permission_dashboard_1.JPG)
215227

0 commit comments

Comments
 (0)