bird-house · fmigneault · Apr 18, 2024 · Apr 5, 2024 · Apr 8, 2024 · Apr 9, 2024
@@ -15,6 +15,17 @@
 [Unreleased](https://github.com/bird-house/birdhouse-deploy/tree/master) (latest)
 ------------------------------------------------------------------------------------------------------------------
 
+## Changes
+
+- Node Services: Add definitions and variables for every service represented by
+  the [DACCS-Climate/Marble-node-registry](https://github.com/DACCS-Climate/Marble-node-registry).
+
+  - Add `version` field using the corresponding `<SERVICE>_VERSION` variables.
+  - Add `types` field restricted by specific values instead of previous `keywords` expected to be extendable.
+  - Add `<SERVICE>_IMAGE_URI` variables to provide `rel: service-meta` link for every service.
+
+  See [bird-house/birdhouse-deploy#441](https://github.com/bird-house/birdhouse-deploy/issues/441) for more details.
+
 ## Fixes
 - GeoServer: fix invalid media-type specified for the service's endpoint in `service-config.json.template`
 

@@ -6,6 +6,7 @@
 
 export FINCH_VERSION=0.9.2
 export FINCH_IMAGE="birdhouse/finch:version-${FINCH_VERSION}"
+export FINCH_IMAGE_URI="registry.hub.docker.com/${FINCH_IMAGE}"
 
 # This tells the postgres service to create a database on startup
 export POSTGRES_DATABASES_TO_CREATE="

@@ -1,6 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "finch",
+  "version": "${FINCH_VERSION}",
+  "types": [
+    "wps"
+  ],
   "keywords": [
     "service-wps"
   ],
@@ -20,6 +24,11 @@
       "rel": "service-desc",
       "type": "text/xml",
       "href": "https://${PAVICS_FQDN_PUBLIC}${TWITCHER_PROTECTED_PATH}/finch?service=WPS&request=GetCapabilities"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${FINCH_IMAGE_URI}"
     }
   ]
 }
@@ -12,6 +12,7 @@ export GEOSERVER_DOCKER=pavics/geoserver
 export GEOSERVER_VERSION=2.22.2
 export GEOSERVER_TAGGED=2.22.2-kartoza-build20230226-r7-allow-change-context-root-and-fix-missing-stable-plugins-and-avoid-chown-datadir
 export GEOSERVER_IMAGE="${GEOSERVER_DOCKER}:${GEOSERVER_TAGGED}"
+export GEOSERVER_IMAGE_URI="registry.hub.docker.com/${GEOSERVER_IMAGE}"
 
 export GEOSERVER_ADMIN_USER="admin"
 

@@ -1,6 +1,13 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "geoserver",
+  "version": "${GEOSERVER_VERSION}",
+  "types": [
+    "data",
+    "wms",
+    "wfs",
+    "wps"
+  ],
   "keywords": [
     "data",
     "service-wms",
@@ -18,6 +25,11 @@
       "rel": "service-doc",
       "type": "text/html",
       "href": "https://docs.geoserver.org/"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${GEOSERVER_IMAGE_URI}"
     }
   ]
 }
@@ -1,4 +1,6 @@
 export HUMMINGBIRD_VERSION=0.5_dev
+export HUMMINGBIRD_IMAGE=pavics/hummingbird:${HUMMINGBIRD_VERSION}
+export HUMMINGBIRD_IMAGE_URI="registry.hub.docker.com/${HUMMINGBIRD_IMAGE}"
 
 # This tells the postgres service to create a database on startup
 export POSTGRES_DATABASES_TO_CREATE="

@@ -9,7 +9,7 @@ x-logging:
 
 services:
   hummingbird:
-    image: pavics/hummingbird:${HUMMINGBIRD_VERSION}
+    image: ${HUMMINGBIRD_IMAGE}
     container_name: hummingbird
     environment:
       HOSTNAME: $HOSTNAME

@@ -1,6 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "hummingbird",
+  "version": "${HUMMINGBIRD_VERSION}",
+  "types": [
+    "wps"
+  ],
   "keywords": [
     "service-wps"
   ],
@@ -20,6 +24,11 @@
       "rel": "service-desc",
       "type": "text/xml",
       "href": "https://${PAVICS_FQDN_PUBLIC}${TWITCHER_PROTECTED_PATH}/hummingbird?service=WPS&request=GetCapabilities"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${HUMMINGBIRD_IMAGE_URI}"
     }
   ]
 }
@@ -6,6 +6,8 @@
 
 export JUPYTERHUB_DOCKER=pavics/jupyterhub
 export JUPYTERHUB_VERSION=4.0.2-20240117
