Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitc13e682

Browse files
BrunoQuaresmajsjoeiobpmct
authored
docs: Add initial docs to groups and rbac (#4455)
* docs: Add initial docs to groups and rbac* Update manifest* Apply suggestions from code reviewCo-authored-by: Joe Previte <jjprevite@gmail.com>* use single user icon* chore: add labels and standardize enterprise messaging* clarify template role* add groups role* fix typo* rename access to useCo-authored-by: Joe Previte <jjprevite@gmail.com>Co-authored-by: Ben <me@bpmct.net>
1 parent9dcbe75 commitc13e682

File tree

14 files changed

+70
-17
lines changed

14 files changed

+70
-17
lines changed

‎docs/admin/audit-logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#Audit Logs
22

3-
Audit Logs allows**Admins** and**Auditors** to monitor user operations in
3+
Audit Logs allows**Auditors** to monitor user operations in
44
their deployment.
55

66
##Tracked Events
@@ -32,4 +32,4 @@ The supported filters are:
3232

3333
##Enabling this feature
3434

35-
This feature isauto enabled for all enterprisedeployments. Admins may contact us to purchase a license[here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).
35+
This feature isonly available with an enterpriselicense.[Learn more](./enterprise.md)

‎docs/admin/enterprise.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ These features are available in the enterprise edition:
77

88
-[Audit Logging](./audit-logs.md)
99
-[Browser Only Connections](../networking.md#browser-only-connections)
10+
-[Groups](./groups.md)
11+
-[Template RBAC](./rbac.md)
1012
-[Quotas](./quotas.md)
1113
-[SCIM](./auth.md#scim)
1214

1315
And we're releasing these imminently:
1416

1517
- High Availability
16-
- Template RBAC
1718
- Multiple Git Provider Authentication
1819

1920
##Adding your license key

‎docs/admin/groups.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#Groups
2+
3+
Groups can be used with[template RBAC](./rbac.md) to give groups of users access to specific templates.
4+
5+
![Groups](../images/groups.png)
6+
7+
##Enabling this feature
8+
9+
This feature is only available with an enterprise license.[Learn more](./enterprise.md)
10+

‎docs/admin/quotas.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ Then, when users create workspaces they would see:
1515

1616
<imgsrc="../images/admin/quotas.png"/>
1717

18+
##Enabling this feature
19+
20+
This feature is only available with an enterprise license.[Learn more](./enterprise.md)
21+
1822
##Up next
1923

2024
-[Enterprise](./enterprise.md)

‎docs/admin/rbac.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#Role Based Access Control (RBAC)
2+
3+
Use RBAC to define which users and[groups](./groups.md) can use specific templates in Coder.
4+
5+
![rbac](../images/template-rbac.png)
6+
7+
The "Everyone" group makes a template accessible to all users. This can be removed to make a template private.
8+
9+
##Permissions
10+
11+
You can set the following permissions:
12+
13+
-**Admin**: Read, use, edit, push, and delete
14+
-**View**: Read, use
15+
16+
##Enabling this feature
17+
18+
This feature is only available with an enterprise license.[Learn more](./enterprise.md)

‎docs/admin/users.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ This article walks you through the user roles available in Coder and creating an
77
Coder offers these user roles in the community edition:
88

99
|| User Admin| Template Admin| Owner|
10-
| ------------------------------------------| ----------| --------------|-------|
11-
| Add and remove Users| ✅|| ✅|
12-
| Change User roles||| ✅|
13-
| Manage Templates|| ✅| ✅|
14-
| View, update and delete**ALL** Workspaces|| ✅| ✅|
15-
| Execute and use**ALL** Workspaces||| ✅|
10+
| ------------------------------------------| ----------| --------------| -----|
11+
| Add and remove Users| ✅|| ✅|
12+
| Manage groups (enterprise)||||
13+
| Change User roles||| ✅|
14+
| Manage**ALL** Templates|| ✅| ✅|
15+
| View, update and delete**ALL** Workspaces|| ✅| ✅|
16+
| Execute and use**ALL** Workspaces||| ✅|
1617

1718
A user may have one or more roles. All users have an implicit Member role
1819
that may use personal workspaces.

‎docs/images/groups.png

166 KB
Loading

‎docs/images/icons/rbac.svg

Lines changed: 1 addition & 0 deletions
Loading

‎docs/images/icons/users.svg

Lines changed: 1 addition & 1 deletion
Loading

‎docs/images/template-rbac.png

174 KB
Loading

‎docs/manifest.json

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,17 +174,31 @@
174174
"icon_path":"./images/icons/wrench.svg",
175175
"path":"./admin/index.md",
176176
"children": [
177+
{
178+
"title":"Authentication",
179+
"description":"Learn how to set up authentication using GitHub or OpenID Connect.",
180+
"icon_path":"./images/icons/key.svg",
181+
"path":"./admin/auth.md"
182+
},
177183
{
178184
"title":"Users",
179185
"description":"Learn about user roles available in Coder and how to create and manage users",
180186
"icon_path":"./images/icons/users.svg",
181187
"path":"./admin/users.md"
182188
},
183189
{
184-
"title":"Authentication",
185-
"description":"Learn how to set up authentication using GitHub or OpenID Connect.",
186-
"icon_path":"./images/icons/key.svg",
187-
"path":"./admin/auth.md"
190+
"title":"Groups",
191+
"description":"Learn how to manage user groups",
192+
"icon_path":"./images/icons/group.svg",
193+
"path":"./admin/groups.md",
194+
"state":"enterprise"
195+
},
196+
{
197+
"title":"RBAC",
198+
"description":"Learn how to use the role based access control",
199+
"icon_path":"./images/icons/rbac.svg",
200+
"path":"./admin/rbac.md",
201+
"state":"enterprise"
188202
},
189203
{
190204
"title":"Configuration",

‎docs/templates.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,10 @@ practices:
310310
- The Coder agent logs are typically stored in`/var/log/coder-agent.log`
311311
- The Coder agent startup script logs are typically stored in`/var/log/coder-startup-script.log`
312312

313+
##Template permissions (enterprise)
314+
315+
Template permissions can be used to give users and groups access to specific templates.[Learn more about RBAC](./admin/rbac.md).
316+
313317
##Change Management
314318

315319
We recommend source controlling your templates as you would other code.

‎site/src/pages/TemplatePage/TemplatePermissionsPage/TemplatePermissionsPage.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export const TemplatePermissionsPage: FC<
5555
</Link>
5656
<Link
5757
underline="none"
58-
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
58+
href="https://coder.com/docs/coder-oss/latest/admin/rbac"
5959
target="_blank"
6060
rel="noreferrer"
6161
>

‎site/src/pages/TemplatePage/TemplatePermissionsPage/TemplatePermissionsPageView.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,14 @@ const RoleSelect: FC<SelectProps> = (props) => {
132132
<MenuItemkey="view"value="view"className={styles.menuItem}>
133133
<div>
134134
<div>View</div>
135-
<divclassName={styles.menuItemSecondary}>Read,access</div>
135+
<divclassName={styles.menuItemSecondary}>Read,use</div>
136136
</div>
137137
</MenuItem>
138138
<MenuItemkey="admin"value="admin"className={styles.menuItem}>
139139
<div>
140140
<div>Admin</div>
141141
<divclassName={styles.menuItemSecondary}>
142-
Read,access, edit, push, and delete
142+
Read,use, edit, push, and delete
143143
</div>
144144
</div>
145145
</MenuItem>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp