Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add infrastructure and service dependencies map #1061

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Nitemaeric
Copy link
Contributor

@Nitemaeric Nitemaeric commented Sep 24, 2024

Context

Changes proposed in this pull request

Guidance to review

Link to Trello card

Screenshots

architecture-beta
  group app(cloud)[ITT Mentor Services]
  service app_server(server)[Ruby on Rails web server] in app
  service app_worker(server)[GoodJob worker] in app
  service azure_frontdoor(logos:microsoft-azure)[Azure Front Door] in app
  service db(database)[PostgreSQL] in app
  service register_server(internet)[Register trainee teachers API]
  service publish_server(internet)[Publish teacher training courses API]
  service trs_server(internet)[Teaching record system API]
  service gias_data(database)[Get information about schools CSV]
  service browser(material-symbols:computer-outline)[Browser]
  junction external
  azure_frontdoor:R -- L:app_server
  browser:R --> L:azure_frontdoor
  app_worker:L -- R:db
  app_server:R -- L:db
  app_worker:R -- L:external
  app_worker:T -- B:gias_data
  external:R -- L:register_server
  external:T -- B:publish_server
  external:B -- T:trs_server
Loading

@Nitemaeric Nitemaeric self-assigned this Sep 24, 2024
@Nitemaeric Nitemaeric force-pushed the dd/architecture-documentation branch 5 times, most recently from 98ba0a6 to 13aa71c Compare September 24, 2024 10:55
Copy link
Member

@ollietreend ollietreend left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sure about the layout of this diagram. Which is tricky, because Mermaid doesn't give us much control over that. I wonder if a more traditional PNG/SVG diagram would give us more control here.

I feel like the junction is a bit clunky – it's not clear what that represents, or if it's just there to control the diagram layout?

A couple of things which stand out:

  • Register trainee teachers API – we don't integrate with this API; it shouldn't be on the diagram
  • DfE Sign-in – it'd probably be worth including DfE Sign-in as another external service which we depend upon for user authentication

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants