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

Updated architecture diagram #1499

Merged
merged 2 commits into from
Mar 20, 2024
Merged

Updated architecture diagram #1499

merged 2 commits into from
Mar 20, 2024

Conversation

coilysiren
Copy link
Collaborator

@coilysiren coilysiren commented Mar 18, 2024

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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 18, 2024
@coilysiren coilysiren marked this pull request as ready for review March 18, 2024 22:52
Copy link
Collaborator

@acouch acouch left a comment

Choose a reason for hiding this comment

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

Looks great! Excited to see the update.

subgraph public-subnet1 [Public Subnet]
ALB["Application Load Balancer (ALB)"]:::lb --> AZ1 & AZ2
end
![Grants gov system architecture - v1 0 0 (current) (4)](https://github.com/HHS/simpler-grants-gov/assets/5768468/a7e8adb5-5e23-4623-9bda-66e34f437079)
Copy link
Collaborator

Choose a reason for hiding this comment

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

(question): Is Route 53 involved in the DNS resolution if we aren't using it as a service?
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh, good catch!

It might be used "under the hood" by the load balancers, but we aren't using it directly. Will remove 👍

Copy link
Collaborator

Choose a reason for hiding this comment

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

@coilysiren (nit) we aren't using New Relic yet, so should note that in the diagram or description.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Adding this:

This New Relic integration is shown here
in a future facing capacity. Which is to say that,
at time of writing, we have not started
integrating with New Relic yet.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Just for correctness, I'll add a version of the diagram to this readme that doesn't have new relic.

@coilysiren coilysiren merged commit 33dd3ee into main Mar 20, 2024
1 check passed
@coilysiren coilysiren deleted the coilysiren-patch-1 branch March 20, 2024 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Update Architecture Diagram
2 participants