search

finos / traderX

https://demo.traderx.finos.org/
Apache License 2.0
51 stars 47 forks source link

Architecture as Code for TraderX #127

Open maoo opened 7 months ago

maoo commented 7 months ago

The (FINOS) Architecture as Code Working group have built a C4 model for TraderX , and it would be great to host some docs on this repository, possibly embedding some diagrams.

I'll defer to @rocketstack-matt to decompose this, or link it to other existing issues.

rocketstack-matt commented 7 months ago

Linking the TraderX sample built using CALM https://github.com/finos-labs/architecture-as-code/tree/main/calm/samples/traderx

Please note that the current sample is built from the C4 model, which is in fact out of date with current TraderX as of the date of this comment. This highlights a key issue with C4 (and CALM in it's current form) namely that it is separate from the actual application and can therefore get out of sync.

Tag: @dc-ms / @jpgough-ms / @yt-ms / @matthewgardner - this is a good example of a problem we want CALM to solve, namely that the changes in architecture should be driven from the manifest changing (or be identified and potentially blocked via drift detection).

maoo commented 7 months ago

Thanks @rocketstack-matt , your links are very helpful.

As a simple step forward, I'd suggest to add https://github.com/finos/traderX/blob/main/docs/c4/c4-diagram.png into the TraderX README, as it would help readers understanding the FW's architecture, and navigate to the Architecture as Code initiative. WDYT?

The issue related with changes is quite interesting too, and I suppose it should live into https://github.com/finos-labs/architecture-as-code/issues ; until then, I think it would be a good idea to version the C4 architecture definitions and always specify the creation date; this way we can measure the amount of changes via git history. WDYT?