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.

Sign up for GitHub

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

Jump to bottom

[Task]: Update Architecture Diagram #1276

Closed
1 task
acouch opened this issue Feb 20, 2024 · 10 comments · Fixed by #1499
Closed
1 task

[Task]: Update Architecture Diagram #1276

acouch opened this issue Feb 20, 2024 · 10 comments · Fixed by #1499
Assignees
@coilysiren
Labels
project: grants.gov Grants.gov Modernization tickets

Comments

@acouch
Copy link
Collaborator

acouch commented Feb 20, 2024

Summary

The current architecture diagram is out of date (does not include database replication, contains a-z failover, among other issues). This task is to update it.

The original diagram was created in mermaid. The Nava template has a lucid template that we may want to use moving forward. A diagram in lucid can better represent the architecture and easier to update as things get more complicated, though we can discuss as a group.

Acceptance criteria

  • Update diagram using mermaid or lucid
@acouch acouch added project: grants.gov Grants.gov Modernization tickets refinement labels Feb 20, 2024
@coilysiren coilysiren mentioned this issue Mar 6, 2024
Open
@acouch acouch added this to the API - Logging and monitoring milestone Mar 6, 2024
@acouch acouch mentioned this issue Mar 6, 2024
Closed
1 task
@coilysiren
Copy link
Collaborator

I definitely want to do this in LucidChart. Mermaid becomes unwieldy and frankly kind of ugly when used for an AWS infrastructure diagram

@coilysiren
Copy link
Collaborator

platform has an architecture diagram that can be used as a baseline: https://github.com/navapbc/template-infra/blob/main/docs/system-architecture.md

@coilysiren coilysiren self-assigned this Mar 12, 2024
@coilysiren
Copy link
Collaborator

Working on this now

@coilysiren
Copy link
Collaborator

https://lucid.app/lucidchart/8d0fb4b2-fe85-4460-8df9-1255a506c5b6/edit?viewport_loc=-177%2C-500%2C3107%2C2505%2C0_0&invitationId=inv_a5fd77d9-d546-4b02-925a-6c3e254ccce7

@coilysiren
Copy link
Collaborator

Grants gov system architecture - v1 0 0 (current) (2)

@coilysiren
Copy link
Collaborator

Grants gov system architecture - v1 0 0 (current) (3)

@coilysiren
Copy link
Collaborator

Grants gov system architecture - v1 0 0 (current) (4)

@coilysiren coilysiren mentioned this issue Mar 18, 2024
Merged
@sumiat sumiat removed the refinement label Mar 19, 2024
@coilysiren
Copy link
Collaborator

Grants gov system architecture - v1 0 0 (current) (5)

@coilysiren
Copy link
Collaborator

coilysiren commented Mar 19, 2024 •
edited
Loading

With New Relic:

Grants gov system architecture - v1 0 0 (current) (6)

Without New Relic:

Grants gov system architecture - v1 0 0 (current) (7)

@coilysiren
Copy link
Collaborator

FYI - these images are best viewed via downloading them first. That way you can zoom in, etc etc

@sumiat sumiat closed this as completed Mar 19, 2024
coilysiren added a commit that referenced this issue Mar 20, 2024
@coilysiren
Updated architecture diagram (#1499)
33dd3ee 
## Summary

Fixes #1276

### Time to review: __5 mins__

## Changes proposed

- removes the mermaid AWS architecture diagrams
- adds a lucidchart AWS architecture diagram

## Additional information

This architecture diagram is meant to be viewed as an abstraction of the
important high level components of our architecture. As such, there's
some fine details that are intentionally missing from it. For example,
the "VPC Endpoints" section intentionally doesn't list every single AWS
service we are accessing through VPC endpoints.

Given that, I'm interested in feedback on whether or not the
architecture diagram is missing some high level components. For example,
in early versions of this diagram I forgot the foreign data wrapper +
step functions setup. Large components like that are important to have
called out in the diagram, so please let me know if any are missing!

~Also note that this diagram pre-emptively includes New Relic.~
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@coilysiren coilysiren

Labels
project: grants.gov Grants.gov Modernization tickets
Projects
Simpler.Grants.gov Product Backlog
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updated architecture diagram HHS/simpler-grants-gov
3 participants
@acouch @coilysiren @sumiat