README.md

CDH Ansible Playbooks

Overview

The overall structure of this repository is as follows:

• playbooks - collections of roles executed in series against a host.
• roles - local Ansible functionality grouped by task
• inventory - hosts and variables
  • all_hosts - host file with hostnames and host groups
  • group_vars - group variables for different hosts and host groups
    • all - variables shared by all playbooks
    • vars.yml- unencrypted all variables
    • vault.yml - ansible vault encrypted variables
• architecture-decisions - list of significant architectural decisions, as markdown files
• docs - documentation about cdh-ansible and specific applications; view as markdown or build with sphinx

Usage instructions

Python environment & dependencies (recommended: uv + pyproject.toml)

This repository uses uv for Python dependency management. (Install uv if you don't already have it.) Dependencies are defined in pyproject.toml and locked in uv.lock.

• The .python-version file is set to the recommended version of Python (uv will use this automatically).
• Create/activate a virtual environment (use uv if you have it, but any tool is fine), then install dependencies:

uv sync

This will install the locked dependencies from uv.lock (and update the environment if pyproject.toml changes).

If you create a local virtualenv in this directory, .venv/ is the default used by our Devbox setup (if you use Devbox).

• Install required Ansible galaxy collections and roles:

  • ansible-galaxy install -r requirements.yml

• The CDH Ansible vault keys are stored in LastPass. You need to be added to the appropriate LastPass share and install lastpass-cli. There are two command-line scripts in the bin/ directory to call lpass to retrieve the vault keys, and the default configuration is set in ansible.cfg. See below for more details on the vault setup.

• A GitHub personal access token for any playbook that uses the create_deployment and close_deployment tasks. You can set this as an environment variable as ANSIBLE_GITHUB_TOKEN or pass it on the command line as -e github_token=. If not specified, a fallback token will be used, which will deploy as the princetoncdh user. When running ansible locally, we recommend setting a personal GitHub token.

Enable pre-commit hooks

If you plan to contribute to this repository, you should install the configured pre-commit hooks. (If you installed python dependencies, pre-commit should already be installed)

pre-commit install

This will add install a pre-commit hook to prevent committing an unencrypted vault or private key file. If new encrypted files are added with different names, filename patterns should be added to the pre-commit configuration in .pre-commit-config.yaml

NOTE: If you have a previous installation with the local pre-commit hook script that was included in this repository, you will need to run pre-commit install -f to replace it.

Running a playbook

To run a playbook, with your python virtual environment activated:

uv run ansible-playbook playbooks/name_of_playbook.yml

Each application has a deploy playbook that can be used to deploy that application to either the production or staging environments. By default, the playbook will deploy to staging. To deploy to production, override the runtime environment with this command line option: -e runtime_env=production

By default, deploying to production will deploy the main branch of the github repository for that application; deploying to staging will deploy the develop branch. These may be overridden by specific applications with different conventions.

To deploy a branch or tag other than the default, you can specify an alternate git reference via -e ref=GITREF where GITREF is the name of the branch, tag, or a commit hash.

The playbook will run, noting success and failures. The -v flag adjusts verbosity (adding more vs will produce more verbosity. Debug tasks are usually written at 2)

Skip setup tasks

By default, initial provisioning and setup tasks are configured to be skipped. Tasks or groups of tasks should be tagged with both setup and never.

To run a playbook without skipping setup tasks, pass the setup and all tags, so untagged tasks and tasks tagged setup run:

uv run ansible-playbook --tags=all,setup playbooks/name_of_playbook.yml

Skip deployment tasks

By default, most playbooks create a GitHub deployment, which is used to track which version of the code is deployed to which environment. Through Slack/GitHub integration, GitHub deployments can be used to notify team members when a deploy is taking place and whether or not it succeeds or fails. (This can be very noisy when working on or troubleshooting a deploy.)

The tasks for creating and closing the GitHub deployment are tagged with gh_deploy. If you want to run a playbook without deploying code, pass --skip-tags gh_deploy.

Pause before finalizing deploy

If you want to pause the playbook before the new version is switched live, there is an optional pause step you can enable using tags. When running normally and skipping setup tasks, run as follows:

uv run ansible-playbook --tags=all,final-pause playbooks/playbook.yml

When running with setup steps enabled:

uv run ansible-playbook --tags=all,setup,final-pause playbooks/playbook.yml

Revert last deploy

To revert to previous deploy run call the revert_deploy playbook with a host_group matching the deploy you want to revert, e.g.:

uv run ansible-playbook -e host_group=shxco_staging playbooks/revert_deploy.yml

Vault password

Ansible vault passwords are stored in shared LastPass vault and loaded using lastpass-cli.

brew install lastpass-cli
lpass login <email@example.com>

For convenience, a local shell script is provided to pull the vault password from lastpass. Due to compatibility issues with Ansible Tower, the ansible vault identity list configuration cannot be set as a default ansible.cfg. For local use, set this environment variable:

ANSIBLE_VAULT_IDENTITY_LIST=default@bin/lpass_default.sh

Some encrypted variables are shared across host groups. As with other variables, these may be overridden in a more specific host group vault file.

Replication

Copying production data from production to staging can be done for some projects using a special replication playbook. It is defined with multiple hosts, but for typical use you should limit to the host group you want to replicate, e.g.:

ansible-playbook playbooks/replicate.yml --limit=geniza

On subsequent runs for the same host group on the same day, to skip regenerating production database dumps and media archive files, you can limit to just the staging host:

ansible-playbook playbooks/replicate.yml --limit=geniza_staging

Currently replication consists of:

• dumping the production database, restoring it to staging, and running django migrations in the current deploy
• update django sites in the database to match the staging environment
• backing up and restoring any user-uploaded media files and setting correct ownership and permissions

Replication does not yet include restoring Solr indexing or support replication to dev environments.

Setting up replication for a new project

• Add the appropriate production and staging host names to the source and destination plays
• Define a new variable replication_source_host in the staging variables; it should reference the corresponding ansible hostname (e.g., for geniza replication_source_host is set to geniza_production)
• If database names differ between staging and production, you may need to override the db_backup_filename for the staging host variables.
• Ensure that the staging host has an application_url variable defined; this is needed to correctly set the Django site entry in the migrated database.

Adding a playbook

Recommended steps for adding a new playbook:

1. Copy over an appropriate playbook for a similar application to use as a starting point, and modify the list of roles as needed.
2. Define separate staging and production host groups for the application.
3. Add the staging host group to the staging group by including them in the list of [staging:children], and create an application group that collects both staging and production host groups.
4. Add new group_vars directories as needed to configure the application or override any defaults. Variables that are relevant for all environments should be set as application group variables; environment-specific configurations can be set in _staging or _production group variables.

Documenting architectural decisions

We use the ADR specification for documenting architectural decisions made over the course of work on this repository - i.e. conventions around our usage of Ansible. Decision documents are stored in the architecture-decisions/ folder as markdown files.

To propose or doucment a new decision, copy the architecture-decisions/template.md file and rename it using a sequential number and description of the decision that needs making. Decisions that require discussion should be proposed using a pull request for discussion and review.

To run the geniza deploy only

• Ensure you have access to the geniza ansible vault key in LastPass
• Install lastpass cli
• Set the following environment variables:

ANSIBLE_VAULT_IDENTITY_LIST=geniza@bin/lpass_geniza.sh
GENIZA_DEPLOY_ONLY=1

Note that you will not be able to run setup tasks or decrypt setup vault secrets.

Devbox (optional)

This repo supports Devbox as an alternative to managing Python/uv and related tooling locally.

1. Install Devbox

Follow Devbox install instructions for your OS.

2. Enter the Devbox shell

devbox shell

On first run, this will:

• create a local .venv (via uv venv) if it does not exist

• install Python dependencies from pyproject.toml / uv.lock (uv sync)

3. Install Ansible Galaxy dependencies

uv run ansible-galaxy install -r requirements.yml

Common commands (from inside devbox shell):

devbox run sync         # uv sync
devbox run lint         # ansible-lint + yamllint
devbox run molecule     # molecule (pass args after)
devbox run pre-commit   # run all pre-commit hooks

Notes:

• The virtualenv is created at .venv/ (not env/venv), and is used automatically inside the Devbox shell.
• You can still use the manual setup instructions below if you prefer not to use Devbox.

Documentation

The docs/ folder includes markdown documentation, but has also been configured to be built with Sphinx.

The main folder is for common documentation; the applications/ folder is for application-specific information about the architecture, deploy process, or any other details worth noting.

To build docs locally, make sure you have necessary the python dependencies. You can do this in advance with uv sync or include the extra option in in the uv run command (uv run --extra docs ...):

uv sync --extra docs

Then you can build the documentation (enable warnings but keep going):

uv run sphinx-build -b html -W --keep-going docs/ docs/_build

For those who use just, a .justfile is provided for convenience (just docs or just clean-docs).

Browse the resulting static html files starting with the main index as your entry point docs/_build/html/index.html. On a Mac, you can view the results in a browser by running: open docs/_build/html/index.html

The sphinx documentation site includes two custom sphinx extensions in docs/_ext:

• inventory_docs.py - parses host inventory in inventory/all_hosts to generate CSVs for tabular display
• role_docs.py - creates a shim collection so cdh-ansible roles can be documented with antsibull-docs; only includes roles with meta/argument_specs.yml

Documentation is automatically built and published on GitHub Pages when updates are pushed to the default branch (main).

A documentation preview is automatically built and published for PRs to main with netlify.

When new role argument_specs.yml files are picked up, they should automatically appear and be added to the role index table of contents. The changed role index file can be checked in.