search

cfpb / hmda-platform-ui

Front-end for https://github.com/cfpb/hmda-platform
Creative Commons Zero v1.0 Universal
11 stars 15 forks source link

Maintenance Image/Environment Variable #1318 #1303

Closed omnipresent07 closed 4 years ago

omnipresent07 commented 5 years ago

We would like a way to have a configurable environment on the platform-ui so that we can turn the variable on/off and based on the on/off value it would show a message.

This would be good for us to have when we perform maintenance on the platform.

wpears commented 5 years ago

Once built, the frontend is a static app that can't access environment variables. If we want to be able to show a real time status or render different content based on a flag, we should probably have a status endpoint where a backend service can read envvars/hit a database.

omnipresent07 commented 5 years ago

The backend can't provide this status message since when we do cluster maintenance backend isn't reliable to remain up. I'd like to propose having the frontend read a static (publicly available) file from S3 that contains JSON keys. Based on the values of these JSON keys (true/false), the front end would display specific messaging. This way when the team is doing maintenance, we can simply update the S3 file. Additionally, this file could also contain keys for specific messaging we want turned on/off during filing season.

meissadia commented 4 years ago

We will host a config file on Github that frontend repos will be able to read on load.

Config file will contain

meissadia commented 4 years ago

Since this file will be shared across a number of apps I'm thinking it should live in HMDA Platform

meissadia commented 4 years ago
meissadia commented 4 years ago

Config file has been merged in hmda-platform, the sub-PRs are no longer blocked.

This is ready for review

wpears commented 4 years ago

Everything is merged in here