Configuration

The following environment variables are used to configure the application. They are set via a Kubernetes ConfigMap with values coming from the Helm values.yaml. See Deployment to Kubernetes

Generally, if an variable default can be set in the application it will be. There are then also some defaults in the Helm values. For more dynamic values that depend on the release name or namespace, the environment variables have a sensible default in the ConfigMap but also can be overwritten via the values.yaml

Note

There are some environment variables defined in the OET Helm chart that are not used directly by the OET application so are not listed here. As the OET executes scripts in child process that will be using the ska-oso-scripting library, environment variables expected by the library need to be defined in the OET process They are documented in the RTD for ska-oso-scripting

Environment variables used by ska-oso-oet

Environment variable	Description	Required/optional in the application	Corresponding Helm value	Required/optional in the Helm chart
SUBARRAY_ID	The index of the subarray that the observing script	Required	ska-oso-oet.rest.skuid.url	Set via an index in the Helm template, based on the global.subarray_count
SKUID_URL	The Kubernetes service address of a running SKUID service	Required	ska-oso-oet.rest.skuid.url	Optional - will fall back on: ska-ser-skuid-{{ .Release.Name }}-svc.{{ .Release.Namespace }}.svc.{{ .Values.global.cluster_domain }}:9870
PGHOST	The address of the PostgreSQL instance that the postgres ODA will connect to.	Required	global.oda.postgres.host	Optional - will fall back on: {{.Values.postgres.cluster}}.{{.Values.postgres.clusterNamespace}}.svc.{{ .Values.global.cluster_domain }}
PGUSER	The admin user of the PostgreSQL instance that the postgres ODA will connect to.	Optional - default: oda_admin	global.oda.postgres.user	Optional - no default in chart
PGPASSWORD	The admin password of the PostgreSQL instance that the postgres ODA will connect to.	Required	Pulled from Vault - see Deployment to Kubernetes
PGPORT	The port of the PostgreSQL instance that the postgres ODA will connect to.	Optional - default: 5432	global.oda.postgres.port	Optional - default: 5432
PGDATABASE	The name of the database within a PostgreSQL instance that the postgres ODA will connect to.	Optional - default: oda	global.oda.postgres.database	Optional - no default in chart (overwritten in the Makefile)
OET_HISTORY_SIZE	The maximum number of history entries retained for activities and procedures. Helps controls memory usage for long-running OET sessions.	Optional - default: 10	ska-oso-oet.rest.history_size	Optional - default: 10
OET_REQUEST_TIMEOUT	The number of seconds allowed for an OET request to return success/failure before the API times out.	Optional - default: 30	ska-oso-oet.rest.request_timeout	Optional - default: 30
OET_WAIT_FOR_QA_READY	Initial state for the global QA wait flag. When true, scripts will wait for QA to be ready before proceeding unless overridden at runtime.	Optional - default: false	ska-oso-oet.rest.wait_for_qa_ready	Optional - default: false