Add log rotation scheduler job for the nginx logs (#619)

## Overview

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.

Fixes #593.

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
(#618). Then we can
deprecate this scheduler job.

## Changes

**Non-breaking changes**
- adds new scheduler job

**Breaking changes**
- None

## Related Issue / Discussion

- This is an alternative to #617. See
#617 (comment)
for reasons why I believe this is a preferred solution.

## Additional Information

## CI Operations

<!--
The test suite can be run using a different DACCS config with
``birdhouse_daccs_configs_branch: branch_name`` in the PR description.
To globally skip the test suite regardless of the commit message use
``birdhouse_skip_ci`` set to ``true`` in the PR description.

Using ``[<cmd>]`` (with the brackets) where ``<cmd> = skip ci`` in the
commit message will override ``birdhouse_skip_ci`` from the PR
description.
Such commit command can be used to override the PR description behavior
for a specific commit update.
However, a commit message cannot 'force run' a PR which the description
turns off the CI.
To run the CI, the PR should instead be updated with a ``true`` value,
and a running message can be posted in following PR comments to trigger
tests once again.
-->

birdhouse_daccs_configs_branch: master
birdhouse_skip_ci: false

Author: mishaschwartz

.bumpversion.toml

@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "2.20.0"
+current_version = "2.20.1"
 commit = true
 tag = false
 tag_name = "{new_version}"

CHANGES.md

@@ -17,6 +17,30 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[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)
 ------------------------------------------------------------------------------------------------------------------
 

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.20.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")

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.20.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.20.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.20.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.20.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)

RELEASE.txt

@@ -1 +1 @@
-2.20.0 2025-12-10T22:06:17Z
+2.20.1 2025-12-16T18:09:59Z

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.20.0',
-            'releaseTime': '2025-12-10T22:06:17Z',
+            '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.20.0',
-            'releaseTime': '2025-12-10T22:06:17Z',
+            'version': '2.20.1',
+            'releaseTime': '2025-12-16T18:09:59Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',

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
+"

birdhouse/optional-components/scheduler-job-logrotate-nginx/.gitignore

@@ -0,0 +1,2 @@
+config.yml
+nginx.logrotate

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'

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: