-
Notifications
You must be signed in to change notification settings - Fork 5
docs: refactor enterprise authentication docs #985
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
Merged
Merged
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
d7dd454
docs: refactor enterprise installation docs
gavinelder 06cc186
docs: refactor enterprise installation docs
gavinelder 2b0ede1
docs: refactor enterprise installation docs
gavinelder 2430435
Merge branch 'master' into ge/enterprise-docs-personal
justinegeffen f6bbdcb
Merge branch 'master' into ge/enterprise-docs-personal
justinegeffen 8dbc4aa
Apply suggestion from @justinegeffen
justinegeffen 4e6694e
Apply suggestion from @justinegeffen
justinegeffen cbd9f1b
Apply suggestion from @justinegeffen
justinegeffen 7dae663
Merge branch 'master' into ge/enterprise-docs-personal
justinegeffen 387b4a2
Refactor devops-persona.md for clarity and consistency
justinegeffen 43b66dc
Ported changes to 25.3
justinegeffen b0169d3
porting to 25.2 and 25.1
justinegeffen 46bc4db
Update platform-enterprise_docs/enterprise-sidebar.json
justinegeffen 6ff8a2a
Update platform-enterprise_docs/enterprise/configuration/mirroring.md
justinegeffen 5c6d6b4
Update platform-enterprise_docs/enterprise/configuration/wave.md
justinegeffen ea9046f
Update platform-enterprise_docs/enterprise/kubernetes.md
justinegeffen 41e11c6
Fix YAML document missing separator (#1058)
bebosudo e8be000
chore: Improve pre-commit formatter (#1059)
bebosudo 5304cb5
Changelog: Wave v1.32.2 (#1061)
github-actions[bot] 5853310
Update Studio features and compute environment fixes (#1063)
justinegeffen 45447cb
Update v25.x sidebars
bebosudo 28e3ef3
Update v25.x mirroring docs
bebosudo 14619cc
Update v25.x wave docs
bebosudo 1efcd77
Update v25.x docker compose docs with redis instructions
bebosudo 6846c91
Grammar
bebosudo b3f6050
Merge branch 'master' into ge/enterprise-docs-personal
bebosudo bb02aa8
Fix v25.x json sidebars
bebosudo d1a1c8a
docs: refactor authentication
gavinelder 97a158a
docs: refactor authentication
gavinelder 5c2e54f
Apply suggestions from code review
gavinelder a3e8df6
Merge branch 'master' into ge/feat-authentication
bebosudo 06e30c5
Revert changes to v25.1 and .2 due to botched merge
bebosudo a739c87
Backport auth entries to v25.3, v25.2 and v25.1
bebosudo 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
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
193 changes: 0 additions & 193 deletions
193
platform-enterprise_docs/enterprise/configuration/authentication.md
This file was deleted.
Oops, something went wrong.
65 changes: 65 additions & 0 deletions
65
platform-enterprise_docs/enterprise/configuration/authentication/entra.md
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,65 @@ | ||
| --- | ||
| title: "Entra ID" | ||
| description: Configure Microsoft Entra ID as an identity provider for Seqera Platform | ||
| date: "2026-01-27" | ||
| tags: [authentication, entra, azure, oidc] | ||
| --- | ||
|
|
||
| Configure [Microsoft Entra ID](https://learn.microsoft.com/en-us/entra/identity-platform/v2-protocols-oidc) as a single sign-on (SSO) provider for Seqera Platform using OpenID Connect. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, you need: | ||
|
|
||
| - An Azure account with Entra ID access | ||
| - Permission to create app registrations | ||
|
|
||
| Ensure you know how to register applications in Entra ID. See Microsoft's documentation on [registering an application](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) for more information. | ||
|
|
||
| ## Register an Entra ID application | ||
|
|
||
| 1. In the [Azure portal](https://portal.azure.com/), go to **Entra ID > App Registrations**. | ||
| 2. Select **New Registration** and specify a name and supported account types. | ||
| 3. Set the redirect URI to `https://<HOST>/oauth/callback/oidc` (must be HTTPS) - replace `<HOST>` with your enterprise installation hostname. | ||
| 4. Note the **Application (client) ID** from the app overview. | ||
| 5. Go to **Certificates & secrets** and create a new client secret. Note the secret value. | ||
| 6. Go to **Endpoints** and note the OpenID Connect metadata document URI (up to `v2.0`). | ||
|
|
||
| ## Configure Seqera | ||
|
|
||
| Add the following environment variables to your Seqera configuration: | ||
|
|
||
| | Variable | Description | | ||
| | :------- | :---------- | | ||
| | `TOWER_OIDC_CLIENT` | The application (client) ID from step 4 | | ||
| | `TOWER_OIDC_SECRET` | The client secret from step 5 | | ||
| | `TOWER_OIDC_ISSUER` | The issuer URL from step 6, e.g., `https://login.microsoftonline.com/<tenant-id>/v2.0` | | ||
|
|
||
| Add `auth-oidc` to the `MICRONAUT_ENVIRONMENTS` environment variable for both the `cron` and `backend` services. | ||
|
|
||
| ### User consent settings | ||
|
|
||
| Configure user consent settings to **Allow user consent for apps** to ensure admin approval is not required for each login. See [User consent settings](https://learn.microsoft.com/en-us/azure/active-directory/manage-apps/configure-user-consent?pivots=portal#configure-user-consent-settings). | ||
|
|
||
| ### Compatibility note | ||
|
|
||
| Users on Seqera Platform version 25.2.3 and below may need to set the following environment variable to resolve an authentication method incompatibility: | ||
|
|
||
| ```env | ||
| MICRONAUT_SECURITY_OAUTH2_CLIENTS_OIDC_OPENID_TOKEN_AUTH_METHOD=client_secret_post | ||
| ``` | ||
|
|
||
| ## Restrict access | ||
|
|
||
| To restrict access to specific email addresses or domains, configure an allow list in `tower.yml`: | ||
|
|
||
| ```yaml | ||
| tower: | ||
| auth: | ||
| oidc: | ||
| allow-list: | ||
| - "*@your-company.example.com" | ||
| - "specific-user@another-company.example.net" | ||
| ``` | ||
|
|
||
| See [User access allow list](./overview#user-access-allow-list) for more information. | ||
49 changes: 49 additions & 0 deletions
49
platform-enterprise_docs/enterprise/configuration/authentication/github.md
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,49 @@ | ||
| --- | ||
| title: "GitHub" | ||
| description: Configure GitHub as an identity provider for Seqera Platform | ||
| date: "2026-01-27" | ||
| tags: [authentication, github, oauth] | ||
| --- | ||
|
|
||
| Configure GitHub as a single sign-on (SSO) provider for Seqera Platform. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, you need: | ||
|
|
||
| - A GitHub organization | ||
| - Permission to create OAuth Apps in your organization | ||
|
|
||
| Ensure you know how to create a GitHub OAuth app. See GitHub's documentation on [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) for more information. | ||
|
|
||
| ## Create a GitHub OAuth App | ||
|
|
||
| 1. In **Profile > Settings > Developer settings**, select **OAuth Apps**. | ||
| 2. Select **New OAuth App**. | ||
| 3. Complete the required fields. In the **Authorization callback URL** field, enter `https://<HOST>/oauth/callback/github` (must be HTTPS) - replace `<HOST>` with your enterprise installation hostname. | ||
| 4. Note your **Client ID**. | ||
| 5. Generate a client secret, then note your **Client secret**. | ||
|
|
||
| ## Configure Seqera | ||
|
|
||
| Add the following environment variables to your Seqera configuration: | ||
|
|
||
| | Variable | Description | | ||
| | :------- | :---------- | | ||
| | `TOWER_GITHUB_CLIENT` | The client ID from step 4 | | ||
| | `TOWER_GITHUB_SECRET` | The client secret from step 5 | | ||
|
|
||
| ## Restrict access | ||
|
|
||
| To restrict access to specific email addresses or domains, configure an allow list in `tower.yml`: | ||
|
|
||
| ```yaml | ||
| tower: | ||
| auth: | ||
| github: | ||
| allow-list: | ||
| - "*@your-company.example.com" | ||
| - "specific-user@another-company.example.net" | ||
| ``` | ||
|
|
||
| See [User access allow list](./overview#user-access-allow-list) for more information. |
50 changes: 50 additions & 0 deletions
50
platform-enterprise_docs/enterprise/configuration/authentication/google.md
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,50 @@ | ||
| --- | ||
| title: "Google" | ||
| description: Configure Google as an identity provider for Seqera Platform | ||
| date: "2026-01-27" | ||
| tags: [authentication, google, oauth] | ||
| --- | ||
|
|
||
| Configure Google as a single sign-on (SSO) provider for Seqera Platform. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, you need: | ||
|
|
||
| - A Google Cloud account | ||
| - Permission to create OAuth credentials in the Google Cloud console | ||
|
|
||
| Ensure you know how to create Google OAuth credentials. See Google's documentation on [setting up OAuth 2.0](https://support.google.com/cloud/answer/6158849) for more information. | ||
|
|
||
| ## Create Google OAuth credentials | ||
|
|
||
| 1. In the [Google Cloud console](https://console.developers.google.com), create a new project or select an existing one. | ||
| 2. Go to **APIs & Services > Credentials**. | ||
| 3. Select **Create credentials > OAuth client ID**. | ||
| 4. Select **Web Application** as the application type. | ||
| 5. Add your redirect URI: `https://<HOST>/oauth/callback/google` (must be HTTPS) - replace `<HOST>` with your enterprise installation hostname. | ||
| 6. Note your **Client ID** and **Client secret**. | ||
|
|
||
| ## Configure Seqera | ||
|
|
||
| Add the following environment variables to your Seqera configuration: | ||
|
|
||
| | Variable | Description | | ||
| | :------- | :---------- | | ||
| | `TOWER_GOOGLE_CLIENT` | The client ID from step 6 | | ||
| | `TOWER_GOOGLE_SECRET` | The client secret from step 6 | | ||
|
|
||
| ## Restrict access | ||
|
|
||
| To restrict access to specific email addresses or domains, configure an allow list in `tower.yml`: | ||
|
|
||
| ```yaml | ||
| tower: | ||
| auth: | ||
| google: | ||
| allow-list: | ||
| - "*@your-company.example.com" | ||
| - "specific-user@another-company.example.net" | ||
| ``` | ||
|
|
||
| See [User access allow list](./overview#user-access-allow-list) for more information. |
Oops, something went wrong.
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.