bird-house · mishaschwartz · Dec 11, 2023 · Nov 7, 2023 · Nov 7, 2023 · Nov 7, 2023
@@ -15,7 +15,25 @@
 [Unreleased](https://github.com/bird-house/birdhouse-deploy/tree/master) (latest)
 ------------------------------------------------------------------------------------------------------------------
 
-[//]: # (list changes here, using '-' for each new entry, remove this when items are added)
+## Changes
+
+- Update `DEFAULT_CONF_DIRS` to the minimal components required to deploy the stack
+
+  Changes `DEFAULT_CONF_DIRS` to refer exclusively to the proxy, magpie, twitcher, stac, and cowbird components.
+  Also moves all components that were previously under the `birdhouse/config` directory to the `birdhouse/components`
+  directory. This removes the arbitrary distinction between these groups of components that didn't have any functional
+  or logical reason.
+
+  Because this change updates the default components, this is not backwards compatible unless the following changes are
+  made to the local environment file (`birdhouse/env.local` by default):
+
+  - add any components no longer in the `DEFAULT_CONF_DIRS` list to the `EXTRA_CONF_DIRS` list.
+    For example, to keep the jupyterhub component enabled, add `./components/jupyterhub` to the `EXTRA_CONF_DIRS` list.
+
+  - update the `PROXY_ROOT_LOCATION` to redirect the root path `/` to an enabled component. By default, this will
+    redirect to Magpie's landing page, unless jupyterhub is enabled, in which case it will redirect to jupyterhub's
+    landing page.
+    If any other behaviour is desired, `PROXY_ROOT_LOCATION` should be updated in the `env.local` file.
 
 [1.37.1](https://github.com/bird-house/birdhouse-deploy/tree/1.37.1) (2023-11-03)
 ------------------------------------------------------------------------------------------------------------------

@@ -0,0 +1 @@
+./config
@@ -378,7 +378,7 @@ Release Procedure
   * Run ``git push --tags`` to upload the new version.
 
 
-.. _nginx.conf: ./config/proxy/nginx.conf
+.. _nginx.conf: ./components/proxy/nginx.conf
 .. _default.env: ./default.env
 .. _`.bumpversion.cfg`: ../.bumpversion.cfg
 .. _CHANGES.md: ../CHANGES.md
@@ -0,0 +1,11 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+      - ./components/canarie-api/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/canarie-api:ro
+      - ./components/canarie-api/docker_configuration.py:/config/docker_configuration.py
+      - ./components/canarie-api/entrypoint:/entrypoint:ro
+    environment:
+      CANARIE_API_CONFIG_FN: /config/docker_configuration.py
+      CANARIE_MONITORING_EXTRA_CONF_DIR: ${CANARIE_MONITORING_EXTRA_CONF_DIR}
+    entrypoint: /entrypoint
@@ -5,5 +5,5 @@ export PROXY_IMAGE="pavics/canarieapi:0.7.1"
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  ./config/proxy
+  ./components/proxy
 "
@@ -18,4 +18,4 @@ services:
   cowbird-worker:
     env_file:
       # user/password for admin session to perform permission sync updates
-      - ./config/magpie/postgres-credentials.env
+      - ./components/magpie/postgres-credentials.env
@@ -64,9 +64,14 @@ DELAYED_EVAL="
   COWBIRD_MONGODB_DATA_DIR
 "
 
+COMPONENT_DEPENDENCIES="
+  $COMPONENT_DEPENDENCIES
+  ./components/magpie
+"
+
 # this dependency is only required if the mongo instance is the one provided in config/mongodb.
 # (include this for Cowbird<2.0.0)
 #COMPONENT_DEPENDENCIES="
 #  $COMPONENT_DEPENDENCIES
-#  ./config/mongodb
+#  ./components/mongodb
 #"
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/finch/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/finch_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./components/finch/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/finch-providers.cfg:ro
@@ -21,8 +21,8 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  ./config/wps_outputs-volume
-  ./config/postgres
+  ./components/wps_outputs-volume
+  ./components/postgres
 "
 
 OPTIONAL_VARS="

@@ -16,7 +16,7 @@ services:
       HTTP_PORT: 5000
       PYWPS_CFG: /wps.cfg
     volumes:
-      - ./config/finch/wps.cfg:/wps.cfg
+      - ./components/finch/wps.cfg:/wps.cfg
       # - data:/opt/birdhouse/var/lib
       - /tmp
     restart: always

@@ -6,4 +6,3 @@ service-config.json
 geoserver_canarie_api_monitoring.py
 geoserver-magpie-provider.cfg
 config/proxy/canarie_api_monitoring.py
-config/magpie/providers.cfg
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/geoserver/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/geoserver_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./components/geoserver/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/geoserver-providers.cfg:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/geoserver/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/geoserver:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/hummingbird/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/hummingbird_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./components/hummingbird/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/hummingbird-providers.cfg:ro
@@ -14,9 +14,9 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  ./config/postgres
-  ./config/wps_outputs-volume
-  ./config/data-volume
+  ./components/postgres
+  ./components/wps_outputs-volume
+  ./components/data-volume
 "
 
 OPTIONAL_VARS="

@@ -14,7 +14,7 @@ services:
     environment:
       HOSTNAME: $HOSTNAME
     volumes:
-      - ./config/hummingbird/custom.cfg:/opt/birdhouse/src/hummingbird/custom.cfg
+      - ./components/hummingbird/custom.cfg:/opt/birdhouse/src/hummingbird/custom.cfg
     depends_on:
       - postgres
     restart: always

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/jupyterhub/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/jupyterhub_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./components/jupyterhub/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/jupyter.cfg:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/jupyterhub/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/jupyterhub:ro
@@ -64,6 +64,10 @@ export JUPYTERHUB_CONFIG_OVERRIDE=""
 # recommended as it may permit unauthorized users from accessing jupyterhub.
 export JUPYTERHUB_AUTHENTICATOR_AUTHORIZATION_URL='http://twitcher:8000/ows/verify/jupyterhub'
 
+# Set the PROXY_ROOT_LOCATION to jupyterhub's landing page by default. Added for backwards compatibility
+# where this was the default when the jupyterhub component is enabled.
+export PROXY_ROOT_LOCATION="return 302 https://\$host/jupyter/hub/login;"
+
 export DELAYED_EVAL="
   $DELAYED_EVAL
   JUPYTERHUB_USER_DATA_DIR
@@ -93,5 +97,5 @@ OPTIONAL_VARS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  ./config/magpie
+  ./components/magpie
 "
@@ -28,8 +28,8 @@ services:
       USER_WORKSPACE_UID: ${USER_WORKSPACE_UID}
       USER_WORKSPACE_GID: ${USER_WORKSPACE_GID}
     volumes:
-      - ./config/jupyterhub/jupyterhub_config.py:/srv/jupyterhub/jupyterhub_config.py:ro
-      - ./config/jupyterhub/custom_templates:/custom_templates:ro
+      - ./components/jupyterhub/jupyterhub_config.py:/srv/jupyterhub/jupyterhub_config.py:ro
+      - ./components/jupyterhub/custom_templates:/custom_templates:ro
       - ${JUPYTERHUB_USER_DATA_DIR}:${JUPYTERHUB_USER_DATA_DIR}
       - jupyterhub_data_persistence:/persist:rw
       - /var/run/docker.sock:/var/run/docker.sock:rw

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/magpie/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/magpie_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/magpie/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/magpie:ro
@@ -23,16 +23,16 @@ services:
       MAGPIE_PORT: 2001
       FORWARDED_ALLOW_IPS: "*"
     env_file:
-      - ./config/magpie/postgres-credentials.env
+      - ./components/magpie/postgres-credentials.env
     depends_on:
       - postgres-magpie
     links:
       - postgres-magpie
     volumes:
-      - ./config/magpie/postgres-credentials.env:/opt/local/src/magpie/env/postgres.env
-      - ./config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/providers.cfg
-      - ./config/magpie/permissions.cfg:${MAGPIE_PERMISSIONS_CONFIG_PATH}/permissions.cfg
-      - ./config/magpie/magpie.ini:/opt/local/src/magpie/config/magpie.ini
+      - ./components/magpie/postgres-credentials.env:/opt/local/src/magpie/env/postgres.env
+      - ./components/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/providers.cfg
+      - ./components/magpie/permissions.cfg:${MAGPIE_PERMISSIONS_CONFIG_PATH}/permissions.cfg
+      - ./components/magpie/magpie.ini:/opt/local/src/magpie/config/magpie.ini
     restart: always
     logging: *default-logging
 
@@ -41,11 +41,11 @@ services:
     container_name: postgres-magpie
     # ports:  # should not be exposed directly, enable 'optional-components/database-external-ports' as needed
     env_file:
-      - ./config/magpie/postgres-credentials.env
+      - ./components/magpie/postgres-credentials.env
     environment:
       PGDATA: /var/lib/postgresql/data/pgdata
     volumes:
       - ${MAGPIE_PERSIST_DIR}:/var/lib/postgresql/data/pgdata
-      - ./config/magpie/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
+      - ./components/magpie/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
     restart: always
     logging: *default-logging
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/portainer/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/portainer:ro
@@ -14,11 +14,11 @@ services:
     # ports:  # should not be exposed directly, enable 'optional-components/database-external-ports' as needed
     volumes:
       - ${POSTGRES_DATA_DIR}:/var/lib/postgresql/data/pgdata
-      - ./config/postgres/postgres-setup.sh:/postgres-setup.sh
+      - ./components/postgres/postgres-setup.sh:/postgres-setup.sh
     environment:
       PGDATA: /var/lib/postgresql/data/pgdata
       POSTGRES_DATABASES_TO_CREATE: ${POSTGRES_DATABASES_TO_CREATE}
     env_file:
-      - ./config/postgres/credentials.env
+      - ./components/postgres/credentials.env
     restart: always
     logging: *default-logging
@@ -8,7 +8,11 @@ export PROXY_READ_TIMEOUT_VALUE="240s"
 
 # Content of "location /" in file config/proxy/conf.d/all-services.include.template
 # Useful to have a custom homepage.
-export PROXY_ROOT_LOCATION="return 302 https://\$host/jupyter/hub/login;"
+# If the jupyterhub component is enabled, this default will be overridden and the location will become the jupyterhub
+# login page instead (see components/jupyterhub/default.env).
+# If jupyterhub is not enabled, we recommend overriding this with a custom homepage since the magpie landing page isn't
+# the most user-friendly location.
+export PROXY_ROOT_LOCATION="return 302 https://\$host/magpie;"
 
 export INCLUDE_FOR_PORT_80='$([ x"$ALLOW_UNSECURE_HTTP" = x"True" ] && echo "include /etc/nginx/conf.d/all-services.include;" || echo "include /etc/nginx/conf.d/redirect-to-https.include;")'
 

@@ -15,10 +15,10 @@ services:
       - "80:80"
       - "443:${PROXY_SECURE_PORT}"
     volumes:
-      - ./config/proxy/conf.d:/etc/nginx/conf.d
-      - ./config/proxy/nginx.conf:/etc/nginx/nginx.conf
+      - ./components/proxy/conf.d:/etc/nginx/conf.d
+      - ./components/proxy/nginx.conf:/etc/nginx/nginx.conf
       - ${SSL_CERTIFICATE}:/etc/nginx/cert.pem
-      - ./config/proxy/static:/static
+      - ./components/proxy/static:/static
     environment:
       # https://github.com/bird-house/birdhouse-deploy/issues/198
       REQUESTS_CA_BUNDLE: /etc/ssl/certs/ca-certificates.crt

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/raven/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/raven_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./components/raven/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/raven-providers.cfg:ro
@@ -23,8 +23,8 @@ export WEAVER_WPS_PROVIDERS="
 
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
-  ./config/postgres
-  ./config/wps_outputs-volume
+  ./components/postgres
+  ./components/wps_outputs-volume
 "
 
 OPTIONAL_VARS="

@@ -15,7 +15,7 @@ services:
       PYWPS_CFG: /wps.cfg
       GEO_URL: "${RAVEN_GEO_URL}"
     volumes:
-      - ./config/raven/wps.cfg:/wps.cfg
+      - ./components/raven/wps.cfg:/wps.cfg
       - /tmp
     restart: always
     logging: *default-logging
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/thredds/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/thredds_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./components/thredds/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/thredds-providers.cfg:ro
@@ -0,0 +1,7 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/thredds/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/thredds:ro
+    links:
+      - thredds
@@ -12,7 +12,7 @@ services:
     image: ${THREDDS_IMAGE}
     container_name: thredds
     env_file:
-      - ./config/thredds/thredds.env
+      - ./components/thredds/thredds.env
     environment:
       # for reconstructing proper URL back to user when Thredds behind proxy
       # because Twitcher eats the "Host" http header set by Nginx
@@ -22,10 +22,10 @@ services:
       - ${DATA_PERSIST_ROOT}/datasets:/pavics-data
       - ${DATA_PERSIST_ROOT}/ncml:/pavics-ncml
       - wps_outputs:/pavics-data/wps_outputs
-      - ./config/thredds/catalog.xml:/usr/local/tomcat/content/thredds/catalog.xml:ro
-      - ./config/thredds/threddsConfig.xml:/usr/local/tomcat/content/thredds/threddsConfig.xml:ro
-      - ./config/thredds/wmsConfig.xml:/usr/local/tomcat/content/thredds/wmsConfig.xml:ro
-      - ./config/thredds/entrypointwrapper:/entrypointwrapper:ro
+      - ./components/thredds/catalog.xml:/usr/local/tomcat/content/thredds/catalog.xml:ro
+      - ./components/thredds/threddsConfig.xml:/usr/local/tomcat/content/thredds/threddsConfig.xml:ro
+      - ./components/thredds/wmsConfig.xml:/usr/local/tomcat/content/thredds/wmsConfig.xml:ro
+      - ./components/thredds/entrypointwrapper:/entrypointwrapper:ro
     entrypoint: /entrypointwrapper
     restart: always
     logging: *default-logging

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/twitcher/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/twitcher_canarie_api_monitoring.py:ro
@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./components/twitcher/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/twitcher:ro