Skip to content

update documentation for permissions (RBAC and Repository) #138

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
BolajiOlajide merged 2 commits into from
Mar 12, 2024
Merged

update documentation for permissions (RBAC and Repository) #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ccc52c
update documentation
BolajiOlajide Mar 11, 2024
e37a624
update bazel command for generating constants
BolajiOlajide Mar 11, 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
2 changes: 0 additions & 2 deletions docs/admin/access_control/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ You can read about the specific permission types available for each RBAC-enabled
- [Batch Changes](/admin/access_control/batch_changes)
- [Ownership](/admin/access_control/ownership)

> NOTE: While Batch Changes is the only RBAC-enabled product area today, we will be working on migrating other product areas in future releases of Sourcegraph. Please reach out to our [support team](mailto:support@sourcegraph.com) if you have further questions.

### Deleting a role

> NOTE: Built-in system roles cannot be deleted.
Expand Down
4 changes: 2 additions & 2 deletions docs/dev/how-to/add_permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Permissions
# RBAC Permissions

This doc is for engineers who want to add permissions for features they want to protect using the Access Control System. The permission referred to in this context differs from repository permissions; the latter concerns permissions from code hosts relating to repositories.

Expand All @@ -22,7 +22,7 @@ To add permissions for a new feature, follow these steps:

1. Add the namespace and action to [`schema.yaml`](https://sourcegraph.sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/rbac/schema.yaml). Namespace string must be unique.

2. Generate the access control constants with the command `sg gen`. This will generate access control constants for [Typescript](https://sourcegraph.sourcegraph.com/github.com/sourcegraph/sourcegraph@8b4e1cb/-/blob/client/web/src/rbac/constants.ts) and [Go](https://sourcegraph.sourcegraph.com/github.com/sourcegraph/sourcegraph@8b4e1cb4374d1449c918f695c21d2c933c5a1d15/-/blob/internal/rbac/constants.go).
2. Generate the access control constants with the command `bazel run //dev:write_all_generated`. This will generate access control constants for [Typescript](https://sourcegraph.sourcegraph.com/github.com/sourcegraph/sourcegraph@8b4e1cb/-/blob/client/web/src/rbac/constants.ts) and [Go](https://sourcegraph.sourcegraph.com/github.com/sourcegraph/sourcegraph@8b4e1cb4374d1449c918f695c21d2c933c5a1d15/-/blob/internal/rbac/constants.go).
- Additionally modify [schema.graphql](https://sourcegraph.sourcegraph.com/github.com/sourcegraph/sourcegraph@2badaeb3ccb0d9bf660234e8b5eddb4cba6598bb/-/blob/cmd/frontend/graphqlbackend/schema.graphql?L9729) by adding a new namespace enum

3. Once these constants have been generated, you can protect any resource using the access control system.
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/how-to/debug_permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Debugging Permissions
# Debugging Repository Permissions

This document provides a list of options to try when debugging permissions issues.

Expand Down
7 changes: 5 additions & 2 deletions docs/dev/how-to/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,11 @@

## Access Control

- [Adding permissions](/dev/how-to/add_permissions)
- [Debugging permissions](/dev/how-to/debug_permissions)
- [Adding RBAC permissions](/dev/how-to/add_permissions)

## Repository Permissions

- [Debugging Repository permissions](/dev/how-to/debug_permissions)

## Wolfi

Expand Down