Deployment runbook#


  1. Check the running DAGs in Airflow to make sure no DAGs are running.


    It is possible to perform a deploy if the image and audio refresh DAGs are running, but only if they are currently waiting on an HttpSensor step. If that is the case, you should pause the DAG, complete the deploy, and then unpause it back.

  2. Visit the Catalog Docker image page and copy the SHA of the image tagged latest.

  3. Release the app via GitHub workflow. Click the “Run workflow” button, choose “catalog” from the dropdown, and supply the SHA identified in the previous step


The catalog only exists in production, so there is no staging deployment. After the app is built and tagged, deploy production:

  1. Checkout the infrastructure repository and bump the catalog version with the just bump prod catalog-airflow command.

  2. Once you’ve verified that no DAGs are running, update the value of running_dags_cleared to true in the production module declaration.

  3. just apply prod catalog-airflow and verify the plan before deploying.

  4. Restore the value of running_dags_cleared back to false.

Post-deployment steps#

  1. Check for any Sentry errors in the maintainer’s #openverse-alerts channel, or in the Sentry UI.

  2. Ensure that Airflow is accessible at

  3. If an Airflow version upgrade was deployed, ensure that the version is correct in the Airflow UI (bottom left of the footer on any page).

  4. Review and Approve the automatically-generated changelog pull request in the repository.

  5. Push up a PR to the infrastructure repository with the Terraform changes you pushed (the version bump for the relevant module).

  6. In the event of errors or problems, repeat the deployment process using the latest stable version of the application. You can find the release version number in the changelogs, and then the tag to pass to the action is the version number prefixed with “rel-”, for example “rel-2023.”.

  7. If anything else goes wrong or service is disrupted, consider this a Production Incident and notify the team.