Skip to content
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

docs: add runner role to rbac docs #46916

Merged
merged 2 commits into from
Oct 15, 2024
Merged

docs: add runner role to rbac docs #46916

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
890352c
add runner role to docs
teallarson Oct 15, 2024
089ba77
fix workspace runner role column
teallarson Oct 15, 2024
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
25 changes: 13 additions & 12 deletions docs/access-management/rbac.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,29 @@ products: oss-enterprise, cloud-teams
Role Based Access Control allows a user with Administrative access to apply roles to users, granting different levels of permission within an Organization or Workspace.

:::info
**Self-Managed Enterprise** instances have an `Instance Admin` role in addition to the other roles outlined in this document. The first user who logs on to Airbyte in a Self-Managed Enterprise instance will be assigned this role. This user will have all permissions listed below for all workspaces and all organizations associated with their Enterptise account. To update this assigment, enterprise customers should contact [Airbyte support](https://support.airbyte.com/hc/en-us).
**Self-Managed Enterprise** instances have an `Instance Admin` role in addition to the other roles outlined in this document. The first user who logs on to Airbyte in a Self-Managed Enterprise instance will be assigned this role. This user will have all permissions listed below for all workspaces and all organizations associated with their Enterprise account. To update this assignment, enterprise customers should contact [Airbyte support](https://support.airbyte.com/hc/en-us).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

:::

## Organization Resource Roles

Permissions are scoped to the given Organization for which the user has this role, and any Workspaces within.

| Permissions | Member | Reader | Editor | Admin |
| :---------------------- | :--------: | :--------: | :--------: |:--------: |
| **Read Organization**<br /><ul><li> Read individual organizations</li></ul> | X | X | X | X |
| **Create Workspace**<br /><ul><li>Create new workspace within a specified organization</li><li>Delete a workspace</li></ul> | | | X | X |
| **Update Organization**<br /><ul><li>Modify organization settings, including billing, PbA, SSO</li><li>Modify user roles within the organization</li></ul> | | | | X |
| Permissions | Member | Reader | Runner | Editor | Admin |
| :---------------------- | :--------: | :--------: | :--------: | :--------: |:--------: |
| **Read Organization**<br /><ul><li> Read individual organizations</li></ul> | X | X | X | X | X |
| **Create Workspace**<br /><ul><li>Create new workspace within a specified organization</li><li>Delete a workspace</li></ul> | | | | X | X |
| **Update Organization**<br /><ul><li>Modify organization settings, including billing, PbA, SSO</li><li>Modify user roles within the organization</li></ul> | | | | | X |

## Workspace Resource Roles
Permissions are scoped to the specific Workspace in which the user has this role.

| Permissions | Reader | Editor | Admin |
| ---------------------- | :--------: | :--------:| :--------: |
| **Read Workspace**<br /><ul><li>List the connections in a workspace</li><li>Read individual connections</li><li>Read workspace settings (data residency, users, connector versions, notification settings) </li></ul> | X | X | X |
| **Modify Connector Settings**<br /><ul><li>Create, modify, delete sources and destinations in a workspace</li></ul> | | X | X |
| **Update Connection**<br /><ul><li> Start/cancel syncs</li><li>Modify a connection, including name, replication settings, normalization, DBT</li><li>Delete a connection</li><li> Create/Update/Delete connector builder connectors</li></ul> | | X | X |
| **Update Workspace**<br /><ul><li> Update workspace settings (data residency, users, connector versions, notification settings)</li><li> Modify workspace connector versions</li></ul> | | | X |
| Permissions | Reader | Runner | Editor | Admin |
| ---------------------- | :--------: | :--------:| :--------:| :--------: |
| **Read Workspace**<br /><ul><li>List the connections in a workspace</li><li>Read individual connections</li><li>Read workspace settings (data residency, users, connector versions, notification settings) </li></ul> | X | X | X | X |
| **Modify Connector Settings**<br /><ul><li>Create, modify, delete sources and destinations in a workspace</li></ul> | | | X | X |
| **Sync Connection**<br /><ul><li>Start/cancel syncs and refreshes</li></ul> | | | X | X |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image should include runner here i think

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally. Fixed in 089ba77 and re-ordered the rows so we have a cleaner shape.

| **Update Connection**<br /><ul><li>Modify a connection, including name, replication settings, normalization, DBT</li><li>Clear connection data</li><li>Create/Delete a connection</li><li> Create/Update/Delete connector builder connectors</li></ul> | | | X | X |
| **Update Workspace**<br /><ul><li> Update workspace settings (data residency, users, connector versions, notification settings)</li><li> Modify workspace connector versions</li></ul> | | | | X |

## Setting Roles

Expand Down
Loading