-
Notifications
You must be signed in to change notification settings - Fork 10
000 system structure
eRegs will be deployed under the MACPRO umbrella. This means that certain aws resources and existing tools will be available to run the system. These include aws lambda, s3, api gateway, and aurora.
API Gateway: Will route browser requests to the regulations-site lambda.
AWS Lambda: Will run the regulations-site system. It will communicate with the regulations-core API Gateway for data.
Amazon cloudfront: Will serve the assets for the regulations-site web pages. (css, js)
Amazon S3: Will store the assets for the regulations-site web pages. (css, js)
API Gateway: Will route requests to the regulations-core lambda.
AWS Lambda: Will run the regulations-core system.
Amazon Aurora: Will store the parsed regulations and context information that is managed by regulations-core
The conceptually singular regulations-site website will be spread across multiple resources. So while reasoning about the user interface it can continue to be thought of as a single system, during deployment and configuration the disparate resources will have to be taken into account.
- Static assets will be built and stored in s3
- Cloudfront will be configured to server static assets
- regulations-site django application will be configured to point to the configured Cloudfront
- This requires consideration of the domains each piece is served under.
- Static assets can be easily swapped and updated without updating the python application
Django is traditionally run by something like nginx or apache web server. In the serverless case this is worked around by using the serverless framework and their logic wrapping Django's wsgi.py behavior.
The question of how to run migrations against the database remains open.
Please note that all pages on this GitHub wiki are draft working documents, not complete or polished.
Our software team puts non-sensitive technical documentation on this wiki to help us maintain a shared understanding of our work, including what we've done and why. As an open source project, this documentation is public in case anything in here is helpful to other teams, including anyone who may be interested in reusing our code for other projects.
For context, see the HHS Open Source Software plan (2016) and CMS Technical Reference Architecture section about Open Source Software, including Business Rule BR-OSS-13: "CMS-Released OSS Code Must Include Documentation Accessible to the Open Source Community".
For CMS staff and contractors: internal documentation on Enterprise Confluence (requires login).
- Federal policy structured data options
- Regulations
- Resources
- Statute
- Citation formats
- Export data
- Site homepage
- Content authoring
- Search
- Timeline
- Not built
- 2021
- Reg content sources
- Default content view
- System last updated behavior
- Paragraph indenting
- Content authoring workflow
- Browser support
- Focus in left nav submenu
- Multiple content views
- Content review workflow
- Wayfinding while reading content
- Display of rules and NPRMs in sidebar
- Empty states for supplemental content
- 2022
- 2023
- 2024
- Medicaid and CHIP regulations user experience
- Initial pilot research outline
- Comparative analysis
- Statute research
- Usability study SOP
- 2021
- 2022
- 2023-2024: 🔒 Dovetail (requires login)
- 🔒 Overview (requires login)
- Authentication and authorization
- Frontend caching
- Validation checklist
- Search
- Security tools
- Tests and linting
- Archive