+export JUPYTERHUB_IMAGE="${JUPYTERHUB_DOCKER}:${JUPYTERHUB_VERSION}"
+export JUPYTERHUB_IMAGE_URI="registry.hub.docker.com/${JUPYTERHUB_IMAGE}"
 
 # Jupyter single-user server images, can be overriden in env.local to have a space separated list of multiple images
 export DOCKER_NOTEBOOK_IMAGES="pavics/workflow-tests:py39-230601-1-update240116"

@@ -9,7 +9,7 @@ x-logging:
 
 services:
   jupyterhub:
-    image: ${JUPYTERHUB_DOCKER}:${JUPYTERHUB_VERSION}
+    image: ${JUPYTERHUB_IMAGE}
     container_name: jupyterhub
     hostname: jupyterhub
     environment:

@@ -1,6 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "jupyterhub",
+  "version": "${JUPYTERHUB_VERSION}",
+  "types": [
+    "jupyterhub"
+  ],
   "keywords": [
     "jupyterhub"
   ],
@@ -15,6 +19,11 @@
       "rel": "service-doc",
       "type": "text/html",
       "href": "https://jupyter.org/hub"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${JUPYTERHUB_IMAGE_URI}"
     }
   ]
 }
@@ -8,6 +8,8 @@
 export RAVEN_GEO_URL="https://pavics.ouranos.ca/geoserver/"
 
 export RAVEN_VERSION="0.18.1"
+export RAVEN_IMAGE="pavics/raven:${RAVEN_VERSION}"
+export RAVEN_IMAGE_URI="registry.hub.docker.com/${RAVEN_IMAGE}"
 
 # This tells the postgres service to create a database on startup
 export POSTGRES_DATABASES_TO_CREATE="

@@ -9,7 +9,7 @@ x-logging:
 
 services:
   raven:
-    image: pavics/raven:${RAVEN_VERSION}
+    image: ${RAVEN_IMAGE}
     container_name: raven
     environment:
       PYWPS_CFG: /wps.cfg

@@ -1,6 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "raven",
+  "version": "${RAVEN_VERSION}",
+  "types": [
+    "wps"
+  ],
   "keywords": [
     "service-wps"
   ],
@@ -20,6 +24,11 @@
       "rel": "service-desc",
       "type": "text/xml",
       "href": "https://${PAVICS_FQDN_PUBLIC}${TWITCHER_PROTECTED_PATH}/raven?service=WPS&request=GetCapabilities"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${RAVEN_IMAGE_URI}"
     }
   ]
 }
@@ -3,6 +3,20 @@ export STAC_POSTGRES_PASSWORD=${POSTGRES_PAVICS_PASSWORD}
 export STAC_PGUSER=${POSTGRES_PAVICS_USERNAME}
 export STAC_PGPASSWORD=${POSTGRES_PAVICS_PASSWORD}
 
+# 'main' branch points at https://github.com/stac-utils/stac-fastapi/commit/d53e792
+# (see: https://github.com/crim-ca/stac-app/blob/40cad1aa7a094d58fca2d3184182761e248f781d/Dockerfile#L15-L20)
+# which corresponds to 2.4.3 release
+export STAC_VERSION=2.4.3-crim-main
+export STAC_IMAGE=ghcr.io/crim-ca/stac-app:main
+export STAC_IMAGE_URI=${STAC_IMAGE}
+
+# 'docker_image_push' branch points at https://github.com/crim-ca/stac-browser/tree/docker_image_push
+# which is some commits ahead of 'v3.0.0-beta.5' (and multiple behind latest official releases)
+# version name is slightly tweaked to fulfill schema while leaving an obvious trace
+export STAC_BROWSER_VERSION=3.0.0-beta.5-crim-docker-image-push
+export STAC_BROWSER_IMAGE=ghcr.io/crim-ca/stac-browser:docker_image_push
+export STAC_BROWSER_IMAGE_URI=${STAC_BROWSER_IMAGE}
+
 # add any new variables not already in 'VARS' or 'OPTIONAL_VARS' that must be replaced in templates here
 # single quotes are important in below list to keep variable names intact until 'pavics-compose' parses them
 EXTRA_VARS='

@@ -10,7 +10,7 @@ x-logging:
 services:
   stac:
     container_name: stac
-    image: ghcr.io/crim-ca/stac-app:main
+    image: ${STAC_IMAGE}
     depends_on:
       - stac-db
     environment:
@@ -28,7 +28,7 @@ services:
 
   stac-browser:
     container_name: stac-browser
