Skip to content

Latest commit

 

History

History
170 lines (117 loc) · 4.67 KB

README.md

File metadata and controls

170 lines (117 loc) · 4.67 KB
Raw

flake8

wis2-gdc

wis2-gdc is a Reference Implementation of a WIS2 Global Discovery Catalogue.

WIS2 GDC C4 component diagram

Workflow

  • connects to a WIS2 Global Broker, subscribed to the following topic:
    • cache/a/wis2/+/metadata/#
  • on discovery metadata notifications, run the WCMP2 ETS and KPIs via pywcmp
  • publish ETS and KPI reports to local broker under monitor/a/wis2/$WIS2_GDC_CENTRE_ID/centre-id
  • publish to a WIS2 GDC (OGC API - Records) using one of the supported transaction backends:
  • collect real-time and offline GDC metrics and make them available as OpenMetrics
  • provide analytics and visualization via Prometheus and Grafana
  • produce a metadata zipfile archive for download (daily)

Installation

Requirements

Dependencies

Dependencies are listed in requirements.txt. Dependencies are automatically installed during pywis-pubsub installation.

Installing wis2-gdc

# setup virtualenv
python3 -m venv --system-site-packages wis2-gdc
cd wis2-gdc
source bin/activate

# clone codebase and install
git clone https://github.com/wmo-im/wis2-gdc.git
cd wis2-gdc-management
python3 setup.py install

Running

# setup environment and configuration
cp wis2-gdc.env local.env
vim local.env # update accordingly

source local.env

# setup pywis-pubsub - sync WIS2 notification schema
pywis-pubsub schema sync

# setup backend
wis2-gdc setup

# setup backend (force reinitialization of backend)
wis2-gdc setup --force

# teardown backend
wis2-gdc teardown

# connect to Global Broker
# discovery metadata notifications will automatically trigger wis2-gdc to validate and publish
# WCMP2 to the GDC identified in wis2-gdc.env (WIS2_GDC_GB)
pywis-pubsub subscribe --config pywis-pubsub.yml

# loading metadata manually (single file)
wis2-gdc register /path/to/wcmp2-file.json

# loading metadata manually (directory of .json files)
wis2-gdc register /path/to/dir/of/wcmp2-files

# loading metadata manually (from URL)
wis2-gdc register https://example.org/wcmp2-file.json

# deleting metadata by identifier
wis2-gdc unregister "urn:wmo:md:ca-eccc-msc:id123"

# loading metadata from a known harvest endpoint

# load from wis2box known deployments (https://demo.wis2box.wis.wmo.int)
wis2-gdc sync wis2box

# create an archive of metadata records to a zipfile
wis2-gdc archive foo.zip

Docker

The Docker setup uses Docker and Docker Compose to manage the following services:

  • wis2-gdc-api: API powered by pygeoapi
  • wis2-gdc-monitoring: monitoring
    • metrics-collector: metrics collector
    • prometheus: metrics scraper
    • grafana: analytics and visualization
  • wis2-gdc-broker: MQTT broker
  • wis2-gdc-management: management service to ingest, validate and publish discovery metadata published from a WIS2 Global Broker instance
    • the default Global Broker connection is to NOAA. This can be modified in wis2-gdc.env to point to a different Global Broker
  • wis2-gdc-backend: API search engine backend (default Elasticsearch)

See wis2-gdc.env for default environment variable settings.

To adjust service ports, edit docker-compose.override.yml accordingly.

The Makefile in the root directory provides options to manage the Docker Compose setup.

# build all images
make build

# build all images (no cache)
make force-build

# start all containers
make up

# reinitialize backend
make reinit-backend

# start all containers in dev mode
make dev

# view all container logs in realtime
make logs

# login to the wis2-gdc-management container
make login

# restart all containers
make restart

# shutdown all containers
make down

# remove all volumes
make rm

Development

Running Tests

# install dev requirements
pip3 install -r requirements-dev.txt

# run tests like this:
python3 tests/run_tests.py

# or this:
python3 setup.py test

Code Conventions

Bugs and Issues

All bugs, enhancements and issues are managed on GitHub.

Contact