Skip to main content

Deployment details

Deployment details define how users can view and interact with your Deployment. They include metadata settings, observability settings, and user access settings.

Update a Deployment name and description

  1. In the Astro UI, select a Workspace, click Deployments, and then select a Deployment.

  2. Click the Options menu of the Deployment you want to update, and select Edit Deployment.

    Edit Deployment in options menu
  3. In the Basic section, update the Deployment Name or Description.

  4. Click Update Deployment.

Configure Deployment contact emails

Configure a contact email to get proactive alerts directly from Astronomer support. Astronomer support uses contact emails to notify recipients in case there's an issue with the infrastructure for your Deployment, such as a problem with your scheduler or worker components.

  1. In the Astro UI, select a Workspace, click Deployments, and then select a Deployment.

  2. Click the Details tab. In the Advanced menu, click Edit.

  3. To add an alert email:

    • In the Contact Emails section, click Add Email.
    • Enter an email address and then click Add.
  4. To delete an alert email address:

    • In the Contact Emails section, click Delete next to the email you want to delete.
    • Click Yes, Continue.

In addition to alert emails for your Deployments, Astronomer recommends configuring Astro alerts and subscribing to the Astro status page. When you subscribe to the status page, you'll receive email notifications about system-wide incidents as they happen.

Enforce CI/CD deploys

This feature is available only if you are on the Business tier or above.

By default, any user can deploy code either directly from the Astro CLI or from a CI/CD process that is authenticated with an API token. To help your team protect production environments from manual code deploys that circumvent your organization's CI/CD processes and checks, you can configure a Deployment so that users can't deploy code manually using the Astro CLI.

After you enable CI/CD enforcement on a Deployment, the Deployment accepts a deploy only if the deploy is authenticated using a Deployment API token, Workspace API token, or Organization API token. Astronomer recommends enabling this setting for all production environments.

  1. In the Astro UI, select a Workspace, click Deployments, and then select a Deployment.

  2. Click the Options menu of the Deployment you want to update, and select Edit Deployment.

    Edit Deployment in options menu
  3. In the Advanced section, find CI/CD Enforcement and click the toggle to On.

You can also update your Workspace so that any new Deployments in the Workspace enforce CI/CD deploys by default. See Update general Workspace settings.

info

When CI/CD enforcement is enabled for a Deployment, you cannot enable or disable DAG-only deploys for the Deployment.

To enable or disable DAG-only deploys when CI/CD enforcement is turned on:

  1. Turn CI/CD Enforcement to Off.
  2. Enable or disable the DAG-only deploy feature. See Enable or disable DAG-only deploys.
  3. Turn CI/CD Enforcememt back to On.

You have to only complete these steps once. Once the DAG-only deploy feature is enabled or disabled, you can turn CI/CD enforcement on or off at any time.

Delete a Deployment

When you delete a Deployment, all infrastructure resources assigned to the Deployment are immediately deleted. However, the Kubernetes namespace and metadata database for the Deployment are retained for 30 days. Deleted Deployments can't be restored. If you accidentally delete a Deployment, contact Astronomer support.

  1. In the Astro UI, select a Workspace, click Deployments, and then select a Deployment.

  2. Click the Options menu of the Deployment you want to delete, and select Delete Deployment.

    Delete Deployment in options menu
  3. Enter Delete and click Yes, Continue.

Was this page helpful?

Sign up for Developer Updates

Get a summary of new Astro features once a month.

You can unsubscribe at any time.
By proceeding you agree to our Privacy Policy, our Website Terms and to receive emails from Astronomer.