Skip to content

Commit

Permalink
feat: document rbac
Browse files Browse the repository at this point in the history
Signed-off-by: Mark Phelps <[email protected]>
  • Loading branch information
markphelps committed Jun 25, 2024
1 parent 463e432 commit 50154d3
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 6 deletions.
46 changes: 46 additions & 0 deletions cloud/features/rbac.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Role Based Access Control
description: Learn about the role-based access control options available with Flipt Hybrid Cloud
mode: "wide"
---

Role-based access control allows you to define custom roles and permissions for your team members.

![Roles](/images/cloud/features/roles.png)

You can create roles with specific permissions, such as read-only access to feature flags or the ability to create new flags. This gives you fine-grained control over who can do what in Flipt Hybrid Cloud and your Flipt instances.

## Built-in Roles

Flipt Hybrid Cloud comes with several built-in roles that you can assign to your team members:

- **Admin**: Full access to all resources and settings
- **Editor**: Can create and update most resources, but cannot delete them. Cannot access organization settings.
- **Viewer**: Read-only access to most resources, cannot create or update them. Cannot access organization settings.

![Built-In Roles](/images/cloud/features/roles-built-in.png)

Built-in roles cannot be modified or deleted, but you can create custom roles with specific permissions to meet your organization's needs.

## Custom Roles

You can create custom roles with any permissions you need. For example, you can create a role that allows users to create and update feature flags and segments, but not delete them.

![Custom Roles](/images/cloud/features/roles-custom.png)

## Assigning Roles

You can assign roles to team members after you invite them to your organization from the [user management](/cloud/features/user-management) page.

<Note>
By default, all team members are assigned the `Viewer` role when they are
invited to your organization.
</Note>

![Assign Roles](/images/cloud/features/roles-assign.png)

## Role Scope

Roles are global across your organization, so a team member's role applies to all environments and instances in your organization.

When your team members route to a Flipt instance through Flipt Hybrid Cloud, their permissions are enforced based on the role assigned to them in the organization.
6 changes: 1 addition & 5 deletions cloud/features/user-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,10 @@ Flipt Hybrid Cloud makes it easy to manage your team members and their permissio

![User Management](/images/cloud/features/team.png)

With features like [role-based access control\*](#role-based-access-control), you can ensure that team members have the right level of access to the features they need, while keeping sensitive data secure.
With features like [role-based access control](/cloud/features/rbac), you can ensure that team members have the right level of access to the features they need, while keeping sensitive data secure.

![Invite Users](/images/cloud/features/invite.png)

## Just in Time User Provisioning

With our [SSO](/cloud/features/authentication##single-sign-on) and Directory Sync features, you can automatically provision users in Flipt Hybrid Cloud when they log in for the first time. This makes it easy to manage access and permissions for your team members, without having to manually invite or create users.

## Role-Based Access Control

**Coming soon!** Role-based access control will allow you to define custom roles and permissions for your team members. You can create roles with specific permissions, such as read-only access to feature flags or the ability to create new flags. This gives you fine-grained control over who can do what in Flipt Hybrid Cloud and your Flipt instances.
2 changes: 1 addition & 1 deletion cloud/guides/production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,4 @@ Unlike in the [Getting Started](/cloud/guides/getting-started) guide, the addres

Now that you have successfully connected your permanent instance to Flipt Hybrid Cloud, you can start creating feature flags and managing your feature flag configurations.

You can now learn more about the advanced features and capabilities available to you such as [Single Sign-On](/cloud/features/authentication) and [Audit Logs](/cloud/features/audit-logs).
You can now learn more about the advanced features and capabilities available to you such as [Single Sign-On](/cloud/features/authentication), [Role-Based Access Control](/cloud/features/rbac), and [Audit Logs](/cloud/features/audit-logs).
Binary file modified images/cloud/features/invite.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/features/roles-assign.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/features/roles-built-in.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/features/roles-custom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/features/roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/cloud/features/team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@
"pages": [
"cloud/features/authentication",
"cloud/features/user-management",
"cloud/features/rbac",
"cloud/features/audit-logs"
]
}
Expand Down

0 comments on commit 50154d3

Please sign in to comment.