-
Notifications
You must be signed in to change notification settings - Fork 9
docs: create a diagram to show how the components connect #1913
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
cardoe
wants to merge
1
commit into
main
Choose a base branch
from
arch-diagram
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.
+55
−0
Open
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Architecture Overview | ||
|
|
||
| UnderStack is split across two cluster types: a **global cluster** hosting shared | ||
| services, and one or more **site clusters** hosting the OpenStack compute plane. | ||
|
|
||
| ## Service Layout | ||
|
|
||
| ```mermaid | ||
| graph TB | ||
| IDP["External Identity Provider<br/>(e.g. Azure Entra / LDAP)"] | ||
|
|
||
| subgraph global["Global Cluster"] | ||
| Dex["Dex<br/>(OIDC Broker)"] | ||
| Nautobot["Nautobot<br/>(Network Source of Truth)"] | ||
| Keystone["Keystone<br/>(Identity Service)"] | ||
| end | ||
|
|
||
| subgraph site["Site Cluster(s)"] | ||
| Ironic["Ironic<br/>(Bare Metal)"] | ||
| Placement["Placement"] | ||
| Neutron["Neutron<br/>(Networking)"] | ||
| Glance["Glance<br/>(Images)"] | ||
| Nova["Nova<br/>(Compute)"] | ||
| Cinder["Cinder<br/>(Block Storage)"] | ||
| end | ||
|
|
||
| IDP -->|"authenticates users"| Dex | ||
| Dex -->|"OIDC"| Nautobot | ||
| Dex -->|"OIDC"| Keystone | ||
|
|
||
| Keystone -->|"auth token validation"| Ironic | ||
| Keystone -->|"auth token validation"| Placement | ||
| Keystone -->|"auth token validation"| Neutron | ||
| Keystone -->|"auth token validation"| Glance | ||
| Keystone -->|"auth token validation"| Nova | ||
| Keystone -->|"auth token validation"| Cinder | ||
| ``` | ||
|
|
||
| ## Authentication Flow | ||
|
|
||
| All user authentication is brokered through **Dex**, which acts as an OIDC | ||
| federation layer in front of your external Identity Provider (IdP). This means | ||
| you only need to configure your IdP connection once in Dex, and all services | ||
| inherit that integration. | ||
|
|
||
| - **Nautobot** uses Dex for SSO, allowing operators to log in with their | ||
| corporate credentials. | ||
| - **Keystone** is configured with Dex as its OIDC provider, so all OpenStack | ||
| API access and dashboard logins flow through Dex to the external IdP. | ||
|
|
||
| Once a user is authenticated via Keystone, the resulting token is trusted by | ||
| all site cluster OpenStack services (Ironic, Placement, Neutron, Glance, Nova, | ||
| Cinder). Those services validate tokens against Keystone but do not interact | ||
| with Dex or the external IdP directly. | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we add "Openstack" in the label here
What to make sure any add-on (third-party) services are just part of the full undercloud stack. This present that undecloud is one single thing with many underline components over undercloud is made up of several peer components