-    image: ghcr.io/crim-ca/stac-browser:docker_image_push
+    image: ${STAC_BROWSER_IMAGE}
     environment:
       - CATALOG_URL=https://${PAVICS_FQDN_PUBLIC}/stac/
       - ROOT_PATH=/stac-browser/

@@ -1,6 +1,11 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "stac",
+  "version": "${STAC_VERSION}",
+  "types": [
+    "catalog",
+    "data"
+  ],
   "keywords": [
     "catalog"
   ],
@@ -25,11 +30,21 @@
       "rel": "alternate",
       "type": "text/html",
       "href": "https://${PAVICS_FQDN_PUBLIC}/stac-browser/"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${STAC_IMAGE_URI}"
     }
   ]
 }, {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "stac-browser",
+  "version": "${STAC_BROWSER_VERSION}",
+  "types": [
+    "catalog",
+    "data"
+  ],
   "keywords": [
     "catalog"
   ],
@@ -49,6 +64,11 @@
       "rel": "alternate",
       "type": "application/json",
       "href": "https://${PAVICS_FQDN_PUBLIC}/stac/"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${STAC_BROWSER_IMAGE_URI}"
     }
   ]
 }
@@ -4,6 +4,7 @@
 export THREDDS_VERSION=4.6.18-unidata-2022-01
 export THREDDS_DOCKER=pavics/thredds-docker
 export THREDDS_IMAGE="${THREDDS_DOCKER}:${THREDDS_VERSION}"
+export THREDDS_IMAGE_URI="registry.hub.docker.com/${THREDDS_IMAGE}"
 export THREDDS_ORGANIZATION="Birdhouse"
 export THREDDS_ADDITIONAL_CATALOG=""
 

@@ -1,6 +1,11 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "thredds",
+  "version": "${THREDDS_VERSION}",
+  "types": [
+    "data",
+    "catalog"
+  ],
   "keywords": [
     "data",
     "catalog"
@@ -21,6 +26,11 @@
       "rel": "service-desc",
       "type": "text/xml",
       "href": "https://${PAVICS_FQDN_PUBLIC}/thredds/catalog.xml"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${THREDDS_IMAGE_URI}"
     }
   ]
 }
@@ -48,6 +48,10 @@ export WEAVER_CONFIG=HYBRID
 
 # default release version that will be used to fetch docker images (API mananger & celery workers services)
 export WEAVER_VERSION=4.32.0
+export WEAVER_DOCKER=pavics/weaver
+export WEAVER_MANAGER_IMAGE=${WEAVER_DOCKER}:${WEAVER_VERSION}-manager
+export WEAVER_WORKER_IMAGE=${WEAVER_DOCKER}:${WEAVER_VERSION}-worker
+export WEAVER_IMAGE_URI="registry.hub.docker.com/${WEAVER_MANAGER_IMAGE}"
 
 # default release of the MongoDB version employed by Weaver
 # NOTE:

@@ -16,7 +16,7 @@ services:
     #   Weaver is started, they will all be able to request them and register the providers correctly.
     #   This is needed because simply adding 'depends_on' only ensures that containers are 'running', but startup of
     #   WPS applications themselves are not necessarily completed. Successful HTTP responses ensure they are 'ready'.
-    image: pavics/weaver:${WEAVER_VERSION}-manager
+    image: ${WEAVER_MANAGER_IMAGE}
     environment:
       HOSTNAME: ${PAVICS_FQDN}
       FORWARDED_ALLOW_IPS: "*"
@@ -42,7 +42,7 @@ services:
 
   # Image 'worker' is the job runner of Weaver, possibly spawning Docker applications according to process definition
   weaver-worker:
-    image: pavics/weaver:${WEAVER_VERSION}-worker
+    image: ${WEAVER_WORKER_IMAGE}
     container_name: ${WEAVER_WORKER_NAME}
     environment:
       DOCKER_HOST: "tcp://docker-proxy:2375"

@@ -1,6 +1,11 @@
 {
   "$schema": "https://raw.githubusercontent.com/DACCS-Climate/Marble-node-registry/main/node_registry.schema.json#service",
   "name": "weaver",
+  "version": "${WEAVER_VERSION}",
+  "types": [
+    "ogcapi_processes",
+    "wps"
+  ],
   "keywords": [
     "service-ogcapi_processes"
   ],
@@ -25,6 +30,11 @@
       "rel": "conformance",
       "type": "application/json",
       "href": "https://${PAVICS_FQDN_PUBLIC}/${WEAVER_MANAGER_NAME}/conformance/"
+    },
+    {
+      "rel": "service-meta",
+      "type": "application/vnd.oci.image.index.v1+json",
+      "href": "${WEAVER_IMAGE_URI}"
     }
   ]
 }