Skip to content

Updating HMS-Docker

To easily update from this git repo and update your custom variable names (due to deprecating/renaming variables) if you are on a previous release, run:

Terminal window
make update

Previous variable names will still work for at least a year after the change. While any are still in use, the playbook lists them in a warning at the start of each run. Please update to resolve.

make update renames the variables in your inventory/group_vars/all/*.yml files, including where one variable is used in the value of another ({{ ... }}). The full list of renames is in migrations/variable_renames.yml. To only rename the variables and merge new container map entries, without pulling, run make migrate-config.

If any new containers or container controls were added since you last updated, your container_map.yml file will also be updated with the defaults for the new container(s) and controls. The defaults come from the version of the code you just pulled, so they always match what you are about to apply.

The repo has two long-lived branches:

Branch Channel What it contains
master Stable (default) Only released versions. It only changes when a new release is published.
develop Development Every merged change, including ones that are not in a release yet. Can be unstable.

make update pulls whichever branch you currently have checked out, so a normal clone stays on stable releases.

To try changes before they are released, switch to develop:

Terminal window
make switch-develop

To go back to stable releases:

Terminal window
make switch-stable

Both commands switch branches and run make update for you. Local edits such as inventory/hosts.yml are kept; if an edited file also changed between the branches, git refuses and you need to commit or stash it first. To see which branch you are on, run make branch.

Please see the Release Notes if you are updating from a previous version.