Skip to content

docs: Add initial docs to groups and rbac #4455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 11, 2022
Merged

docs: Add initial docs to groups and rbac #4455

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
79a2f85
docs: Add initial docs to groups and rbac
BrunoQuaresma Oct 10, 2022
d9498e2
Update manifest
BrunoQuaresma Oct 10, 2022
dfc5378
Apply suggestions from code review
BrunoQuaresma Oct 10, 2022
e37a66a
use single user icon
bpmct Oct 10, 2022
f332528
chore: add labels and standardize enterprise messaging
bpmct Oct 11, 2022
a5003d1
clarify template role
bpmct Oct 11, 2022
2304f2f
add groups role
bpmct Oct 11, 2022
196d29e
fix typo
bpmct Oct 11, 2022
1a45660
rename access to use
bpmct Oct 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: Add initial docs to groups and rbac
  • Loading branch information
@BrunoQuaresma @bpmct
BrunoQuaresma authored and bpmct committed Oct 11, 2022
commit 79a2f8586a7b639f4cae52a70d53ea4551efba7f
7 changes: 7 additions & 0 deletions docs/admin/groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# User Groups

Groups are helpful to define a set of common permissions for a group of users. It can be used with [RBAC](../rbac.md) to have a better access control.

## 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).
17 changes: 17 additions & 0 deletions docs/admin/rbac.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Role Based Access Control (RBAC)

RBAC helps admins to control what their users and [groups](./groups.md) can access.

> **Note**:
> 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.

## Permissions

You can set the following permissions:

- **Admin**. Can edit and remove the resource including the permissions.
- **View**. Can only read and access the resource.

## 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).
2 changes: 1 addition & 1 deletion site/src/pages/GroupsPage/GroupsPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export const GroupsPageView: React.FC<GroupsPageViewProps> = ({
</Link>
<Link
underline="none"
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
href="https://coder.com/docs/coder-oss/latest/admin/groups"
target="_blank"
rel="noreferrer"
>
Expand Down
2 changes: 1 addition & 1 deletion site/src/pages/TemplatePage/TemplatePermissionsPage/TemplatePermissionsPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export const TemplatePermissionsPage: FC<
</Link>
<Link
underline="none"
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
href="https://coder.com/docs/coder-oss/latest/admin/rbac"
target="_blank"
rel="noreferrer"
>
Expand Down