diff --git a/.env-devel b/.env-devel index 5bc2e21c741..f2e27bf1c32 100644 --- a/.env-devel +++ b/.env-devel @@ -47,6 +47,7 @@ DIRECTOR_V2_DEV_FEATURES_ENABLED=0 DYNAMIC_SIDECAR_IMAGE=${DOCKER_REGISTRY:-itisfoundation}/dynamic-sidecar:${DOCKER_IMAGE_TAG:-latest} DYNAMIC_SIDECAR_LOG_LEVEL=DEBUG DYNAMIC_SIDECAR_PROMETHEUS_SERVICE_LABELS={} +DYNAMIC_SIDECAR_PROMETHEUS_MONITORING_NETWORKS=[] FUNCTION_SERVICES_AUTHORS='{"UN": {"name": "Unknown", "email": "unknown@osparc.io", "affiliation": "unknown"}}' diff --git a/docs/env-vars.md b/docs/env-vars.md new file mode 100644 index 00000000000..7a389701565 --- /dev/null +++ b/docs/env-vars.md @@ -0,0 +1,10 @@ +# Environment variables management + +As a developer you will need to extend the current env vars for a service. + +The following rules must be followed: + +1. for each service that requires it, add it to the `services/docker-compose.yml` file (such as `MY_VAR=${MY_VAR}`) +2. add a meaningful default value for development inside `.env-devel` so that developers can work, and that `osparc-simcore` is **self contained**. + - **NOTE** if the variable has a default inside the code, put the same value here +3. inside the repo where devops keep all the secrets follow the instructions to add the new env var diff --git a/services/docker-compose.yml b/services/docker-compose.yml index 34fc67d1b02..0d37c5d002d 100644 --- a/services/docker-compose.yml +++ b/services/docker-compose.yml @@ -198,6 +198,7 @@ services: - SIMCORE_SERVICES_NETWORK_NAME=interactive_services_subnet - TRACING_THRIFT_COMPACT_ENDPOINT=${TRACING_THRIFT_COMPACT_ENDPOINT} - DYNAMIC_SIDECAR_PROMETHEUS_SERVICE_LABELS=${DYNAMIC_SIDECAR_PROMETHEUS_SERVICE_LABELS} + - DYNAMIC_SIDECAR_PROMETHEUS_MONITORING_NETWORKS=${DYNAMIC_SIDECAR_PROMETHEUS_MONITORING_NETWORKS} env_file: - ../.env volumes: