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

Environment variables used by ska-oso-services

Environment variable

Description

Required/optional in the application

Corresponding Helm value

Required/optional in the Helm chart

SKUID_URL

The Kubernetes service address of a running SKUID service

Required

ska-oso-services.rest.skuid.url

Optional - will fall back on: ska-ser-skuid-{{ .Release.Name }}-svc.{{ .Release.Namespace }}.svc.{{ .Values.global.cluster_domain }}:9870

ODA_BACKEND_TYPE

Defines whether the ODA interfaces should connect to a Postgresql instance or use the filesystem.

Optional - default: postgres

ska-oso-services.rest.oda.backendType

Required - default set to postgres

POSTGRES_HOST

The address of the PostgreSQL instance that the postgres ODA will connect to.

Required if ODA_BACKEND_TYPE is postgres

ska-oso-services.rest.oda.postgres.host

Optional - will fall back on: {{ .Release.Name }}-postgresql.{{ .Release.Namespace }}.svc.{{ .Values.global.cluster_domain }}

ADMIN_POSTGRES_USER

The admin user of the PostgreSQL instance that the postgres ODA will connect to.

Optional - default: postgres

ska-oso-services.rest.oda.postgres.user

Optional - no default in chart

ADMIN_POSTGRES_PASSWORD

The admin password of the PostgreSQL instance that the postgres ODA will connect to.

Required if ODA_BACKEND_TYPE is postgres

Pulled from Vault - see Secret Management

POSTGRES_PORT

The port of the PostgreSQL instance that the postgres ODA will connect to.

Optional - default: 5432

ska-oso-services.rest.oda.postgres.port

Optional - no default in chart

POSTGRES_DB_NAME

The name of the database within a PostgreSQL instance that the postgres ODA will connect to.

Optional - default: postgres

ska-oso-services.rest.oda.postgres.db.name

Optional - no default in chart

AWS_SERVER_PUBLIC_KEY

The aws server public key used to connect to the AWS account. Used by PHT to work with S3.

Required

Pulled from Vault - see Secret Management

AWS_SERVER_SECRET_KEY

The aws server secret key used to connect to the AWS account. Used by PHT to work with S3.

Required

Pulled from Vault - see Secret Management

AWS_PHT_BUCKET_NAME

The aws S3 buket name used by PHT.

Required

Pulled from Vault - see Secret Management

SMTP_PASSWORD

The SMTP password to connect to SKAO server. Used by PHT to send emails.

Required

Pulled from Vault - see Secret Management