Deprecated unused/unmaintained components (#311)

## Overview

Move unused and unmaintained components to a separate
`deprecated-components/` subdirectory and remove
them from the DEFAULT_CONF_DIRS list if required.

## Changes

**Non-breaking changes**

**Breaking changes**
- The following components are no longer present by default:
  - catalog
  - frontend
  - malleefowl
  - ncops
  - ncwms2
  - project-api
  - solr
  - phoenix

## Related Issue / Discussion

- Resolves #214
- Closes #287 
- Resolves #206
- Closes #291 
- Resolves #9
- Closes #292 
- Resolves #290 

## Additional Information

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.26.11
+current_version = 1.27.0
 commit = True
 tag = False
 tag_name = {new_version}
@@ -30,11 +30,11 @@ search = {current_version}
 replace = {new_version}
 
 [bumpversion:file:RELEASE.txt]
-search = {current_version} 2023-07-04T12:57:39Z
+search = {current_version} 2023-07-06T16:40:21Z
 replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ}
 
 [bumpversion:part:releaseTime]
-values = 2023-07-04T12:57:39Z
+values = 2023-07-06T16:40:21Z
 
 [bumpversion:file(version):birdhouse/config/canarie-api/docker_configuration.py.template]
 search = 'version': '{current_version}'

CHANGES.md

@@ -17,6 +17,14 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[1.27.0](https://github.com/bird-house/birdhouse-deploy/tree/1.27.0) (2023-07-06)
+------------------------------------------------------------------------------------------------------------------
+
+- Deprecate unused/unmaintained components
+
+  Move unused and unmaintained components to a separate [`deprecated-components/`](birdhouse/deprecated-components)
+  subdirectory and remove them from the `DEFAULT_CONF_DIRS` list if required.
+
 [1.26.11](https://github.com/bird-house/birdhouse-deploy/tree/1.26.11) (2023-07-04)
 ------------------------------------------------------------------------------------------------------------------
 

Makefile

@@ -1,7 +1,7 @@
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 1.26.11
+override APP_VERSION := 1.27.0
 
 # utility to remove comments after value of an option variable
 override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g")

README.rst

@@ -14,13 +14,13 @@ for a full-fledged production platform.
     * - releases
       - | |latest-version| |commits-since|
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.26.11.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.27.0.svg
     :alt: Commits since latest release
-    :target: https://github.com/bird-house/birdhouse-deploy/compare/1.26.11...master
+    :target: https://github.com/bird-house/birdhouse-deploy/compare/1.27.0...master
 
-.. |latest-version| image:: https://img.shields.io/badge/tag-1.26.11-blue.svg?style=flat
+.. |latest-version| image:: https://img.shields.io/badge/tag-1.27.0-blue.svg?style=flat
     :alt: Latest Tag
-    :target: https://github.com/bird-house/birdhouse-deploy/tree/1.26.11
+    :target: https://github.com/bird-house/birdhouse-deploy/tree/1.27.0
 
 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
     :alt: ReadTheDocs Build Status (latest version)

RELEASE.txt

@@ -1 +1 @@
-1.26.11 2023-07-04T12:57:39Z
+1.27.0 2023-07-06T16:40:21Z

birdhouse/components/cowbird/.gitignore

@@ -3,8 +3,9 @@ config/cowbird/config.yml
 config/cowbird/cowbird.ini
 config/magpie/config.yml
 config/proxy/conf.extra-service.d/cowbird.conf
-config/proxy/canarie_api_monitoring.py
+config/canarie-api/canarie_api_monitoring.py
 
 # Old paths. Keep these so that old config files remain uncommittable after updates.
 conf.extra-service.d/cowbird.conf
 config/canarie-api/cowbird_config.py
+config/proxy/canarie_api_monitoring.py

birdhouse/components/cowbird/default.env

@@ -36,3 +36,10 @@ export COWBIRD_MONGODB_PORT=27017
 
 # Subdirectory containing the user workspaces used by Cowbird
 export USER_WORKSPACES="user_workspaces"
+
+# this dependency is only required if COWBIRD_MONGODB_SERVICE is the one provided in config/mongodb.
+# (include this by default to support backwards compatibility for now)
+COMPONENT_DEPENDENCIES="
+  $COMPONENT_DEPENDENCIES
+  ./config/mongodb
+"

birdhouse/config/.gitignore

@@ -1,2 +1,10 @@
 # Old paths. Keep these so that old config files remain uncommittable after updates.
 postgres-magpie/
+catalog/
+frontend/
+malleefowl/
+ncops/
+ncwms2/
+project-api/
+solr/
+phoenix/

birdhouse/config/canarie-api/docker_configuration.py.template

@@ -109,8 +109,8 @@ SERVICES = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '1.26.11',
-            'releaseTime': '2023-07-04T12:57:39Z',
+            'version': '1.27.0',
+            'releaseTime': '2023-07-06T16:40:21Z',
             'institution': 'Ouranos',
             'researchSubject': 'Climatology',
             'supportEmail': '${SUPPORT_EMAIL}',
@@ -142,8 +142,8 @@ PLATFORMS = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '1.26.11',
-            'releaseTime': '2023-07-04T12:57:39Z',
+            'version': '1.27.0',
+            'releaseTime': '2023-07-06T16:40:21Z',
             'institution': 'Ouranos',
             'researchSubject': 'Climatology',
             'supportEmail': '${SUPPORT_EMAIL}',

birdhouse/config/thredds/.gitignore

@@ -3,6 +3,7 @@ threddsConfig.xml
 config/proxy/conf.extra-service.d/thredds.conf
 config/canarie-api/canarie_api_monitoring.py
 service-config.json
+config/magpie/providers.cfg
 
 # Old paths. Keep these so that old config files remain uncommittable after updates.
 config/proxy/canarie_api_monitoring.py

birdhouse/config/thredds/config/magpie/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./config/thredds/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/thredds-providers.cfg:ro

birdhouse/config/thredds/config/magpie/providers.cfg.template

@@ -0,0 +1,35 @@
+providers:
+  thredds:
+    url: http://thredds:8080/twitcher/ows/proxy/thredds
+    title: Thredds
+    public: true
+    c4i: false
+    type: thredds
+    sync_type: thredds
+    # below is a custom config to indicate how magpie should convert thredds path elements into resources/permissions
+    # see: https://pavics-magpie.readthedocs.io/en/latest/services.html#servicethredds
+    configuration:
+      skip_prefix: "thredds"  # prefix to ignore, below prefixes will be matched against whatever comes after in path
+      file_patterns:
+        # note: make sure to employ quotes and double escapes to avoid parsing YAML error
+        - ".+\\.ncml"  # match longest extension first to avoid tuncating it by match of sorter '.nc'
+        - ".+\\.nc"
+      metadata_type:
+        prefixes:
+          - null  # note: special YAML value evaluated as `no-prefix`, use quotes if literal value is needed
+          - "\\w+\\.gif"  # threddsIcon, folder icon, etc.
+          - "\\w+\\.ico"  # favicon
+          - "\\w+\\.txt"  # licence
+          - "\\w+\\.css"  # tds.css
+          - "catalog\\.\\w+"  # note: special case for `THREDDS` top-level directory (root) accessed for `BROWSE`
+          - catalog
+          - ncml
+          - uddc
+          - iso
+      data_type:
+        prefixes:
+          - fileServer
+          - dodsC
+          - wcs
+          - wms
+          - ncss

birdhouse/default.env

@@ -39,7 +39,6 @@ or a custom web interface.
 export DEFAULT_CONF_DIRS='
   ./config/proxy
   ./config/canarie-api
-  ./config/phoenix
   ./config/geoserver
   ./config/flyingpigeon
   ./config/finch
@@ -50,9 +49,4 @@ export DEFAULT_CONF_DIRS='
   ./config/magpie
   ./config/twitcher
   ./config/jupyterhub
-  ./config/frontend
-  ./config/project-api
-  ./config/catalog
-  ./config/malleefowl
-  ./config/solr
 '

birdhouse/deprecated-components/README.rst

@@ -0,0 +1,29 @@
+Deprecated Components
+#####################
+
+.. contents::
+
+All components in this directory are not actively maintained.
+
+If you wish to include these components in the deployed stack, additional work
+may be required to make them compatible with the current stack.
+
+Components in this directory may be removed from this repository at any time.
+
+This directory also contains additional configurations for these deprecated components in:
+
+- `all-public-access-deprecated/`
+- `canarie-api-full-monitoring-deprecated/`
+- `wps-healthchecks-deprecated/`
+
+These contain the settings to extend the deprecated components that have been moved from the corresponding
+directories under `birdhouse/optional-components`.
+
+To enable these additional configurations; add them to the `EXTRA_CONF_DIRS` variable (in `env.local`)
+as you would to enable any component. For example, to enable the deprecated malleefowl component as well as the
+wps-healthchecks for malleefowl. The `EXTRA_CONF_DIRS` variable should contain:
+
+.. code-block:: shell
+
+  ./deprecated-components/malleefowl
+  ./wps-healthchecks-deprecated

birdhouse/deprecated-components/catalog/config/canarie-api/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./deprecated-components/catalog/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/catalog_canarie_api_monitoring.py:ro

birdhouse/deprecated-components/catalog/config/magpie/docker-compose-extra.yml

@@ -0,0 +1,6 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./deprecated-components/catalog/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/catalog-providers.cfg:ro
+    - ./deprecated-components/catalog/config/magpie/permissions.cfg:${MAGPIE_PERMISSIONS_CONFIG_PATH}/catalog-permissions.cfg:ro

birdhouse/config/catalog/docker-compose-extra.yml → birdhouse/deprecated-components/catalog/docker-compose-extra.yml

@@ -14,7 +14,7 @@ services:
     ports:
       - "8086:80"
     volumes:
-      - ./config/catalog/catalog.cfg:/home/catalog.cfg
+      - ./deprecated-components/catalog/catalog.cfg:/home/catalog.cfg
       - wps_outputs:/var/www/html/wps_results
     depends_on:
       - postgres

birdhouse/deprecated-components/frontend/config/canarie-api/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./deprecated-components/frontend/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/frontend_canarie_api_monitoring.py:ro

birdhouse/deprecated-components/frontend/config/proxy/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./deprecated-components/frontend/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/frontend:ro

birdhouse/config/frontend/docker-compose-extra.yml → birdhouse/deprecated-components/frontend/docker-compose-extra.yml

@@ -14,6 +14,6 @@ services:
     ports:
       - "3000:3000"
     env_file:
-      - ./config/frontend/frontend.env
+      - ./deprecated-components/frontend/frontend.env
     restart: always
     logging: *default-logging

birdhouse/deprecated-components/malleefowl/config/canarie-api/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./deprecated-components/malleefowl/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/malleefowl_canarie_api_monitoring.py:ro

birdhouse/deprecated-components/malleefowl/config/magpie/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./deprecated-components/malleefowl/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/malleefowl-providers.cfg:ro

birdhouse/config/malleefowl/docker-compose-extra.yml → birdhouse/deprecated-components/malleefowl/docker-compose-extra.yml

@@ -24,7 +24,7 @@ services:
       - "48091:9001"
     volumes:
       - ${DATA_PERSIST_ROOT}/datasets:/pavics-data
-      - ./config/malleefowl/custom.cfg:/opt/birdhouse/src/malleefowl/custom.cfg
+      - ./deprecated-components/malleefowl/custom.cfg:/opt/birdhouse/src/malleefowl/custom.cfg
     depends_on:
       - postgres
     restart: always

birdhouse/deprecated-components/ncwms2/config/magpie/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  magpie:
+    volumes:
+    - ./deprecated-components/ncwms2/config/magpie/providers.cfg:${MAGPIE_PROVIDERS_CONFIG_PATH}/ncwms2-providers.cfg:ro

birdhouse/deprecated-components/ncwms2/config/proxy/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./deprecated-components/ncwms2/config/proxy/conf.extra-service.d:/etc/nginx/conf.extra-service.d/ncwms2:ro

birdhouse/config/ncwms2/docker-compose-extra.yml → birdhouse/deprecated-components/ncwms2/docker-compose-extra.yml

@@ -16,7 +16,7 @@ services:
       - "48080:9001"
     volumes:
       - ${DATA_PERSIST_ROOT}/datasets:/pavics-data
-      - ./config/ncwms2/custom.cfg:/opt/birdhouse/custom.cfg
-      - ./config/ncwms2/server.xml:/opt/birdhouse/eggs/birdhousebuilder.recipe.tomcat-0.2.9-py2.7.egg/birdhousebuilder/recipe/tomcat/server.xml
+      - ./deprecated-components/ncwms2/custom.cfg:/opt/birdhouse/custom.cfg
+      - ./deprecated-components/ncwms2/server.xml:/opt/birdhouse/eggs/birdhousebuilder.recipe.tomcat-0.2.9-py2.7.egg/birdhousebuilder/recipe/tomcat/server.xml
     restart: always
     logging: *default-logging

birdhouse/deprecated-components/phoenix/config/canarie-api/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./deprecated-components/phoenix/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/phoenix_canarie_api_monitoring.py:ro

birdhouse/config/phoenix/docker-compose-extra.yml → birdhouse/deprecated-components/phoenix/docker-compose-extra.yml

@@ -22,7 +22,7 @@ services:
       - "38443:38443"
       - "9001:9001"
     volumes:
-      - ./config/phoenix/custom.cfg:/opt/birdhouse/src/phoenix/custom.cfg
+      - ./deprecated-components/phoenix/custom.cfg:/opt/birdhouse/src/phoenix/custom.cfg
       - ${SSL_CERTIFICATE}:/opt/birdhouse/etc/nginx/cert.pem
     links:
       - mongodb

birdhouse/deprecated-components/project-api/config/canarie-api/docker-compose-extra.yml

@@ -0,0 +1,5 @@
+version: "3.4"
+services:
+  proxy:
+    volumes:
+    - ./deprecated-components/project-api/config/canarie-api/canarie_api_monitoring.py:${CANARIE_MONITORING_EXTRA_CONF_DIR}/project-api_canarie_api_monitoring.py:ro