Add CALM Architecture artifacts for TraderX#333
Open
jimthompson5802 wants to merge 16 commits into
Open
Conversation
…s for overview and flow diagrams
…VSCode extension details
…hitecture feedback
✅ Deploy Preview for lucky-concha-f3599f canceled.
|
Author
|
@DovOps ready for review. |
Collaborator
|
Thanks. Take a look at this comment so you can understand a bit more about the context of the discussion on Friday during the meeting. I will look and review this after hours. Thanks again for your contribution. |
DovOps
added
the
V1-Do-Not-Merge
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
2 participants
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.
Add CALM Architecture Documentation for TraderX
Close #331
Overview
This PR introduces a comprehensive CALM (Common Architecture Language Model) architecture definition for the TraderX trading system, providing a machine-readable, validated architecture model alongside auto-generated documentation.
What is CALM?
CALM is a FINOS sibling project that provides a JSON-based declarative language for describing system architectures. It enables machine-readable architecture definitions, automated validation, compliance tracking, and integration with governance tools.
Changes
New Files Added
architecture-overview.md.hbsflows-overview.md.hbsArchitecture Coverage
The CALM model includes:
Implementation notes
Original intent was to create CALM architecture that is equivalent to the information found in
docs/c4/workspace.dsl(CALM nodes and relationships) anddocs/flows.md(CALM flows). After creating the CALM nodes, relationships and flows,calm validationidentified the flowReference Data Service Bootstrapreferenced a CSV file that was not defined as a CALM node.I confirmed the inconsistency between
workspace.dsl(missing reference to csv file) andflows.mdand there is codereference-data/src/data-loader/load-csv-data.tsto load a CSV file for S&P 500 related information. As a result I added aCSV filenode to the CALM architecture.Other than this one difference the CALM architecture should match the existing
workspace.dslandflows.mdcontent.