Architecture diagram

[tommi-lew]

Context

• We want to provide users a visual overview of the Recce setup.
• This can also be used as a reference for developers onboarding to this project.

Acceptance criteria

• The diagram should include the Recce server and Recce database
• This diagram should include target and source databases(s)
• This diagram should include the API interfaces
• This diagram should present the ability for users to use the API via Rapid Doc UI
• This diagram should include brief descriptions of how Recce reconciliation run works using the diagram as a guide (eg. Queries made in against target and source databases will be written into Recee's database, etc)
• The diagram should indicate that different databases can be used.
• Considering multiple diagrams to include different possible setups. 1) A simple setup where all Recce server, Recce database, target database, source database are in the same network. 2) Another setup where Recee, target and/or source databases are sitting

Side notes

• Explore possibility of using code to generate diagram so it can be committed as part of the Recce repo, and not need to be maintained in a separate tool (eg. Google Draw). This is a Could Have and should not block this card's completion if too much effort is required.
• Recommended https://mermaid-js.github.io/mermaid/#/ by @jiawen-tw

[tommi-lew]

• Can go more in-depth what Recee does .