Configuration

Main configuration environment variables

wis2-gdc configuration is driven by the following environment variables, which are managed in wis2-gdc.env:

Main environment variables
Name	Description	Default
`WIS2_GDC_LOGGING_LEVEL`	logging level as per the standard Python logging levels	`ERROR`
`WIS2_GDC_API_URL`	public URL of the GDC API	`http://localhost`
`WIS2_GDC_API_URL_DOCKER`	internal Docker URL of the API	`http://wis2-gdc-api`
`WIS2_GDC_BACKEND_TYPE`	API backend type	`Elasticsearch`
`WIS2_GDC_BACKEND_CONNECTION`	API backend connection	`http://wis2-gdc-backend:9200/wis2-discovery-metadata`
`WIS2_GDC_BROKER_URL`	URL of the GDC broker	`mqtt://wis2-gdc:wis2-gdc@wis2-gdc-broker:1883`
`WIS2_GDC_CENTRE_ID`	centre identifier of the GDC	`ca-eccc-msc-global-discovery-catalogue`
`WIS2_GDC_COLLECTOR_URL`	URL of metrics collector	`http://wis2-gdc-metrics-collector:8006`
`WIS2_GDC_GB`	WIS2 Global Broker that the GDC connects to	`mqtts://everyone:everyone@globalbroker.meteo.fr:8883`
`WIS2_GDC_GB_TOPIC`	WIS2 topic that the GDC subscribes to	`cache/a/wis2/+/metadata`
`WIS2_GDC_PUBLISH_REPORTS`	whether the GDC should publish ETS and KPI reports	`true`
`WIS2_GDC_REJECT_ON_FAILING_ETS`	whether the GDC should stop ingest based on on failing record	`true`
`WIS2_GDC_RUN_KPI`	whether the GDC should run KPI as part of ingest	`false`
`WIS2_GDC_EXPERIMENTAL`	whether the GDC should in experimental mode	`false`
`WIS2_GDC_CACHE_URL`	URL of the GDC cache	`redis://wis2-gdc-cache:6379`
`WIS2_GDC_CACHE_RETENTION_SECONDS`	cache retention policy for notification messages in seconds	`3600`

API configuration environment variables

If you wish to update the API configuration, you can set the below values accordingly (to override the pygeoapi defaults):

pygeoapi configuration environment variables
Name	Description
`WIS2_GDC_SERVER_ICON`	Icon for HTML templates
`WIS2_GDC_SERVER_LOGO`	Logo/banner for HTML templates
`WIS2_GDC_METADATA_IDENTIFICATION_TITLE`	Title
`WIS2_GDC_METADATA_IDENTIFICATION_DESCRIPTION`	Description
`WIS2_GDC_METADATA_IDENTIFICATION_TERMS_OF_SERVICE`	Terms of service
`WIS2_GDC_METADATA_IDENTIFICATION_URL`	URL related to API
`WIS2_GDC_METADATA_LICENSE_NAME`	License name
`WIS2_GDC_METADATA_LICENSE_URL`	License URL
`WIS2_GDC_METADATA_PROVIDER_NAME`	Provider name
`WIS2_GDC_METADATA_PROVIDER_URL`	Provider URL
`WIS2_GDC_METADATA_CONTACT_NAME`	Contact name
`WIS2_GDC_METADATA_CONTACT_POSITION`	Contact position
`WIS2_GDC_METADATA_CONTACT_ADDRESS`	Contact address
`WIS2_GDC_METADATA_CONTACT_CITY`	Contact city
`WIS2_GDC_METADATA_CONTACT_STATEORPROVINCE`	Contact state or province
`WIS2_GDC_METADATA_CONTACT_POSTALCODE`	Contact postal code
`WIS2_GDC_METADATA_CONTACT_COUNTRY`	Contact country
`WIS2_GDC_METADATA_CONTACT_PHONE`	Contact phone number (in format `+xx-xxx-xxx-xxxx`)
`WIS2_GDC_METADATA_CONTACT_FAX`	Contact fax number (in format `+xx-xxx-xxx-xxxx`)
`WIS2_GDC_METADATA_CONTACT_EMAIL`	Contact email
`WIS2_GDC_METADATA_CONTACT_URL`	Contact URL
`WIS2_GDC_METADATA_CONTACT_HOURS`	Contact hours of service
`WIS2_GDC_METADATA_CONTACT_INSTRUCTIONS`	Contact instructions
`WIS2_GDC_METADATA_CONTACT_ROLE`	Contact role

Global Broker environment variables

WIS2 Global Broker environment variables are defined as comma-separated values (centre=id,url,centre-name). wis2-gdc allows for 1..n Global Broker environment variables as required.

Note

the naming convention is WIS_GDC_GB_LINK_<LABEL>, where <LABEL> can be named as desired to identify the GB
at least one Global Broker environment variable is required
the centre name may contain commas

An example can be found below:

WIS2_GDC_GB_LINK_METEOFRANCE,"fr-meteo-france-global-broker,mqtts://everyone:everyone@globalbroker.meteo.fr:8883,Météo-France, Global Broker Service"

Key settings

A default installation with minimal configuration changes per below satisfies most use casess:

WIS2_GDC_API_URL
WIS2_GDC_CENTRE_ID
WIS2_GDC_GB
WIS2_GDC_GB_LINK...

Note

The wis2-gdc Docker Compose file also contains additional environment variables (see docker-compose.yml to adjust accordingly). In most cases, these values do not need adjustment.

Note

The WIS2_GDC_METADATA_ARCHIVE_ZIPFILE environment variable is always set by wis2-gdc to /data/wis2-discovery-metadata-archive.zip for the wis2-gdc-management and wis2-gdc-api containers.

Application specific configurations

Application specific configurations can be found in the following files (for direct editing if needed):

Application specific configuration files
Filepath	Description
`wis2-gdc-api/docker/wis2-gdc-config.yml`	pygeoapi configuration (documentation)
`wis2-gdc-broker/docker/mosquitto.conf`	mosquitto main configuration
`wis2-gdc-broker/docker/acl.conf`	mosquitto access control list
`wis2-gdc-management/docker/pywis-pubsub.yml`	pywis-pubsub configuration
`wis2-gdc-monitoring/grafana/datasource.yml`	Grafana configuration
`wis2-gdc-monitoring/grafana/datasource.yml`	Grafana configuration
`wis2-gdc-monitoring/prometheus/datasource.yml`	Prometheus configuration

Note

Application specific configurations do not need adjustment in most cases.

Connections to additional Global Brokers

By default, wis2-gdc interacts with a single Global Broker via the wis2-gdc-management service.

To connect to additional Global Brokers, any number of additional wis2-gdc-management services may be added. For example, adding in docker-compose.yml:

wis2-gdc-management2:  # update name accordingly
  container_name: wis2-gdc-management2  # update name accordingly
  build:
    context: ./wis2-gdc-management/
  env_file:
    - wis2-gdc.env
  environment:
    - WIS2_GDC_API_URL_DOCKER=http://wis2-gdc-api:8080
    - WIS2_GDC_GB=mqtts://everyone:everyone@globalbroker.inmet.br:8883  # override default WIS2_GDC_GB
  depends_on:
    wis2-gdc-backend:
      condition: service_healthy
    wis2-gdc-cache:
      condition: service_healthy
  healthcheck:
    test: ["CMD", "curl", "-f", "http://wis2-gdc-backend:9200/wis2-discovery-metadata"]
    interval: 1m
    retries: 3
  volumes:
    - wis2-gdc-management-data2:/data  # update volume accordingly
  restart: always
  command: ["/venv/bin/pywis-pubsub", "subscribe", "--config", "/app/docker/pywis-pubsub.yml", "--verbosity", "DEBUG"]
  networks:
    - wis2-gdc-net
  <<: *logging

…then adding the associated volume:

volumes:
  wis2-gdc-backend-data:
  wis2-gdc-management-data:
  wis2-gdc-management2-data:  # added volume