publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-22 01:31:25 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #34 from DOI-DO/nmb/backend-rollout-plans

Browse source 
More specific backend rollout plans
This commit is contained in:
Neil MartinsenBurrell 2024-12-12 09:19:25 -06:00 • committed by GitHub
commit 7c02c40ee6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.github/workflows/deploy_backend_main.yml vendored
View file

@ -1,9 +1,5 @@
name: Deploy Backend Main name: Deploy Backend Main
on: on: workflow_dispatch
push:
branches: [main]
paths:
- "data/**"
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref }} group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true cancel-in-progress: true

23
docs/operations/rollout-plan.md
View file

@ -27,11 +27,23 @@ of the CEJST data in that bucket without affecting the data being served by
the existing website the existing website
TODO: Validate the hypotheses that TODO: Validate the hypotheses that
- the frontend website pulls its backend data from versioned paths - [X] the frontend website pulls its backend data from versioned paths
- the data pipeline that builds the backend data can be configured - [X] the data pipeline that builds the backend data can be configured
so that it will not overwrite any of the existing data in the same so that it will not overwrite any of the existing data in the same
bucket bucket
The deploy-backend-main.yml Github workflow builds the scoring and deploys
it to the S3 data bucket. We want to have control of when that workflow runs
so that there are no inadvertent changes to the scoring in the bucket. When
we want to run the build and deploy workflow for the scoring, we can do
so by clicking the button in the Github web UI.
The rollout sequence will be (1) freezing the code in `data/` with the final
v2 changes, then (2) analyzing the resulting changes from v1 to v2 in order to
fully bless the v2 results. Once the analysis and approval is complete we can
(3) run the backend build and deploy workflow to install the final version of
the CEJST scores on the S3 data bucket.
## Frontend app rollout ## Frontend app rollout
Rather than trying to incrementally change the frontend app that is deployed Rather than trying to incrementally change the frontend app that is deployed
@ -43,8 +55,11 @@ display of the updated data using a staging URL like
<random-string-of-letters>.cloudfront.net. <random-string-of-letters>.cloudfront.net.
TODO: Get new AWS resources TODO: Get new AWS resources
- A new website S3 bucket - [X] A new website S3 bucket
- A new Cloudfront distribution that serves that S3 bucket - [X] A new Cloudfront distribution that serves that S3 bucket
After the v2 backend is frozen, approved, and deployed, we will move on
to testing the frontend with that data at the staging URL.
## Release day ## Release day