Deployment runbook#

Tip

For more information on how deployments work, please see the general deployment guide.

  1. Visit https://api-staging.openverse.engineering/version and the API Docker image. Verify that the commit SHA live on the staging site is also tagged with latest in the Docker image. GitHub package directory screenshot

  2. Release the app via GitHub workflow. Click the “Run workflow” button, choose “api” from the dropdown, and supply the SHA identified in step 1.

  3. That’s it! The API will be deployed. You can monitor the deployment in the maintainers #openverse-notifications channel and in the infrastructure repository’s workflow listing.

Post-deployment steps#

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

  2. Visit https://api.openverse.engineering/v1 and verify the SHA is the same as the value you deployed.

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

  4. 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.07.03.17.52.00”.

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