-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #366 from raft-tech/raft-tdp-main
Multi-Issue PR
- Loading branch information
Showing
50 changed files
with
48,023 additions
and
14,454 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Sprint 38 Summary | ||
** 1/5/2021 - 1/18/2021 ** | ||
|
||
## Sprint 38 Goals | ||
|
||
* Documentation (reorganizing directories) | ||
* Resubmission research synthesis | ||
* ACF AMS | ||
|
||
## Closed/Merged/Completed (Done/Demo, Closed) | ||
- [#1136](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1136) - [Backend] Accept AMS OpenId | ||
- [#1520](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1520) - As technical lead, I need ACF AMS integrated for direct DAC access | ||
- [#1525](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1525) - Update TANF-app/doc/Sprint-Review/ | ||
- [#1524](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1524) - Update TANF-app/doc/Security-Compliance/ | ||
- [#573](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/573) - As a dev, I want a README for the /scripts folder that describes what each script is for and how it is used in the CI process. | ||
- [#1082](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1082) - Update ADRs | ||
- [#1483](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1483) - Update Current TDRS documentation | ||
- [#1482](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1482) - Update workflow.md | ||
- [#1346](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1346) - [SPIKE] Test hero images in code & adjust spec accordingly | ||
- [#1418](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1418) - [Research] Code docs synthesis of Resubmission Research | ||
- [#1522](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1522) - Update TANF-app/doc/Product-Strategy/ | ||
- [#1521](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1521) - Update TANF-app/doc/Background/ | ||
- [#1523](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1523) - Update TANF-app/doc/How-We-Work/ | ||
|
||
## Submitted (QASP Review, OCIO Review) | ||
- n/a | ||
|
||
## Moving to Next Sprint (Raft Review, In Progress, Current Sprint Backlog) | ||
- n/a | ||
|
||
**Blocked** | ||
- n/a | ||
|
||
**Raft Review** | ||
- [#1170](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1170) - [Backend] As ACF staff, I must use ACF AMS for authentication. | ||
- [#782](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/782) - As a dev, I want to be on the latest stable version of Python | ||
- [#1353](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1353) - Create ADR to document decision to move forward with Elasticsearch | ||
- [#1419](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1419) - Sidenav traps focus on close button | ||
- [#1449](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1449) - As OFA tech lead, I need the dependabot PR a11y review process documented and config file updated | ||
- [#1413](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1413) - Django Admin - Tooltip improvements for wider compatibility | ||
- [#854](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/854) - As technical lead, I want to switch from Yarn to NPM | ||
|
||
**In Progress** | ||
|
||
- [#1417](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1417) - As a TDP user, I want to easily navigate to specific pages of the TDP website | ||
- [#1477](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1477) - Update readmes - **EPIC** | ||
- [1527](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1527) - Update TANF-app/doc/User-Experience/ | ||
- [#1461](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1461) - Live Comms (Jan 2022) | ||
- [#1545](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1545) - Migrate Design's Live Comms Site into the TANF-app repo. | ||
- [#470](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/470) - As a developer, I want a consistent set of commands to perform essential development operations | ||
|
||
|
||
**Current Sprint Backlog** | ||
- n/a | ||
|
||
|
||
|
||
## Agenda for Sprint 38 Demo | ||
- Documentation Efforts - Val and Andrew | ||
- [1520](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1520) - As technical lead, I need ACF AMS integrated for direct DAC access - **can't demo, but Andrew will address** | ||
- [1418](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1418) - Code docs synthesis of resubmission research - **Miles and Sreedevi** | ||
- [1136](https://app.zenhub.com/workspaces/tdrs-sprint-board-5f18ab06dfd91c000f7e682e/issues/raft-tech/tanf-app/1136) - [Backend] Accept AMS OpenId - **Andrew and Jorge** |
45 changes: 45 additions & 0 deletions
45
docs/Technical-Documentation/Architecture-Decision-Record/017-elastisearch.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# 17. Elasticsearch Architecture | ||
|
||
Date: 2021-01-12 (yyyy-mm-dd) | ||
|
||
## Status | ||
|
||
Accepted | ||
|
||
## Context | ||
|
||
To modernize the eventual reporting stack for TDP, we have a need for a usable data backend. To establish parity with the legacy TDRS system, we originally planned to store parsed TANF and SSP data in our PostGreSQL database; however, the data required cleaning that is burdensome to perform prior to storage so a faster, scalable solution is desired. | ||
|
||
## Decision | ||
|
||
We will use an Elastisearch and Kibana stack for their modern feature set and scalability with large data sets. The Elastisearch/Kibana cluster will be an application hosted in Cloud.gov with the rest of our TDP application so we can leverage all the work surrounding authentication, security, and data compliance. | ||
|
||
## Consequences | ||
|
||
### Benefits | ||
|
||
* Significant performance increase at large scales. | ||
* Elasticsearch retains near real-time search capabilities even with datasets measured in hundreds of Terabytes. | ||
* PostgreSQL encounters table/index bloatings with very large data sets (>=1 MM rows) which negatively affect performance without advanced DBA operations. | ||
* Built in Reporting and Analytics capabilities - with UI capabilities to create Saved Searches, Visualizations and Dashboards. | ||
* Built in CSV export of Visualization data. | ||
* Access over REST API or Kibana UI, no database client needed. | ||
* This has the added security benefit of ensuring there is not direct database access and users must be passed through our standard authentication which for OFA users will include PIV/CAC card. | ||
* Auto-generated index mappings, which can be tweaked to gain further performance advantages. These are also much more flexible than traditional schemas used by relational databases. | ||
* Capabilities to perform ML and AI analytics on data sets. | ||
* Cloud.gov includes the ES service with FISMA moderate pricing. | ||
* Automated Index Lifecycle Management policies can be configured to move data into cold storage, etc to satisfy retention requirements. | ||
|
||
### Risks | ||
* New query language and interface to learn for OFA staff members who will have access | ||
- This is mostly mitigated through a SQL Workbench provided in Kibana where you can use regular SQL syntax to query records. | ||
* More infrastructure to manage. | ||
* This is mostly mitigated due to using a Cloud.gov managed service for ES and Terraform, this greatly simplifies scaling the cluster and abstracts away a lot of the difficult cluster management tasks we would have to do if we didn't use a managed service. | ||
* Additional overhead to run a proxy application to control access to ES + Kibana | ||
|
||
## Notes | ||
|
||
These changes are slated for later in our releases: currently release 3 but might not be fully implemented until v4. | ||
|
||
Please also see these notes: https://gist.github.com/jtwillis92/a6840a412676fc2d3f58c0dccbf10da1 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 0 additions & 26 deletions
26
...xperience/2020, Winter - User Flow Validation/ST Workshop Facilitation Guide.md
This file was deleted.
Oops, something went wrong.
File renamed without changes.
Binary file removed
BIN
-1020 KB
...er-Experience/Design/design-assets/research-artifacts/TANF Theory of Change.png
Binary file not shown.
Binary file removed
BIN
-128 KB
...ce/Design/design-assets/research-artifacts/TDRS product plan at four levels.png
Binary file not shown.
Binary file removed
BIN
-326 KB
...ser-Experience/Design/design-assets/research-artifacts/TDRS-stakeholder-map.png
Binary file not shown.
Binary file removed
BIN
-355 KB
docs/User-Experience/Design/design-assets/research-artifacts/acf_org_chart.png
Binary file not shown.
Binary file removed
BIN
-145 KB
...perience/Design/design-assets/research-artifacts/considerations to the plan.png
Binary file not shown.
Binary file removed
BIN
-245 KB
...rience/Design/design-assets/research-artifacts/three product considerations.png
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Designs for Dev | ||
|
||
_forthcoming_ |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.