You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/global-configurations/authorization/permission-groups.md
+54-23
Original file line number
Diff line number
Diff line change
@@ -4,37 +4,42 @@ Using the `Permission groups`, you can assign a user to a particular group and a
4
4
5
5
The advantage of the `Permission groups` is to define a set of privileges like create, edit, or delete for the given set of resources that can be shared among the users within the group.
6
6
7
-
**Note**: The [User permissions](https://docs.devtron.ai/global-configurations/authorization/user-access) section for `Specific permissions` contains a drop-down list of all existing groups for which a user has an access. This is an optional field and more than one groups can be selected for a user.
7
+
{% hint style="info" %}
8
+
The [User permissions](../../global-configurations/authorization/user-access) section for `Specific permissions` contains a drop-down list of all existing groups for which a user has an access. This is an optional field and more than one groups can be selected for a user.
9
+
{% endhint %}
8
10
9
11
## Add Group
10
12
11
-
To add a group, go to the `Authorization > Permissions groups` section of `Global Configurations`. Click**Add group**.
13
+
Go to **Global Configurations** → **Authorization** → **Permissions groups** →**Add group**.
Assign the permissions of groups to users to manage access for:
21
+
You can either grant [super-admin](../../global-configurations/authorization/user-access.md#role-based-access-levels) permission to a user group or specific permissions to manage access for:
In `Devtron Apps` option, you can provide access to a group to manage permission for custom apps created using Devtron.
29
32
30
-
**Note**: The `Devtron Apps` option will be available only if you install [CI/CD integration](https://docs.devtron.ai/usage/integrations/build-and-deploy-ci-cd).
33
+
{% hint style="info" %}
34
+
The `Devtron Apps` option will be available only if you install [CI/CD integration](https://docs.devtron.ai/usage/integrations/build-and-deploy-ci-cd).
|**Project**| Select a project from the drop-down list to which you want to give permission to the group. You can select only one project at a time.<br>Note: If you want to select more than one project, then click `Add row`.</br> |
40
45
|**Environment**| Select the specific environment or all environments from the drop-down list.<br>Note: If you select `All environments` option, then a user gets access to all the current environments including any new environment which gets associated with the application later.</br> |
@@ -43,17 +48,17 @@ Provide the information in the following fields:
43
48
44
49
You can add multiple rows for `Devtron Apps` permission.
45
50
46
-
Once you have finished assigning the appropriate permissions for the groups, Click `Save`.
51
+
Once you have finished assigning the appropriate permissions for the groups, Click **Save**.
47
52
48
53
### Helm Apps Permissions
49
54
50
55
In `Helm Apps` option, you can provide access to a group to manage permission for Helm apps deployed from Devtron or outside Devtron.
|**Project**| Select a project from the drop-down list to which you want to give permission to the group. You can select only one project at a time.<br>Note: If you want to select more than one project, then click `Add row`.</br> |
59
64
|**Environment or cluster/namespace**| Select the specific environment or `all existing environments in default cluster` from the drop-down list.<br>Note: If you select `all existing + future environments in default cluster` option, then a user gets access to all the current environments including any new environment which gets associated with the application later.</br> |
@@ -62,25 +67,47 @@ Provide the information in the following fields:
62
67
63
68
You can add multiple rows for Devtron app permission.
64
69
65
-
Once you have finished assigning the appropriate permissions for the groups, Click `Save`.
70
+
Once you have finished assigning the appropriate permissions for the groups, Click **Save**.
71
+
72
+
### Jobs
73
+
74
+
In `Jobs` option, you can provide access to a group to manage permission for jobs created using Devtron.
|**Project**| Select a project from the drop-down list to which you want to give permission to the group. You can select only one project at a time.<br>Note: If you want to select more than one project, then click `Add row`.</br> |
83
+
|**Job Name**| Select the specific job name or all jobs from the drop-down list.<br>Note: If you select `All Jobs` option, then the user gets access to all the current jobs including any new job which gets associated with the project later.</br> |
84
+
|**Workflow**| Select the specific workflow or all workflows from the drop-down list.<br>Note: If you select `All Workflows` option, then the user gets access to all the current workflows including any new workflow which gets associated with the project later.</br> |
85
+
|**Environment**| Select the specific environment or all environments from the drop-down list.<br>Note: If you select `All environments` option, then the user gets access to all the current environments including any new environment which gets associated with the project later.</br> |
86
+
|**Role**| Select one of the [roles](#role-based-access-levels) to which you want to give permission to the user:<ul><li>`View only`</li></ul> <ul><li>`Run job`</li></ul><ul><li>`Admin`</li></ul> |
87
+
88
+
You can add multiple rows for `Jobs` permission.
89
+
90
+
Once you have finished assigning the appropriate permissions for the groups, Click **Save**.
66
91
67
92
68
93
### Kubernetes Resources Permissions
69
94
70
95
In `Kubernetes Resources` option, you can provide permission to view, inspect, manage, and delete resources in your clusters from [Kubernetes Resource Browser](https://docs.devtron.ai/usage/resource-browser) page in Devtron. You can also create resources from the `Kubernetes Resource Browser` page.
71
96
72
-
**Note**: Only super admin users will be able to see `Kubernetes Resources` tab and provide permission to other users to access `Resource Browser`.
97
+
{% hint style="info" %}
98
+
Only super admin users will be able to see `Kubernetes Resources` tab and provide permission to other users to access `Resource Browser`.
99
+
{% endhint %}
73
100
74
101
To provide Kubernetes resource permission, click `Add permission`.
|**Cluster**| Select a cluster from the drop-down list to which you want to give permission to the user. You can select only one cluster at a time.<br>Note: To add another cluster, then click `Add another`.</br> |
86
113
|**Namespace**| Select the namespace from the drop-down list. |
@@ -91,39 +118,43 @@ On the `Kubernetes resource permission`, provide the information in the followin
91
118
92
119
You can add multiple rows for Kubernetes resource permission.
93
120
94
-
Once you have finished assigning the appropriate permissions for the groups, Click `Save`.
121
+
Once you have finished assigning the appropriate permissions for the groups, Click **Save**.
95
122
96
123
### Chart Group Permissions
97
124
98
125
In `Chart group permission` option, you can manage the access of groups for Chart Groups in your project.
99
126
100
-
**Note**: The `Chart group permission` option will be available only if you install [CI/CD integration](https://docs.devtron.ai/usage/integrations/build-and-deploy-ci-cd).
127
+
{% hint style="info" %}
128
+
The `Chart group permission` option will be available only if you install [CI/CD integration](https://docs.devtron.ai/usage/integrations/build-and-deploy-ci-cd).
**NOTE:** You can only give users the ability to `create` or `edit`, not both.
133
+
{% hint style="info" %}
134
+
You can only give users the ability to `create` or `edit`, not both.
135
+
{% endhint %}
105
136
106
137
| Action | Permissions |
107
138
| :--- | :--- |
108
139
| View | Enable `View` to view chart groups only. |
109
140
| Create | Enable `Create` if you want the users to create, view, edit or delete the chart groups. |
110
141
| Edit | <ul><li>**Deny**: Select `Deny` option from the drop-down list to restrict the users to edit the chart groups.</li><li>**Specific chart groups**: Select the `Specific Charts Groups` option from the drop-down list and then select the chart group for which you want to allow users to edit.</li></ul> |
111
142
112
-
Click `Save`once you have configured all the required permissions for the groups.
143
+
Click **Save**once you have configured all the required permissions for the groups.
113
144
114
145
115
146
### Edit Permissions Groups
116
147
117
148
You can edit the permission groups by clicking the `downward arrow.`
Devtron provides a sample configuration out of the box. There are some values that you need to either get from your SSO provider or give to your SSO provider.
12
+
13
+
### Values to Fetch
14
+
15
+
* clientID
16
+
17
+
* clientSecret
18
+
19
+

20
+
21
+
### Values to Provide
22
+
23
+
* redirectURI (provided in SSO Login Services by Devtron)
24
+
25
+

Devtron provides a sample configuration out of the box. There are some values that you need to either get from your SSO provider or give to your SSO provider.
12
+
13
+
### Values to Fetch
14
+
15
+
* clientID
16
+
* clientSecret
17
+
18
+

19
+
20
+
### Values to Provide
21
+
22
+
* redirectURI (provided in SSO Login Services by Devtron)
23
+
24
+

Devtron provides a sample configuration out of the box. There are some values that you need to either get from your SSO provider or give to your SSO provider.
12
+
13
+
### Values to Fetch
14
+
15
+
* clientID
16
+
17
+
* clientSecret
18
+
19
+

20
+
21
+
22
+
### Values to Provide
23
+
24
+
* redirectURI (provided in SSO Login Services by Devtron)
25
+
26
+

Since LDAP supports creation of User Groups, this feature simplifies the onboarding process of organizations having a large headcount of users. It also eliminates repetitive permission assignment by automatically mapping your LDAP User groups to Devtron's [Permission Groups](../permission-groups.md) during single sign-on (SSO) login.
If you've created user groups in LDAP, you can create corresponding permission groups in Devtron with the same names. When members of those user groups first log in to Devtron, they'll automatically inherit the permissions from their Devtron permission group. This means you can't manually adjust or add [individual permissions for users](../user-access.md) mapped to a permission group.
32
+
33
+
{% hint style="warning" %}
34
+
SSO login requires exact matching between Devtron permission group names and LDAP user groups. Any discrepancies or missing groups will prevent successful login.
35
+
36
+
Once you save the configuration with this auto-assign feature enabled, existing user permissions will be cleared and the future permissions will be managed through [Permission Groups](../permission-groups.md) linked to LDAP user groups.
37
+
{% endhint %}
38
+
39
+
{% hint style="info" %}
40
+
If you're missing some permissions that you know you should have, try logging out and signing back in to Devtron. This will refresh your permissions based on your latest LDAP user group.
0 commit comments