Contributing New Configs Settings / Env Variables to Diffgram Backend Services
Considerations when adding new settings to Diffgram's Backend Services
Diffgram is deployed and packaged in multiple ways and can be customized to a great extent. If you find youself wanting to contribute a new system configuration variable, you'll need to take into account that the new setting needs to be added in the following place for correct deployment of the new release
- On the
settings.py
in theshared
folder of our backend services. - On our
docker-compose.yaml
andinstall.py
to set globally accepted defaults for the new config. - On our github actions workflows: https://github.com/diffgram/diffgram/blob/master/.github/workflows/kubernetes_diffgram_enterprise_deploy.yaml
- On the repo secrets (Please ping a core contributor if a repo secret needs to be set)
- As a default value injected on our helm chart. In
values.yaml
: https://github.com/diffgram/diffgram-helm/blob/main/values.yaml and ondiffgram_settings.tpl
and/ordiffgram_secrets.tpl
located on this folder: https://github.com/diffgram/diffgram-helm/tree/main/templates
Updated about 2 years ago