Upgrade to institution values¶
Issue #3244 removes each EPFL default from the code. The institution values now come from the deployment. This page lists the variables that you must add, rename or delete for this version, in a developer checkout and in a cluster. The design is in the plan of #3244.
CAUTION: Change the ops repository before you deploy this version. If a required value is empty, the new frontend container stops at startup. If
FRONTEND_URLis empty, the new backend stops.
Backend variables¶
No backend variable has a new name. Two variables lose their default.
| Variable | Before | Now |
|---|---|---|
DB_URL |
default: a local SQLite file | required by each command that builds the settings |
FRONTEND_URL |
default: http://localhost:9000 |
required by the app at boot, an http or https URL |
Alembic and the scripts do not need FRONTEND_URL.
If your backend/.env is older than this version, make sure that it
sets the two variables. Compare it with backend/.env.example.
The GET /v1/unit/{unit_id}/results endpoint is removed. It returned a
fixed EPFL answer and the app did not call it.
Frontend variables¶
Nine variables are new and required. If one of them is empty, the container stops.
APP_INSTITUTION_NAME=
APP_INSTITUTION_NAME_FR_DE=
APP_INSTITUTION_NAME_FR_A=
APP_INSTITUTIONAL_ID_LABEL=
APP_CONTACT_EMAIL=
APP_USER_DOC_URL= # must end with /
APP_BACKOFFICE_DOC_URL= # must end with /
APP_STRATEGY_URL_EN=
APP_STRATEGY_URL_FR=
Two variables lose their chart default and are now required:
APP_PLANNER_MIN_YEAR and APP_PLANNER_MAX_YEAR. Each must be a year,
and the first must not be after the last. APP_ENVIRONMENT and
APP_DEMO_MODE stay in the environment. In values.env, they stop the
container.
Three variables have a new name or are deleted.
| Before | Now |
|---|---|
APP_ACCESS_MANAGEMENT_PROVIDER_URL |
APP_ACCESS_MANAGEMENT_URL |
APP_ACCESS_MANAGEMENT_PROVIDER_ABOUT_URL |
APP_ACCESS_MANAGEMENT_ABOUT_URL |
APP_ACCESS_MANAGEMENT_PROVIDER_NAME |
deleted |
These variables are new and optional. An empty value hides the link.
APP_SOURCE_CODE_URL,APP_USER_DOC_SOURCE_URL,APP_BACKOFFICE_DOC_SOURCE_URL,APP_DEVELOPER_DOC_URLAPP_OPS_ARGOCD_URL,APP_OPS_GRAFANA_DASHBOARD_URL,APP_OPS_GRAFANA_GRAPHS_URL,APP_OPS_LOGS_URL,APP_OPS_OPENSHIFT_URL
Three variables lose their EPFL default.
| Variable | Now |
|---|---|
APP_MATOMO_URL |
required with APP_MATOMO_SITE_ID |
APP_PRODUCTION_URL |
required with APP_DEMO_MODE=true |
APP_EQUIPMENT_POWER_FEEDBACK_EMAIL |
an empty value hides the request tab |
Each APP_* value is public, because the frontend sends it to each
browser. A variable whose name contains SECRET, PASSWORD, TOKEN,
CREDENTIAL or PRIVATE stops the container.
Update a developer checkout¶
A new clone needs only make install. Without INSTITUTION_DIR, the dev
server, the tests and Docker Compose use the neutral example
frontend/institution-example/. An earlier build of this change used
an institutions/ folder and two paths in frontend/.env.local.
- Pull the branch.
- Run
make installat the repository root. - If
frontend/.env.localholdsINSTITUTION_ENV_FILEorINSTITUTION_ASSETS_DIR, delete those lines. - If an
institutions/folder is left at the repository root, delete it. - Delete each
APP_ACCESS_MANAGEMENT_PROVIDER_*line fromfrontend/.env.local. - Start the frontend dev server again.
To see a real institution locally, set one line in
frontend/.env.local. The path is relative to frontend/.
INSTITUTION_DIR=../path/to/the-institution-folder
Node reads frontend/.env.local now. If a value contains #, put the
value in quotes.
If you seed the reduction objectives, rename the local input file in
backend/INPUT_DATA/ from reduction_obj_epfl_footprint(in).csv to
reduction_obj_institution_footprint(in).csv.
Docker Compose does not read backend/.env. It reads
backend/.env.example and gives the backend a fixed DB_URL for its own
postgres service.
Update a cluster¶
- Add the nine required variables and the two planner years under
frontend.env, or invalues.envof the institution folder. - Rename the two access management variables and delete the third.
- Set
APP_MATOMO_URLandAPP_PRODUCTION_URLwhere you use them. - Make a ConfigMap from the institution folder. The folder must contain
theme.conf. - Set
frontend.institutionAssets.volumeto that ConfigMap. Without it, the Helm chart does not render. - Set
FRONTEND_URLandDB_URLfor the backend.
The old frontend image ignores a variable that it does not know. Thus
you can add the new variables before you deploy the new image.
Set up a new institution gives the content of
each value and of the institution folder. A variable of the environment
wins over values.env.
Make sure that the upgrade is correct¶
Start the frontend and read its log. This line shows a correct start:
[entrypoint] wrote injectEnv.js, institution/ and theme.css in /tmp
If a value is wrong, the log names it, for example
[entrypoint] APP_CONTACT_EMAIL is required and empty. Correct the
value and start the container again.