Update cluster creation diagram to reflect current codebase#4691
Open
Update cluster creation diagram to reflect current codebase#4691
Conversation
The existing diagram was from 2020 and missing major changes: - Two credential models (Service Principal and Managed Identity/MSI) - Two install paths (Hive and Podman) - OIDC creation and federated identity credentials - Preconfigured NSG, gateway, MTU sizing - MISE/mutual TLS authentication - ARO operator deployment and stabilization - Full Phase 2 (RemoveBootstrap) step sequence Add Mermaid version (cluster-creation.md) for native GitHub rendering. Update FreeMind version (cluster-creation.mm) and regenerate PNG.
swiencki
requested review from
alcasim,
bennerv,
cadenmarchese,
hawkowl,
hlipsig,
jharrington22,
kimorris27,
mociarain,
mrWinston,
rogbas,
sankur-codes,
tiguelu,
tsatam,
tuxerrante,
ventifus,
wanghaoran1988 and
yjst2012
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the cluster creation documentation diagrams to reflect the current RP/cluster install architecture, and adds a GitHub-native Mermaid rendering alongside the existing FreeMind/Freeplane source.
Changes:
- Refresh
docs/cluster-creation.mmwith current flows (SP vs MSI, Hive vs Podman, OIDC/workload identity, expanded Phase 1/2 steps). - Add
docs/cluster-creation.mdcontaining Mermaid flowcharts for GitHub rendering.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/cluster-creation.mm | Updates the detailed mindmap diagram to match current cluster creation/install phases and components. |
| docs/cluster-creation.md | Adds a Mermaid-based version of the diagram that renders directly in GitHub. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
docs/cluster-creation.mm) which was last updated in 2020 and missing major architectural changesdocs/cluster-creation.md) that renders natively on GitHub without additional toolingdocs/cluster-creation.pngfrom the updated FreeMind/Freeplane source.mmformat could be deprecated in favor of the Mermaid.mdversion, since it requires FreeMind/Freeplane to view and editKey additions to the diagram:
Test plan
docs/cluster-creation.mmin FreeMind or Freeplane and verify structuredocs/cluster-creation.mdMermaid diagrams render correctly on the GitHub PR Files tabpkg/cluster/install.go:bootstrap()