Clean up and delete Astronomer Software Deployments

This document explains how to manage the deletion and cleanup of Deployments on your Astronomer Software cluster. You can also set up your platform to Clean up and delete task metadata from Airflow DB.

Delete a Deployment

You can delete an Airflow Deployment using the Delete Deployment button at the bottom of the Deployment’s Settings tab.

When you delete a Deployment, you delete your Airflow webserver, scheduler, metadata database, and deploy history, and you lose any configurations set in the Airflow UI.

By default, Astro performs a soft delete when you delete a Deployment. After you delete a Deployment, your Astronomer database, the corresponding Deployment record receives a deletedAt value and continues to persist until permanently deleted through a hard delete. A hard delete includes both the Deployment’s metadata database and the Deployment entry in your Astronomer database. 14 days after your Deployment’s soft delete, Astronomer automatically runs a hard delete cronjob that deletes any values that remained after your soft delete.

Configure Deployment hard delete jobs

Astronomer runs a cronjob to hard delete the deleted Deployment’s metadata database and Deployment entry in your Astronomer database at midnight on a specified day. You can enable whether this cronjob runs or not, how many days after your soft delete to run the cronjob, and what time of day to run the cronjob by editing astronomer.houston.cleanupDeployments in your Astronomer Helm chart.

The following is an example of how you might configure the cronjob in your Helm chart:

1
# Cleanup deployments that have been soft-deleted
2
  # This clean up runs as a CronJob
3
  cleanupDeployments:
4
    # Enable the clean up CronJob
5
    enabled: true
6
7
    # Default time for the CronJob to run https://crontab.guru/#0_0_*_*_*
8
    schedule: "0 0 * * *"
9
10
    # Number of days after the Deployment deletion to run the CronJob
11
    olderThan: 14

Manually hard delete a Deployment

To reuse a custom release name given to an existing Deployment after a soft delete, but before Astronomer automatically cleans up any persisting Deployment records, you need to hard delete both the Deployment’s metadata database and the Deployment’s entry in your Astronomer database.

1. Enable hard delete as an option at the platform level. To enable this feature, set astronomer.houston.config.deployments.hardDeleteDeployment: true in your config.yaml file and push the changes to your platform as described in Apply a config change.

2. Hard delete a Deployment with the Software UI or Astro CLI.

• Software UI: Go to the Deployment’s Settings tab and select Delete Deployment. Then, select the Hard Delete? checkbox before confirming Delete Deployment.

  

• Astro CLI: Run astro deployment delete --hard.

This action permanently deletes all data associated with a Deployment, including the database and underlying Kubernetes resources.