synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add initial docs to groups and rbac (#4455)

Browse Source 
* docs: Add initial docs to groups and rbac

* Update manifest

* Apply suggestions from code review

Co-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 use

Co-authored-by: Joe Previte <jjprevite@gmail.com>
Co-authored-by: Ben <me@bpmct.net>
This commit is contained in:
Bruno Quaresma
2022-10-11 15:34:41 -03:00
committed by GitHub
parent 9dcbe753f4
commit c13e68248b
14 changed files with 70 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/admin/audit-logs.md
View File

@ -1,6 +1,6 @@
# Audit Logs
Audit Logs allows **Admins** and **Auditors** to monitor user operations in
Audit Logs allows **Auditors** to monitor user operations in
their deployment.
## Tracked Events
@ -32,4 +32,4 @@ The supported filters are:
## Enabling this feature
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).
This feature is only available with an enterprise license. [Learn more](./enterprise.md)

3
docs/admin/enterprise.md
View File

@ -7,13 +7,14 @@ These features are available in the enterprise edition:
- [Audit Logging](./audit-logs.md)
- [Browser Only Connections](../networking.md#browser-only-connections)
- [Groups](./groups.md)
- [Template RBAC](./rbac.md)
- [Quotas](./quotas.md)
- [SCIM](./auth.md#scim)
And we're releasing these imminently:
- High Availability
- Template RBAC
- Multiple Git Provider Authentication
## Adding your license key

10
docs/admin/groups.md Normal file
View File

@ -0,0 +1,10 @@
# Groups
Groups can be used with [template RBAC](./rbac.md) to give groups of users access to specific templates.
![Groups](../images/groups.png)
## Enabling this feature
This feature is only available with an enterprise license. [Learn more](./enterprise.md)

4
docs/admin/quotas.md
View File

@ -15,6 +15,10 @@ Then, when users create workspaces they would see:
<img src="../images/admin/quotas.png"/>
## Enabling this feature
This feature is only available with an enterprise license. [Learn more](./enterprise.md)
## Up next
- [Enterprise](./enterprise.md)

18
docs/admin/rbac.md Normal file
View File

@ -0,0 +1,18 @@
# Role Based Access Control (RBAC)
Use RBAC to define which users and [groups](./groups.md) can use specific templates in Coder.
![rbac](../images/template-rbac.png)
The "Everyone" group makes a template accessible to all users. This can be removed to make a template private.
## Permissions
You can set the following permissions:
- **Admin**: Read, use, edit, push, and delete
- **View**: Read, use
## Enabling this feature
This feature is only available with an enterprise license. [Learn more](./enterprise.md)

13
docs/admin/users.md
View File

@ -7,12 +7,13 @@ This article walks you through the user roles available in Coder and creating an
Coder offers these user roles in the community edition:
| | User Admin | Template Admin | Owner |
| ------------------------------------------ | ---------- | -------------- |-------|
| Add and remove Users | ✅ | | ✅ |
| Change User roles | | | ✅ |
| Manage Templates | | ✅ | ✅ |
| View, update and delete **ALL** Workspaces | | ✅ | ✅ |
| Execute and use **ALL** Workspaces | | | ✅ |
| ------------------------------------------ | ---------- | -------------- | ----- |
| Add and remove Users | ✅ | | ✅ |
| Manage groups (enterprise) | | | |
| Change User roles | | | ✅ |
| Manage **ALL** Templates | | ✅ | ✅ |
| View, update and delete **ALL** Workspaces | | ✅ | ✅ |
| Execute and use **ALL** Workspaces | | | ✅ |
A user may have one or more roles. All users have an implicit Member role
that may use personal workspaces.