Add architecture diagrams - #17
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds high-level and component-detail architecture diagrams (Mermaid + draw.io) documenting the vault-iam-auth flow in Terraform Enterprise, including AWS IMDS credential retrieval, Vault AWS auth verification via STS, and Vault AWS secrets engine issuance of temporary credentials.
Changes:
- Added a high-level Mermaid flowchart describing the end-to-end 11-step authentication/credential flow.
- Added a high-level draw.io diagram equivalent for editable diagram maintenance.
- Added component-level Mermaid + draw.io diagrams mapping internal scripts/libraries and Vault/AWS API interactions.
Reviewed changes
Copilot reviewed 4 out of 8 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/diagrams/architecture-high-level.mmd | Mermaid source for the high-level 11-step system flow. |
| docs/diagrams/architecture-high-level.drawio | Editable draw.io version of the high-level diagram (needs flow correction for step 6). |
| docs/diagrams/architecture-component.mmd | Mermaid source for component/script-level interactions (needs login payload field alignment). |
| docs/diagrams/architecture-component.drawio | Editable draw.io version of the component diagram (needs edge/label corrections and payload field alignment). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add high-level and component-detail diagrams documenting the AWS IAM authentication flow through Terraform Enterprise, Vault, and AWS STS. Includes Mermaid sources, rendered PNGs, and editable draw.io XML files.
- Use correct repo path aws/vault-iam-auth.sh in all diagrams - Add iam_http_request_method to Vault auth login payload fields - Fix IMDS response edge to target aws-credentials.sh (not aws4-sign.sh) - Remove incorrect "executes" label on tf_ext -> tf_vault edge - Fix step 6 in high-level draw.io to return token to external data source before it passes to Vault provider in step 7
mengesb
force-pushed
the
docs/architecture-diagrams
branch
from
July 2, 2026 15:44
4f9591a to
3d1b013
Compare
github-actions
Bot
added
the
documentation
- Correct the authentication flow: the external data source outputs a signed login payload, NOT a Vault token. The Vault provider is the component that calls /auth/aws/login and receives the token. - Fix parse-url.sh label to functions/parse-url.sh (actual repo path) - Update Vault provider label from "token from external" to "login via signed payload" - Renumber high-level diagram steps to reflect correct flow
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
Files
docs/diagrams/architecture-high-level.mmddocs/diagrams/architecture-high-level.drawiodocs/diagrams/architecture-high-level.pngdocs/diagrams/architecture-high-level-drawio.pngdocs/diagrams/architecture-component.mmddocs/diagrams/architecture-component.drawiodocs/diagrams/architecture-component.pngdocs/diagrams/architecture-component-drawio.pngTest plan
.drawiofiles in draw.io to confirm editability