-
Notifications
You must be signed in to change notification settings - Fork 7.7k
docs: added identity-center.md doc for AWS SSO #15689
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
blakepettersson
merged 12 commits into
argoproj:master
from
zeusal:add-identity-center-doc
Oct 27, 2023
Merged
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b52b878
docs: added identity center doc (AWS SSO)
b17812c
Merge branch 'master' into add-identity-center-doc
zeusal 606feb8
Merge branch 'master' into add-identity-center-doc
zeusal b26ce3a
Apply suggestions from code review
zeusal 22298d5
Merge branch 'master' into add-identity-center-doc
zeusal 969a43b
Update identity-center.md
zeusal 2e8a187
Update identity-center.md
zeusal fb9e5d2
Merge branch 'master' into add-identity-center-doc
zeusal 040a973
Update docs/operator-manual/user-management/identity-center.md
zeusal bf6897c
Merge branch 'master' into add-identity-center-doc
zeusal 83b4c47
Update identity-center.md
zeusal b0b9412
Update identity-center.md
zeusal 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,79 @@ | ||
| # Identity Center (AWS SSO) | ||
|
|
||
| !!! note "Are you using this? Please contribute!" | ||
| If you're using this IdP please consider [contributing](../../developer-guide/site.md) to this document. | ||
|
|
||
| A working Single Sign-On configuration using Identity Center (AWS SSO) has been achieved using the following method: | ||
|
|
||
| * [SAML (with Dex)](#saml-with-dex) | ||
|
|
||
| ## SAML (with Dex) | ||
|
|
||
| 1. Create a new SAML application in Identity Center and download the certificate. | ||
| *  | ||
| *  | ||
| 1. Click `Assign Users` after creating the application in Identity Center, and select the users or user groups you wish to grant access to this application. | ||
| *  | ||
| 1. Copy the Argo CD URL into the `data.url` field in the `argocd-cm` ConfigMap. | ||
|
|
||
| <!-- markdownlint-disable MD046 --> | ||
| ```yaml | ||
| data: | ||
| url: https://argocd.example.com | ||
| ``` | ||
| 1. Configure Attribute mappings. | ||
| !!! note | ||
| Group attribute mapping is not officially supported in the AWS docs, however the workaround is currently working. | ||
| *  | ||
| *  | ||
|
|
||
| <!-- markdownlint-enable MD046 --> | ||
|
|
||
| 1. Download the CA certificate to use in the `argocd-cm` configuration. | ||
| * If using the `caData` field, you'll need to base64-encode the entire certificate, including the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` stanzas (e.g., `base64 my_cert.pem`). | ||
| * If using the `ca` field and storing the CA certificate separately as a secret, you will need to mount the secret onto the `dex` container in the `argocd-dex-server` Deployment. | ||
| *  | ||
| 1. Edit the `argocd-cm` and configure the `data.dex.config` section: | ||
|
|
||
| <!-- markdownlint-disable MD046 --> | ||
| ```yaml | ||
| dex.config: | | ||
| logger: | ||
| level: debug | ||
| format: json | ||
| connectors: | ||
| - type: saml | ||
| id: aws | ||
| name: "AWS IAM Identity Center" | ||
| config: | ||
| # You need value of Identity Center APP SAML (IAM Identity Center sign-in URL) | ||
| ssoURL: https://portal.sso.yourregion.amazonaws.com/saml/assertion/id | ||
| # You need `caData` _OR_ `ca`, but not both. | ||
| caData: <CA cert (IAM Identity Center Certificate of Identity Center APP SAML) passed through base64 encoding> | ||
| # Path to mount the secret to the dex container | ||
| entityIssuer: https://external.path.to.argocd.io/api/dex/callback | ||
| redirectURI: https://external.path.to.argocd.io/api/dex/callback | ||
| usernameAttr: email | ||
| emailAttr: email | ||
| groupsAttr: groups | ||
| ``` | ||
| <!-- markdownlint-enable MD046 --> | ||
|
|
||
| ### Connect Identity Center Groups to Argo CD Roles | ||
| Argo CD recognizes user memberships in Identity Center groups that match the **Group Attribute Statements** regex. | ||
|
|
||
| In the example above, the regex `argocd-*` is used, making Argo CD aware of a group named `argocd-admins`. | ||
|
|
||
| Modify the `argocd-rbac-cm` ConfigMap to connect the `ArgoCD-administrators` Identity Center group to the builtin Argo CD `admin` role. | ||
| <!-- markdownlint-disable MD046 --> | ||
| ```yaml | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: argocd-rbac-cm | ||
| data: | ||
| policy.csv: | | ||
| g, <Identity Center Group ID>, role:admin | ||
| scopes: '[groups, email]' | ||
| ``` | ||
| <!-- markdownlint-enable MD046 --> | ||
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.