-
Notifications
You must be signed in to change notification settings - Fork 3
docs: update & reorganize about users & sso & scim #1021
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.
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
Open
adela-bytebase
wants to merge
12
commits into
main
Choose a base branch
from
a-branch-110
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+142
−76
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3ea20cb
update sso docs
adela-bytebase 72e5841
update
adela-bytebase 5376300
reorder
adela-bytebase f3e02a9
update
adela-bytebase 6a3664e
Update docs/administration/workload-identity/gitlab-ci.mdx
adela-bytebase 4f2159f
update service account add
adela-bytebase f507465
Update docs/administration/workload-identity/gitlab-ci.mdx
adela-bytebase f54e1b7
Update docs/administration/workload-identity/github-actions.mdx
adela-bytebase e85c437
update changelog links
adela-bytebase 88a0e99
update
adela-bytebase 26c5aa8
update
adela-bytebase b51c30c
update
adela-bytebase File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| title: Service Account | ||
| --- | ||
|
|
||
| Service accounts are machine identities designed for automated processes and applications. Unlike human [users](/administration/user-groups/overview), service accounts authenticate via API keys and are intended for programmatic access. | ||
|
|
||
| ## Workspace vs Project Level | ||
|
|
||
| Service accounts can be created at two levels: | ||
|
|
||
| - **Workspace level** — Has access governed by workspace IAM policies. Suitable for cross-project automation. | ||
| - **Project level** — Scoped to a single project, following the principle of least privilege. Suitable for isolated automation within one project. | ||
|
|
||
| ## Create a Service Account | ||
|
|
||
| 1. For workspace-level: go to **IAM & Admin** > **Service Accounts** tab and click **Add Service Account**. | ||
| 2. For project-level: go to **Project** > **Manage** > **Service Accounts** and click **Add Service Account**. | ||
|
|
||
| <Note> | ||
|
|
||
| Service accounts cannot be part of [user groups](/administration/user-groups/overview). Since service accounts are for automated processes with specific access needs, including them in groups could grant unintended permissions. This is considered an [anti-pattern](https://cloud.google.com/iam/docs/best-practices-service-accounts#groups). | ||
|
|
||
| </Note> | ||
|
|
||
| ## Service Account vs Workload Identity | ||
|
|
||
| | | Service Account | [Workload Identity](/administration/workload-identity/overview) | | ||
| |---|---|---| | ||
| | **Credential** | Long-lived API key | Short-lived OIDC token | | ||
| | **Best for** | Scripts, Terraform, general API access | CI/CD pipelines (GitHub Actions, GitLab CI) | | ||
| | **Security** | Key must be stored as a secret | No secrets to manage | | ||
|
|
||
| If your automation runs in a CI/CD platform that supports OIDC, prefer [Workload Identity](/administration/workload-identity/overview) for better security. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| title: Overview | ||
| --- | ||
|
|
||
| Workload Identity is a secure authentication method for CI/CD pipelines and external services using OpenID Connect (OIDC) tokens, eliminating the need for long-lived credentials. | ||
|
|
||
| Unlike [Service Accounts](/administration/service-account) that require storing API keys as secrets, Workload Identity: | ||
|
|
||
| - Uses short-lived tokens generated per job | ||
| - Validates tokens against your CI/CD platform's identity provider | ||
| - Restricts access to specific repositories, branches, and workflows | ||
|
|
||
| ## Workspace vs Project Level | ||
|
|
||
| Workload identities can be created at two levels: | ||
|
|
||
| - **Workspace level** — Has access governed by workspace IAM policies. Suitable for cross-project CI/CD workflows. | ||
| - **Project level** — Scoped to a single project, following the principle of least privilege. Suitable for project-specific pipelines. | ||
|
|
||
| ## Supported Platforms | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="GitHub Actions" icon="github" href="/administration/workload-identity/github-actions"> | ||
| Configure OIDC authentication for GitHub Actions workflows | ||
| </Card> | ||
| <Card title="GitLab CI/CD" icon="gitlab" href="/administration/workload-identity/gitlab-ci"> | ||
| Configure OIDC authentication for GitLab CI/CD pipelines | ||
| </Card> | ||
| </CardGroup> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.