Fix missing delayed eval and allow certbot image override (#495)

## Overview

Generic_bird component missing a delayed eval, found when trying to test
upgrade our stack to post v2.

Also allow to override certbot image and update it at the same time.

## Changes

**Non-breaking changes**
- Fix generic_bird component
- Allow certbot image override and update it to latest

## 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

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.8.1
+current_version = 2.8.2
 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} 2025-01-20T23:37:02Z
+search = {current_version} 2025-01-30T16:43:57Z
 replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ}
 
 [bumpversion:part:releaseTime]
-values = 2025-01-20T23:37:02Z
+values = 2025-01-30T16:43:57Z
 
 [bumpversion:file(version):birdhouse/components/canarie-api/docker_configuration.py.template]
 search = 'version': '{current_version}'

CHANGES.md

@@ -17,6 +17,23 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[2.8.2](https://github.com/bird-house/birdhouse-deploy/tree/2.8.2) (2025-01-30)
+------------------------------------------------------------------------------------------------------------------
+
+## Fixes
+
+- Generic_bird broken because a DELAYED_EVAL is missing
+
+  * Generic_bird consumes `FINCH_IMAGE` which is a delayed eval variable so
+    generic_bird variable should also be a delayed eval variable.
+
+
+## Changes
+
+- Allow to override certbot image in `env.local` to easily test newer version
+  and update to latest version.
+
+
 [2.8.1](https://github.com/bird-house/birdhouse-deploy/tree/2.8.1) (2025-01-20)
 ------------------------------------------------------------------------------------------------------------------
 

Makefile

@@ -1,7 +1,7 @@
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 2.8.1
+override APP_VERSION := 2.8.2
 
 # 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.8.1.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.8.2.svg
     :alt: Commits since latest release
-    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.8.1...master
+    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.8.2...master
 
-.. |latest-version| image:: https://img.shields.io/badge/tag-2.8.1-blue.svg?style=flat
+.. |latest-version| image:: https://img.shields.io/badge/tag-2.8.2-blue.svg?style=flat
     :alt: Latest Tag
-    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.8.1
+    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.8.2
 
 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
     :alt: ReadTheDocs Build Status (latest version)

RELEASE.txt

@@ -1 +1 @@
-2.8.1 2025-01-20T23:37:02Z
+2.8.2 2025-01-30T16:43:57Z

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.8.1',
-            'releaseTime': '2025-01-20T23:37:02Z',
+            'version': '2.8.2',
+            'releaseTime': '2025-01-30T16:43:57Z',
             '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.8.1',
-            'releaseTime': '2025-01-20T23:37:02Z',
+            'version': '2.8.2',
+            'releaseTime': '2025-01-30T16:43:57Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',

birdhouse/default.env

@@ -14,6 +14,7 @@
 # (see also: 'check_default_vars' in 'birdhouse/read-configs.include.sh').
 
 export BASH_IMAGE="bash:5.1.4"
+export CERTBOT_IMAGE="certbot/certbot:v3.1.0"
 
 # Root directory under which all data persistence should be nested under
 export BIRDHOUSE_DATA_PERSIST_ROOT="/data"

birdhouse/deployment/certbotwrapper

@@ -52,7 +52,8 @@ SAVED_PWD="`pwd`"
 
 . "$THIS_DIR/../read-configs.include.sh"
 
-# Get BIRDHOUSE_FQDN_PUBLIC, BIRDHOUSE_FQDN, BIRDHOUSE_SUPPORT_EMAIL, BIRDHOUSE_SSL_CERTIFICATE, BASH_IMAGE.
+# Get BIRDHOUSE_FQDN_PUBLIC, BIRDHOUSE_FQDN, BIRDHOUSE_SUPPORT_EMAIL,
+# BIRDHOUSE_SSL_CERTIFICATE, BASH_IMAGE, CERTBOT_IMAGE.
 read_configs
 
 CERT_DOMAIN="$BIRDHOUSE_FQDN_PUBLIC"
@@ -84,7 +85,7 @@ docker run --rm --name certbot \
   -v "/var/lib/letsencrypt:/var/lib/letsencrypt" \
   -v "/var/log/letsencrypt:/var/log/letsencrypt" \
   -p 443:443 -p 80:80 \
-  certbot/certbot:v1.3.0 \
+  $CERTBOT_IMAGE \
   $CERTBOT_OPTS \
   "$@"
 RC=$?

birdhouse/optional-components/generic_bird/default.env

@@ -19,6 +19,11 @@ OPTIONAL_VARS="
   \$GENERIC_BIRD_INTERNAL_PORT
 "
 
+export DELAYED_EVAL="
+  $DELAYED_EVAL
+  GENERIC_BIRD_IMAGE
+"
+
 # add any component that this component requires to run
 COMPONENT_DEPENDENCIES="
   ./components/wps_outputs-volume

docs/source/conf.py

@@ -69,9 +69,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.8.1'
+version = '2.8.2'
 # The full version, including alpha/beta/rc tags.
-release = '2.8.1'
+release = '2.8.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.