Merge branch 'master' into gpu-resource-allocation

mishaschwartz · mishaschwartz · commit 6032b92b1d2a · 2025-12-22T13:35:56.000-05:00
diff --git a/.bumpversion.toml b/.bumpversion.toml
@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "2.19.0"
+current_version = "2.20.1"
 commit = true
 tag = false
 tag_name = "{new_version}"
diff --git a/CHANGES.md b/CHANGES.md
@@ -34,6 +34,50 @@
 
   Also changes the format for `JUPYTERHUB_RESOURCE_LIMITS` to a yaml or JSON string. 
 
+[2.20.1](https://github.com/bird-house/birdhouse-deploy/tree/2.20.1) (2025-12-16)
+------------------------------------------------------------------------------------------------------------------
+
+## Fixes
+
+- Add log rotation scheduler job for the nginx logs
+
+  Currently the nginx logs are not rotated so they can build up to quite a large size.
+
+  Previously, they were rotated by the `canarie-api` component but that is no longer a required
+  component and CanarieAPI hasn't handled log rotation since CanarieAPI version 1.0.0 (see 
+  https://github.com/bird-house/birdhouse-deploy/pull/452 for details).
+
+  Fixes https://github.com/bird-house/birdhouse-deploy/issues/593. Here is a summary of the issue:
+
+  - CanarieApi parses the log file every minute starting from the beginning of the file
+  - If the log file is really big it uses a lot of CPU and memory to read through the whole file
+  - This would use a lot less CPU and memory if the log file was smaller
+
+  This quick and least disruptive fix to get the production server out of the water should be a 
+  temporary solution until a better solution using container STDOUT parsing is implemented for 
+  the CanarieAPI and prometheus-log-parser (https://github.com/bird-house/birdhouse-deploy/issues/618).  
+  Then we can deprecate this scheduler job.
+
+[2.20.0](https://github.com/bird-house/birdhouse-deploy/tree/2.20.0) (2025-12-10)
+------------------------------------------------------------------------------------------------------------------
+
+## Changes
+
+- STAC API: update to version [`2.1.0`](https://github.com/crim-ca/stac-app/releases/tag/2.1.0).
+
+  - Fix paging error on `/collections` responses causing requests with `limit` query or catalogs
+    with more than 10 collections (by default) to never return collections beyond the first page.
+
+- STAC Browser: update to version [`4.0.0-rc.2-crim`](https://github.com/crim-ca/stac-browser/releases/tag/v4.0.0-rc.2-crim).
+  
+  Apply upstream fixes, notably:
+
+  - Logo resizing issue when embedded in contact details.
+  - Handling of `geojson.io` external viewer references from compatible GeoJSON STAC Assets.
+  - Improvements to UI for better locales, content positioning and browsing experience.
+  - Alignment with latest OGC APIs requirements and conformance classes.
+  - Added support for multiple additional data representations and visualization.
+
 [2.19.0](https://github.com/bird-house/birdhouse-deploy/tree/2.19.0) (2025-12-05)
 ------------------------------------------------------------------------------------------------------------------
 
diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ override BIRDHOUSE_MAKE_DIR := $(shell realpath -P $$(dirname $(BIRDHOUSE_MAKE_C
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 2.19.0
+override APP_VERSION := 2.20.1
 
 # utility to remove comments after value of an option variable
 override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g")
diff --git a/README.rst b/README.rst
@@ -18,13 +18,13 @@ for a full-fledged production platform.
     * - citation
       - | |citation|
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.19.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.20.1.svg
     :alt: Commits since latest release
-    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.19.0...master
+    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.20.1...master
 
-.. |latest-version| image:: https://img.shields.io/badge/tag-2.19.0-blue.svg?style=flat
+.. |latest-version| image:: https://img.shields.io/badge/tag-2.20.1-blue.svg?style=flat
     :alt: Latest Tag
-    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.19.0
+    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.20.1
 
 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
     :alt: ReadTheDocs Build Status (latest version)
diff --git a/RELEASE.txt b/RELEASE.txt
@@ -1 +1 @@
-2.19.0 2025-12-05T19:41:43Z
+2.20.1 2025-12-16T18:09:59Z
diff --git a/birdhouse/components/canarie-api/docker_configuration.py.template b/birdhouse/components/canarie-api/docker_configuration.py.template
@@ -108,8 +108,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': '2.19.0',
-            'releaseTime': '2025-12-05T19:41:43Z',
+            'version': '2.20.1',
+            'releaseTime': '2025-12-16T18:09:59Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',
@@ -141,8 +141,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': '2.19.0',
-            'releaseTime': '2025-12-05T19:41:43Z',
+            'version': '2.20.1',
+            'releaseTime': '2025-12-16T18:09:59Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',
diff --git a/birdhouse/components/proxy/default.env b/birdhouse/components/proxy/default.env
@@ -71,3 +71,9 @@ export OPTIONAL_VARS="
   \$PROXY_LISTEN_443_PARAMS
   \$PROXY_LISTEN_80_PARAMS
 "
+
+# TODO: remove this dependency once https://github.com/bird-house/birdhouse-deploy/issues/618 is resolved
+COMPONENT_DEPENDENCIES="
+  ./components/scheduler
+  ./optional-components/scheduler-job-logrotate-nginx
+"
diff --git a/birdhouse/components/stac-browser/default.env b/birdhouse/components/stac-browser/default.env
@@ -10,7 +10,7 @@
 # is a fork of the official stac-browser (https://github.com/radiantearth/stac-browser)
 # which is some commits ahead to provide necessary build argument fixes for redirects by the nginx proxy.
 # version name is slightly tweaked to fulfill 'service-config' JSON schema while leaving an obvious trace of the source
-export STAC_BROWSER_VERSION=3.3.5
+export STAC_BROWSER_VERSION=4.0.0-rc.2-crim
 export STAC_BROWSER_DOCKER='crim-ca/stac-browser'
 export STAC_BROWSER_IMAGE='ghcr.io/${STAC_BROWSER_DOCKER}:${STAC_BROWSER_VERSION}'
 export STAC_BROWSER_IMAGE_URI='${STAC_BROWSER_IMAGE}'
diff --git a/birdhouse/components/stac/default.env b/birdhouse/components/stac/default.env
@@ -17,8 +17,8 @@ export STAC_PGPASSWORD='${BIRDHOUSE_POSTGRES_PASSWORD}'
 #   crim-ca/stac-app:1.0.0 uses STAC-fastapi version 3.0.3 with pgstac 0.6.10 (techically >=0.7,<0.8, but 0.6 works)
 #   crim-ca/stac-app:1.1.0 uses STAC-fastapi version 5.2.0 with pgstac 0.9.6 (techically >=0.8,<0.10)
 #   crim-ca/stac-app:2.0.1 uses STAC-fastapi version 6.0.0 with pgstac 0.9.6+ (techically >=0.8,<0.10)
-export STAC_VERSION=6.0.0-crim-2.0.2
-export STAC_IMAGE='ghcr.io/crim-ca/stac-app:2.0.2'
+export STAC_VERSION=6.0.0-crim-2.1.0
+export STAC_IMAGE='ghcr.io/crim-ca/stac-app:2.1.0'
 export STAC_IMAGE_URI='${STAC_IMAGE}'
 # database SQL schemas must be aligned with STAC_VERSION
 # there versions are not "equal", check compatibilities on https://github.com/stac-utils/stac-fastapi-pgstac
diff --git a/birdhouse/optional-components/scheduler-job-logrotate-nginx/.gitignore b/birdhouse/optional-components/scheduler-job-logrotate-nginx/.gitignore
@@ -0,0 +1,2 @@
+config.yml
+nginx.logrotate
diff --git a/birdhouse/optional-components/scheduler-job-logrotate-nginx/config.yml.template b/birdhouse/optional-components/scheduler-job-logrotate-nginx/config.yml.template
@@ -0,0 +1,12 @@
+- name: logrotate-nginx
+  comment: Rotate log files for nginx
+  schedule: '${SCHEDULER_JOB_LOGROTATE_NGINX_JOB_SCHEDULE}'
+  command: bash -c 'cp /etc/logrotate.conf.orig /etc/logrotate.conf && chown root:root /etc/logrotate.conf && chmod 644 /etc/logrotate.conf && /usr/sbin/logrotate -v /etc/logrotate.conf'
+  dockerargs: >-
+    --rm --name logrotate-nginx
+    --volume ${COMPOSE_PROJECT_NAME}_proxy-logs:/var/log/nginx/:rw
+    --volume ${COMPOSE_DIR}/optional-components/scheduler-job-logrotate-nginx/nginx.logrotate:/etc/logrotate.conf.orig:ro
+  trigger:
+    - command: sh -c '[ -f /var/run/nginx.pid ] && kill -USR1 $(cat /var/run/nginx.pid)'
+      container: proxy
+  image: 'stakater/logrotate:3.13.0'
diff --git a/birdhouse/optional-components/scheduler-job-logrotate-nginx/config/proxy/docker-compose-extra.yml b/birdhouse/optional-components/scheduler-job-logrotate-nginx/config/proxy/docker-compose-extra.yml
@@ -0,0 +1,7 @@
+services:
+  proxy:
+    volumes:
+      - proxy-logs:${PROXY_LOG_DIR}
+
+volumes:
+  proxy-logs:
diff --git a/birdhouse/optional-components/scheduler-job-logrotate-nginx/config/scheduler/docker-compose-extra.yml b/birdhouse/optional-components/scheduler-job-logrotate-nginx/config/scheduler/docker-compose-extra.yml
@@ -0,0 +1,4 @@
+services:
+  scheduler:
+    volumes: 
+      - ./optional-components/scheduler-job-logrotate-nginx/config.yml:/scheduler-job-configs/logrotate-nginx.yml:ro
diff --git a/birdhouse/optional-components/scheduler-job-logrotate-nginx/default.env b/birdhouse/optional-components/scheduler-job-logrotate-nginx/default.env
@@ -0,0 +1,13 @@
+export SCHEDULER_JOB_LOGROTATE_NGINX_JOB_SCHEDULE="* * * * *"  # UTC
+export SCHEDULER_JOB_LOGROTATE_NGINX_ROTATE=150
+export SCHEDULER_JOB_LOGROTATE_NGINX_SIZE=1M
+
+VARS="
+  $VARS
+  \$SCHEDULER_JOB_LOGROTATE_NGINX_JOB_SCHEDULE
+  \$SCHEDULER_JOB_LOGROTATE_NGINX_ROTATE
+  \$SCHEDULER_JOB_LOGROTATE_NGINX_SIZE
+"
+
+# TODO: deprecate this component once https://github.com/bird-house/birdhouse-deploy/issues/618 is resolved
+#       remember that deprecating involves adding an entry to optional-components/.gitignore
diff --git a/birdhouse/optional-components/scheduler-job-logrotate-nginx/nginx.logrotate.template b/birdhouse/optional-components/scheduler-job-logrotate-nginx/nginx.logrotate.template
@@ -0,0 +1,11 @@
+/var/log/nginx/${PROXY_LOG_FILE} {
+        missingok
+        # https://github.com/Ouranosinc/CanarieAPI/blob/cc0ae59231ee4b58a34571bd12097c660aefb2e3/canarieapi/logparser.py#L15
+        rotate ${SCHEDULER_JOB_LOGROTATE_NGINX_ROTATE}
+        size ${SCHEDULER_JOB_LOGROTATE_NGINX_SIZE}
+        compress
+        delaycompress
+        notifempty
+        # log files in the proxy container are owned by root currently
+        create 640 root root
+}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -69,9 +69,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.19.0'
+version = '2.20.1'
 # The full version, including alpha/beta/rc tags.
-release = '2.19.0'
+release = '2.20.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/tests/unit/test_read_configs_include.py b/tests/unit/test_read_configs_include.py
@@ -197,6 +197,10 @@ class TestReadConfigs(TestReadBasicConfigs):
     ]
 
     default_all_conf_order_with_dependencies: list[str] = [
+        # TODO: remove the scheduler dependencies once 
+        #       https://github.com/bird-house/birdhouse-deploy/issues/618 is resolved
+        "./components/scheduler",
+        "./optional-components/scheduler-job-logrotate-nginx",
         "./components/proxy",
         "./components/magpie",
         "./components/twitcher",

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-2.19.0 2025-12-05T19:41:43Z`
	`1`	`+2.20.1 2025-12-16T18:09:59Z`