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.

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

Added initial documentation about example setup #190

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions docs/05-iam/SCS-example-setup-configuration-description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Example setup configuration in SCS deployment explained

The following document explains the idea behind the example configuration is done.
The playbook creates a proxy realm used to connect with `Keystone`, a customer realm, the clients needed to connect the realms, the identity brokering for the customer realm, a login flow
to be able to use the `home-IdP-discovery` plugin to redirect to the correct customer realm and an example user.
SCS operators can find the playbook that creates the setup [here](https://github.com/osism/ansible-playbooks/blob/main/playbooks/infrastructure/keycloak-oidc-client-config.yml).

1. In the first place a proxy realm called `osism` on the example deployment. That realm will
become the realm that will be conected to `Keystone`

2. A customer realm called `CustomerA` is created. On that realm a `OIDC` client is created to hook
up the realm to the proxy realm. This is done via `Identity Brokering` in the proxy realm.

3. An `Identity provider` is configured in the `osism` realm, this is configured to be connected to
the `CustomerA` realm. For that, a set of mappers are created, the default ones are a `hardcoded-attribute`
that sets the domain where the user came from, and an `attribute-importer` mapper for the `openstack-default-project` that comes
in the `OIDC` claim from the customer realm.

4. A new login flow has been created in the `osism` realm, this login flow is needed to use the `home-IdP-discovery` plugin.

5. Creation of an example user called `Alice`.
2 changes: 1 addition & 1 deletion sidebarsDocs.js
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ const sidebarsDocs = {
link: {
type: 'generated-index'
},
items: ['iam/domain-manager-setup-and-usage']
items: ['iam/domain-manager-setup-and-usage', 'iam/SCS-example-setup-configuration-description']
},
'iam/intra-SCS-federation-setup-description-for-osism-doc-operations'
]
Expand Down
Loading