Skip to content

Commit

Permalink
minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mishaschwartz committed Mar 1, 2024
1 parent 9dd002c commit 06e9997
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 8 deletions.
1 change: 1 addition & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ ci/deployment:
- vagrant_variables.yml.example
- Vagrantfile
- birdhouse/**/*.include.sh
- birdhouse/pavics-compose.sh
- birdhouse/birdhouse-compose.sh

ci/tests:
Expand Down
13 changes: 8 additions & 5 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,22 @@

This update makes the following changes:

* The string ``"PAVICS"`` in environment variables, constant values, and file names have been changed to
``"BIRDHOUSE"`` (case has been preserved where possible).
* The string ``PAVICS`` in environment variables, constant values, and file names have been changed to
``BIRDHOUSE`` (case has been preserved where possible).
* For example:
* ``PAVICS_FQDN`` -> ``BIRDHOUSE_FQDN``
* ``pavics_compose.sh`` -> ``birdhouse_compose.sh``
* ``THREDDS_DATASET_LOCATION_ON_CONTAINER='/pavics-ncml'`` -> ``THREDDS_DATASET_LOCATION_ON_CONTAINER='/birdhouse-ncml'``
* Comment strings and documentation that refers to the software stack as ``PAVICS`` have been changed to use
``Birdhouse``.
* Recreated the ``pavics-compose.sh`` script that runs ``birdhouse-compose.sh`` in backwards compatible mode.
* Backwards compatible mode means that variables in ``env.local`` that contain the string ``"PAVICS"`` will be used
to set the equivalent variable that contains ``"BIRDHOUSE"``. For example, the ``PAVICS_FQDN`` variable set in
* Backwards compatible mode means that variables in ``env.local`` that contain the string ``PAVICS`` will be used
to set the equivalent variable that contains ``BIRDHOUSE``. For example, the ``PAVICS_FQDN`` variable set in
the ``env.local`` file will be used to set the value of ``BIRDHOUSE_FQDN``.

Migration Guide:

- Update ``env.local`` file to replace all variables that contain ``"PAVICS"`` with ``"BIRDHOUSE"``.
- Update ``env.local`` file to replace all variables that contain ``PAVICS`` with ``BIRDHOUSE``.
* see [`env.local.example`](./birdhouse/env.local.example) to see new variable names
* see the ``BACKWARDS_COMPATIBLE_VARIABLES_PAVICS`` variable (defined in
[`default.env`](./birdhouse/default.env)) for a full list of changed environment variable names.
Expand All @@ -67,6 +67,9 @@
| JUPYTERHUB_IMAGE_SELECTION_NAMES | (no change) | pavics | birdhouse |
| PAVICS_LOG_DIR | BIRDHOUSE_LOG_DIR | /var/log/PAVICS | /var/log/birdhouse |

- update any jupyter notebooks that make use of the `PAVICS_HOST_URL` environment variable to use the new
`BIRDHOUSE_HOST_URL` instead.


[2.1.0](https://github.com/bird-house/birdhouse-deploy/tree/2.1.0) (2024-02-23)
------------------------------------------------------------------------------------------------------------------
Expand Down
1 change: 0 additions & 1 deletion birdhouse/pavics-compose.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/sh

# we switch to the real directory of the script, so it still works when used from $PATH
THIS_FILE="$(readlink -f "$0" || realpath "$0")"
THIS_DIR="$(dirname "${THIS_FILE}")"

Expand Down
2 changes: 1 addition & 1 deletion birdhouse/read-configs.include.sh
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ check_default_vars() {
result=`echo "${d}" | grep -c "${default}"`
if [ -z "`eval "echo ${v}"`" ]
then
log DEBUG "Optional variable [${n}] is not set. Check env.local file."
log WARN "Optional variable [${n}] is not set. Check env.local file."
fi
if [ "${result}" -gt 0 ]
then
Expand Down
2 changes: 1 addition & 1 deletion vagrant_variables.yml.example
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# extra DNS entry and also set it manually in your
# /etc/hosts file.
hostname: mybirdhouse
domain: example.ca
domain: example.com

# Set network bridge, else you'll simply be prompted on vagrant up.
# network_bridge: enp0s25
Expand Down

0 comments on commit 06e9997

Please sign in to comment.