You are viewing an outdated version of the documentation.

This documentation is for an older version (1.4.7) of Dagster. You can view the version of this page from our latest release below.

Managing deployments in Dagster Cloud#

This guide is applicable to Dagster Cloud.

In Dagster Cloud, there are two types of deployments:

  • Branch deployments, which are temporary deployments built for testing purposes
  • Full deployments, which are persistent, fully-featured deployments intended to perform actions on a recurring basis

This guide will focus on full deployments, hereafter referred to simply as deployments.


Understanding deployments#

Deployments are standalone environments, allowing you to operate independent instances of Dagster with separately managed permissions.

When a Dagster Cloud organization is created, a single deployment named prod will also be created. To create additional deployments, an Enterprise plan is required.

Each deployment can have one or multiple code locations.

Concerned about testing environments? We recommend using Branch Deployments to test your changes, even if you're able to create additional deployments. Branch deployments are available for all Dagster Cloud users, regardless of plan.

Refer to the Branch Deployment docs for more info, or the Testing against production using Branch Deployments guide for a real-world example.


Viewing and switching deployments#

In Dagster Cloud, you can view and switch between deployments using the deployment switcher:

The deployment switcher in Dagster Cloud

To view all deployments, click View all deployments.


Creating deployments#

Organization Admin permissions are required to create deployments. Additionally, note that creating multiple deployments requires an Enterprise plan.

To create a deployment:

  1. Sign in to your Dagster Cloud account.
  2. Access the Deployments page using one of the following options:
    • Click the deployment switcher > View all deployments.
    • Click your user icon > Cloud Settings > Deployments.
  3. Click the + New deployment button.
  4. In the modal that displays, fill in the following:
    • Name - Enter a name for the deployment.
    • Initial deployment permissions - Select the permissions you want to use to create the deployment:
      • Empty permissions - Creates the deployment with an empty set of permissions. Note: Only Organization Admins will be able to manage the deployment until other uses are granted Admin or Editor permissions.
      • Copy from - Creates the deployment using permissions duplicated from an existing deployment.
  5. When finished, click Create deployment.

Deleting deployments#

Organization Admin permissions are required to delete deployments. Additionally, note that deleting a deployment also deletes all its associated data, including code locations, jobs, schedules, and sensors.

To delete a deployment:

  1. Sign in to your Dagster Cloud account.
  2. Access the Deployments page using one of the following options:
    • Click the deployment switcher > View all deployments.
    • Click the deployment switcher, then the gear icon next to the deployment.
    • Click your user icon > Cloud Settings > Deployments.
  3. Click the Delete button next to the deployment you want to delete.
  4. When prompted, confirm the deletion.

Configuring deployment settings#

Organization Admin permissions are required to modify deployment settings.

Deployment settings can be configured in the Dagster Cloud interface or using the dagster-cloud CLI. Refer to the deployment settings reference for more info about individual settings.

To configure deployment settings in the Dagster Cloud UI:
  1. Sign in to your Dagster Cloud account.
  2. Access the Deployments page using one of the following:
    • Click the deployment switcher > View all deployments.
    • Click the deployment switcher, then the gear icon next to the deployment.
    • Click your user icon > Cloud Settings > Deployments.
  3. Click the Settings button next to the deployment you want to configure.
  4. In the window that displays, configure settings for the deployment.
  5. When finished, click Save deployment settings.