Creating environments

Before you can run a deployment, you must define at least one application environment that associates components with an agent on the target host.

Before you begin

Ensure that you have at least one base resource to associate with the new environment. See Mapping resources and components to environments.

Some of the configuration options might be resticted based on the role assigned to you. Check with your administator, if you need a specific option enabled.

About this task

The initial environment is typically uncontrolled and often is used to create snapshots. You create an environment for each location to which you deploy an application.

Create environments as follows:


  1. Click Applications, click your application's name, and click Create Environment.
    The Create Environment dialog box opens.
  2. Specify the environment name.
    The name is used as part of the deployment process and typically corresponds to the target environment.
    If you deploy to an integration environment, you might name the environment SIT.
  3. Optional: Provide the following information:
    1. Specify a description.
    2. Assign teams to the environment and set its security type. Click Add Team, select values from the Team and Type lists, and click Add.
    3. Enable the Show Compliancy on Load option to load the environment's compliancy automatically on the application environment page.
      If disabled, the Load Compliancy option will still be available that allows you to load the environment's compliancy on demand.
    4. If you created the application from an application template, in the Environment Template list, select the environment template to use for the environment.
      You can assign any security type to this environment.
    5. To ensure that components cannot be deployed to the environment without first being approved, specify the Deployment Approvals information. If specified, Deploy enforces an approval process before the deployment can be deployed to the environment. Initial deployments are typically done in uncontrolled environments. After the deployment works as designed, you can configure an approval process as the application moves along the development pipeline. If you are setting up more than one environment, consider creating an approval process for at least one of them.
      You can apply two types of approvals to an environment, that is, external and manual approvals.
      • Specify a Resource Type to Run External Approval. You can select System Default for the values specified in the system settings, an Agent Pool to specify a group of agents, or an Agent.
      • Choose an existing External Approval Process to run. See Managing external approval processes for information about how external approval processes are created.
      • You can Exempt Processes from approvals even if it is required by an environment.
      • Enable Require Manual Approvals to allow approvals from users in a role specified by the approval process created for the environment. See Creating an approval process for information about how manual approval processes are created. To prohibit the user who makes an approval request from approving the same request, select No Self-Approvals.
    6. To prevent changes to snapshots in this environment after you deploy them, select the Lock Snapshots check box.
    7. If you selected the Lock Snapshots check box, from the Snapshot Lock Type list, select the lock type:
      • To lock only component versions, select Only Component Versions.
      • To lock snapshot configurations, select Only Configuration.
      • To lock both component versions and configurations, select Component Versions and Configuration.
      • To use the system default value, select System Default. The default value is determined by the Default Snapshot Lock Type field on the System Settings page. For information about system settings, see System settings.
    8. Select Require Snapshot to require that snapshots are deployed to the environment.
      When this option is selected, only snapshots can be deployed to the environment.
    9. Select a color to apply to the environment. Default is Bright Cerulean (Blue).
    10. To apply the component version and snapshot cleanup settings that are specified on the System Settings page, select the Use Default Artifact Cleanup Settings check box.
      If this check box is cleared, you must specify how long to keep snapshots and component versions. For more information about cleaning up snapshots, see Cleaning up snapshots.

      To apply the component version cleanup settings that are specified on the System Settings page, select the Use Default Artifact Cleanup Settings check box. If this check box is cleared, you must specify how long to keep component versions. For more information about cleaning up component versions, see Cleaning up component versions.

    11. To use deployment history cleanup, select Use Deloyment History Retention.
      You can use the default settings that are specified on the Systems Settings page by clicking Use Default Deployment History Retention, or in Days to Retain Deployment History you can specify a number of days to retain deployment history records.
  4. Click Save or Next.
  5. Click Create to submit the request.


The new environment is displayed in the Environments pane.
Note: An environment template cannot be deleted if it is being used by an environment.