What's my plan?
All Suites Growth, Professional, Enterprise, or Enterprise Plus
Support Professional or Enterprise
Location: Admin Center > Account > Configuration management > Deployments
Deploying your account configurations is currently part of an early access program (EAP). At this time deploys are only supported from production to sandbox environments. You can sign up for the Configuration Management EAP here.

Configuration management deployments make it possible for you to create, update, and test configurations in one environment and then implement them identically in another environment without the inherent risks of manually recreating them. It also provides a way to update sandbox environments to reflect changes to your production environment rather than having to delete the sandbox and recreate it.

This article contains the following topics:
  • Deploying configurations
  • Monitoring the status of deployments
  • Managing deployments
Note: This functionality is replacing the business rule deployment, which supported deployments from sandboxes to production only.

Deploying configurations

Configuration management deployments are based on configuration snapshots, which you can think of as a read-only versions of an environment's configurations at a given time. When you deploy configurations, you select the snapshot you want to deploy, which of the configurations from that snapshot to deploy, and the target environment it will be deployed to.

Deploying configurations consists of three primary steps:
  1. Save a snapshot of the environment with the configuration you want to deploy.
  2. Create the deployment.
  3. Select the configuration and deploy it.

Creating a deployment

The first step to deploying a configuration is creating the deployment itself. The deployment consists of a saved snapshot you want to deploy a configuration from and the destination environment to which the configuration will be deployed. This preliminary information allows for the comparisons necessary to identify and resolve any dependencies or conflicts between the snapshot and destination prior to deploying the configuration.

To create a deployment
  1. In Admin Center, click Account in the sidebar, then select Configuration management > Deployments.
  2. Click Create deployment.
  3. In the Create new deployment dialog, do the following:
    • Name: Enter a unique name for the deployment.
    • Source: Select the saved snapshot of the configurations you want to deploy.
    • Destination: Select the environment to which you want to deploy the configuration.
    Note: Currently, deployments are supported only from production environments to sandboxes. That means the Source must be a snapshot of your production environment and the Destination must be a sandbox.
  4. Click Create.

Deploying a configuration

After the deployment is created, you must specify which configuration you want to deploy. Zendesk automatically compares the selected configuration to the destination, including any dependencies or conflicts that must be resolved prior to performing the deploy.

To deploy a configuration
  1. In Admin Center, click Account in the sidebar, then select Configuration management > Deployments.
  2. Click the name of the deployment.
  3. In the Source column of the page, select at least one Configuration you want to deploy along with any dependencies it has that also need to be deployed with it.
  4. Review the changes that would be made to the production environment. Optionally, you can click Refresh under the Destination to ensure the latest updates in the destination environment are reflected in the comparison.
  5. (Optional) Click Save.

    This saves the selected configurations and dependencies, but still allows you to make changes to the deployment.

  6. Click Test deploy.

    This can take up to several minutes. When the test is complete, you will either see that it passed or be notified of missing dependencies. If the test fails, select the missing dependencies and run the test again.

    • If missing dependencies are found, click Cancel to select the dependency and resolve them or click Ignore to proceed without resolving the missing dependency.
    Note: After the test passes, no changes can be made to the configurations selected in the deployment.
  7. Click Deploy.

    When a deploy begins, Zendesk saves a version of the destination environment before making any changes. This ensures you can revert a deploy if necessary.

Monitoring the status of deployments

From the deployments page, you can view your deployment history. The list includes each deployment, along with its source, destination, status, and last updated date. The following statuses are possible:
  • Draft: The deployment has been created, but not deployed. This includes testing the deployment.
  • Deploying: The deployment has been initiated and is in progress.
  • Deployed: The deployment succeeded.
  • Failed: The deployment failed.

Managing deployments

After you create a deployment, it's visible in the list on the Deployments page.

To manage a deployment
  1. In Admin Center, click Account in the sidebar, then select Configuration management > Deployments.
  2. Next to the deployment you want to manage, click the menu icon () and select one of the available options.
    The options available for each deployment depends on its status.
    • Deployments with a status of Draft have the options to:
      • View
      • Rename
      • View source
      • View destination
      • Delete
    • Deployments with a status of Deploying have the options to:
      • View
      • Rename
      • View source
      • View destination
    • Deployments that Deployed or Failed have the options to:
      • View
      • Rename
      • View source
      • View destination
      • Revert
      • Redeploy
Powered by Zendesk