Skip to content

Commit 7cee143

Browse files
committed
chore: add labels and standardize enterprise messaging
1 parent c338062 commit 7cee143

File tree

11 files changed

+48
-28
lines changed

11 files changed

+48
-28
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 is auto enabled for all enterprise deployments. Admins may contact us to purchase a license [here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).
35+
This feature is only available with an enterprise license. [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: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
# User Groups
1+
# Groups
22

3-
Groups are helpful for defining a set of common permissions for a group of users. It can be used with [RBAC](../rbac.md) to have a better access control.
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)
46

57
## Enabling this feature
68

7-
This feature is auto enabled for all enterprise deployments. Admins may contact us to purchase a license [here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).
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
<img src="../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: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
# Role Based Access Control (RBAC)
22

3-
RBAC helps admins to control what their users and [groups](./groups.md) can access.
3+
Use RBAC to define which users and [groups](./groups.md) can use specific templates in Coder.
44

5-
> **Note**:
6-
> Right now, the only resource type where an admin can use RBAC is [Template](../templates.md) but we are planning to extend this capability to other resource types as well.
5+
![rbac](../images/template-rbac.png)
6+
7+
The "Everyone" group makes a template accessable to all users. This can be removed to make a template private.
78

89
## Permissions
910

1011
You can set the following permissions:
1112

12-
- **Admin**. Can edit and remove the resource including the permissions.
13-
- **View**. Can only read and access the resource.
13+
- **Admin**: Read, access, edit, push, and delete
14+
- **View**: Read, access
1415

1516
## Enabling this feature
1617

17-
This feature is auto-enabled for all enterprise deployments. Admins may contact us to purchase a license [here](https://coder.com/contact?note=I%20want%20to%20upgrade%20my%20license).
18+
This feature is only available with an enterprise license. [Learn more](./enterprise.md)

docs/admin/users.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ 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+
| Change User roles | | ||
13+
| Manage Templates | |||
14+
| View, update and delete **ALL** Workspaces | |||
15+
| Execute and use **ALL** Workspaces | | ||
1616

1717
A user may have one or more roles. All users have an implicit Member role
1818
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/template-rbac.png

174 KB
Loading

docs/manifest.json

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
2-
"versions": ["main", "v0.8.1", "v0.7.12"],
2+
"versions": [
3+
"main",
4+
"v0.8.1",
5+
"v0.7.12"
6+
],
37
"routes": [
48
{
59
"title": "About",
@@ -170,6 +174,12 @@
170174
"icon_path": "./images/icons/wrench.svg",
171175
"path": "./admin/index.md",
172176
"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+
},
173183
{
174184
"title": "Users",
175185
"description": "Learn about user roles available in Coder and how to create and manage users",
@@ -180,19 +190,15 @@
180190
"title": "Groups",
181191
"description": "Learn how to manage user groups",
182192
"icon_path": "./images/icons/group.svg",
183-
"path": "./admin/groups.md"
193+
"path": "./admin/groups.md",
194+
"state": "enterprise"
184195
},
185196
{
186197
"title": "RBAC",
187198
"description": "Learn how to use the role based access control",
188-
"icon_path": "./images/icons/key.svg",
189-
"path": "./admin/rbac.md"
190-
},
191-
{
192-
"title": "Authentication",
193-
"description": "Learn how to set up authentication using GitHub or OpenID Connect.",
194-
"icon_path": "./images/icons/key.svg",
195-
"path": "./admin/auth.md"
199+
"icon_path": "./images/icons/rbac.svg",
200+
"path": "./admin/rbac.md",
201+
"state": "enterprise"
196202
},
197203
{
198204
"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.

0 commit comments

Comments
 (0)