Skip to content

Commit

Permalink
Add architecture diagram and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akuny committed Feb 13, 2024
1 parent a7f4cb0 commit 91e20a8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions documentation/architecture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# NAD Collaboration Hub Architecture

### Entry Points

Users can work with the NAD Collaboration Hub by way of:

- **Flask Web Server**: Primary interface for web-based interactions for Data
Producers and NAD Administrator.
- **CLI**: Command line interface allowing NAD Administrator to perform
administrative tasks.

### Application Core

Logic concerning business rules, data validation and profiling, and other
application concerns. The core is unaware of how its entry points and its
infrastructure dependencies are implemented.

### Infrastructure Dependencies

The current remote development environment uses [services provided by cloud.gov](https://cloud.gov/docs/services/intro/).

- **Object Storage**: Storage for datasets submitted by users, via
[S3](https://cloud.gov/docs/services/s3/).
- **Relational Database**: Persistence for application data and data validation
reports, via [RDS PostgreSQL database](https://cloud.gov/docs/services/relational-database/).
- **Task Queue Broker**: Manages queue of data validation tasks for Celery, via
[AWS Elasticache Redis](https://cloud.gov/docs/services/aws-elasticache/).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 91e20a8

Please sign in to comment.