All Products
Search
Document Center

DataWorks:Create and manage deployment environments

Last Updated:Dec 10, 2024

Deploy Center allows you to deploy objects, such as nodes, functions, resources, and script templates, to different workspaces in basic mode in the same region under the same Alibaba Cloud account. For example, you can deploy objects in a workspace in basic mode that serves as the development environment to another workspace in basic mode that serves as the production environment. Deploy Center also allows you to deploy the objects across accounts, regions, or cloud platforms such as Alibaba Finance Cloud and Alibaba Gov Cloud. Before you create a deployment package, you must create a deployment environment. This topic describes how to create and manage a deployment environment.

Limits

Only members who are assigned the Workspace Administrator role can create and manage a deployment environment. If you want to create a deployment environment, your account must be a member of the desired workspace and assigned the Workspace Administrator role. For more information, see the Add a RAM user to a workspace as a member and assign roles to the member section of the "Manage permissions on workspace-level services" topic.

Go to the Deploy Center page

  1. Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Development and Governance > Data Development. On the page that appears, select the desired workspace from the drop-down list and click Go to Data Development.

  2. In the top navigation bar, click the image icon and choose All Products > More > Deploy Center.

    Note

    For a node in a workspace in standard mode, you can deploy the node on the deployment page that automatically appears after you commit the node on the DataStudio page. To deploy tasks in the development environment of a workspace in standard mode to the production environment of the workspace, you must click the Deploy icon on the configuration tab of the task. Deploy Center does not allow you to deploy tasks in the development environment of a workspace in standard mode to the production environment of the workspace.

Create a deployment environment

On the Deploy Center page, you can create a cross-workspace or cross-cloud deployment environment based on your business requirements. To create a deployment environment, perform the following steps:

  1. In the left-side navigation pane of the Deploy Center page, click Deployment Environment Management.

  2. On the Deployment Environment Management page, click Create Deployment Environment. In the Create Deployment Environment dialog box, configure the parameters.

    1. Configure the basic information about the deployment environment.

      Parameter

      Description

      Environment Name

      The name of the deployment environment.

      Deployment Type

      The type of the deployment environment. Valid values:

      • Cross-workspace Deployment: corresponds to the original cross-workspace cloning feature. This type of deployment environment is used in scenarios in which nodes need to be deployed across different workspaces that belong to the same Alibaba Cloud account and region.

        If you want to batch deploy nodes in a workspace in basic mode that serves as the development environment to another workspace in basic mode that serves as the production environment, you can set this parameter to Cross-workspace Deployment. This way, you do not need to repeatedly create deployment environments. For more information, see Deploy nodes.

      • Cross-cloud Deployment: This type of deployment environment is used to clone and migrate nodes across accounts, regions, or cloud platforms such as Alibaba Finance Cloud and Alibaba Gov Cloud.

      Destination Workspace

      The workspace for which you want to create a deployment environment.

      • If you set the Deployment Type parameter to Cross-workspace Deployment, select the workspace to which the current logon account is added as a member.

        Note

        For information about how to add a user to a workspace as a member, see the Add a RAM user to a workspace as a member and assign roles to the member section of the "Manage permissions on workspace-level services" topic.

      • If you set the Deployment Type parameter to Cross-cloud Deployment, enter the name of the destination workspace in the field.

        Note

      Deployment Object Owner

      The owner of each node in a deployment package in the destination workspace. This parameter is available only if you set the Deployment Type parameter to Cross-workspace Deployment.

      Valid values:

      • Default: After a deployment package is deployed, the node owner in the source workspace is preferentially specified as the node owner in the destination workspace. If the node owner in the source workspace is not added to the destination workspace as a member, the user who deploys the deployment package is specified as the node owner in the destination workspace.

      • Deployment Package Creator: After a deployment package is deployed, the user who creates the deployment package is specified as the node owner in the destination workspace.

      • Deployment Package Executor: After a deployment package is deployed, the user who deploys the deployment package is specified as the node owner in the destination workspace.

    2. Configure mappings between compute engine instances.

      In the Compute Engine Instance Mappings section, configure mappings between compute engine instances in the source workspace and compute engine instances in the destination workspace. After you configure a mapping, when you deploy a task, the system associates the nodes, resources, functions, and script templates of the source compute engine instance with the destination compute engine instance. The configurations of the destination engine instance are the same as the configurations of the source engine instance.

      Note
      • In the Compute Engine Instance Mappings section, you must retain at least one source compute engine instance and configure a mapping between the source compute engine instance and a destination compute engine instance.

      • You can determine whether to map a source compute engine instance to a destination workspace based on your business requirements.

      Parameter

      Description

      Compute Engine Instance in Source Workspace

      The compute engine instances that are associated with DataStudio in the source workspace.

      Compute Engine Type

      The type of the compute engine.

      Compute Engine Instance in Destination Workspace

      The destination compute engine instances that you want to map to the source compute engine instances.

      To view information about a compute engine instance, go to the Deployment Environment Management page in Deploy Center. Then, click View Workspace Environment Information in the upper-right corner of the page. For information about how to go to the Deployment Environment Management page, see Step 1 in this section.

      Ignore Mapping

      If you turn on this switch, no destination compute engine instance is mapped to the source compute engine instance. In this case, the nodes, resources, functions, and script templates of the source compute engine instance are not deployed.

      If you do not want to deploy the nodes, resources, functions, and script templates of the source compute engine instance, you can turn on Ignore Mapping.

    3. Configure mappings between resource groups.

      In the Resource Group Mappings section, configure mappings between the resource groups in the source workspace and the resource groups in the destination workspace. After you configure a mapping, the system uses the destination resource group to run a task when you deploy the task.

      Note
      • DataWorks allows you to configure only mappings between resource groups of the same type.

      • When you configure a mapping between resource groups for Data Integration, make sure that the configurations of the destination resource group for Data Integration, such as the whitelist and network connectivity, are the same as the configurations of the source resource group for Data Integration. Otherwise, Data Integration tasks may be affected. For information about how to establish network connections between a resource group for Data Integration and a data source, see Network connectivity solutions.

      Parameter

      Description

      Resource Group in Source Workspace

      The resource groups that are associated with the source workspace.

      Resource Group Type

      The type of the resource group.

      Resource Group in Destination Workspace

      The destination resource groups that you want to map to the source resource groups.

      To view information about a resource group, go to the Deployment Environment Management page in Deploy Center. Then, click View Workspace Environment Information in the upper-right corner. For information about how to go to the Deployment Environment Management page, see Step 1 in this section.

      Note

      This parameter is available only if you set the Deployment Type parameter to Cross-workspace Deployment.

      Unique Resource Group Identifier in Destination Workspace

      The IDs of the destination resource groups that you want to map to the source resource groups.

      To view information about a resource group, go to the Deployment Environment Management page in Deploy Center. Then, click View Workspace Environment Information in the upper-right corner. For information about how to go to the Deployment Environment Management page, see Step 1 in this section.

      Note

      This parameter is available only if you set the Deployment Type parameter to Cross-cloud Deployment.

      Ignore Mapping

      If you turn on this switch, no destination resource group is mapped to the source resource group. The source resource group is used to deploy tasks.

      Note

      The Ignore Mapping parameter is not available for default resource groups and shared resource groups.

      If the number of resource groups in the source workspace exceeds the number of resource groups in the destination workspace, you can turn on Ignore Mapping for additional source resource groups. If you turn on this switch, the source resource group is used to deploy tasks.

    4. Configure dependency mappings.

      The Dependency Mappings section displays the names of the upstream projects for all cross-project dependencies in the source workspace. You can configure a mapping between a source project and a destination project. After you configure a dependency mapping, the system configures the destination project as the upstream project of the corresponding objects in the destination workspace. This way, new dependencies are generated. For information about the dependencies during node cloning, see the Deployment logic section of the "Overview" topic.

      Note
      • The information in the Dependency Mappings section is automatically updated with a delay of one day. If you want to view the latest dependencies, click Refresh Dependencies.

      • If you configure a dependency mapping between projects, DataWorks modifies the node dependencies based on the mapping. Make sure that you can add dependencies to the destination workspace. For information about how to resolve the issue that you cannot add dependencies to the destination workspace, see When I commit Node A, the system reports an error that the output name of the dependent ancestor node of Node A does not exist. What do I do?

      • After you configure dependency mappings for a task of the MaxCompute engine type, such as an ODPS SQL or ODPS Spark task, the system automatically modifies the code of the task. For more information, see the Deployment logic section of the "Overview" topic.

      Parameter

      Description

      Source Project Name

      The names of the upstream projects for all cross-project dependencies in the source workspace.

      Property

      The project category.

      Destination Project Name

      The destination project that you want to map to the source project.

      Ignore Mapping

      If you turn on this switch, the system ignores the mapping between the source project and the destination project. The dependencies of the corresponding nodes remain unchanged in the destination workspace.

    5. Configure mappings between data sources.

      In the Data Source Mappings section, configure mappings between source data sources and destination data sources. After you configure mappings, the destination data sources are used during task deployment.

      Note

      You must configure mappings between data sources only if you set the Deployment Type parameter to Cross-workspace Deployment.

      Parameter

      Description

      Source Name

      The data sources in the source workspace.

      Data Source Type

      The type of the data source.

      Destination Name

      The destination data sources that you want to map to the source data sources.

      Ignore Mapping

      If you turn on the switch, the source data source is not mapped to a destination data source when you deploy tasks.

    6. Configure parameter mappings.

      In the Parameter Mappings section, configure parameters for the destination workspace. After you configure the parameters, the system references the workflow parameters and scheduling parameters in the destination workspace when you deploy tasks. You can configure parameters for the destination workspace on the visualized UI or by using expressions. For more information, see Supported formats of scheduling parameters.

      Note

      Make sure that the parameter names are unique in each deployment task. Do not assign the same values to a parameter in different tasks.

    7. In the Remarks section, enter the description for the deployment environment.

  3. Click Create.

Manage deployment environments

The Deployment Environment Management page displays the created deployment environments. You can view information about a deployment environment, such as the environment name, status, and creator. 管理发布环境You can also perform the following operations on a deployment environment:

  • View Details: View the configurations of the deployment environment.

  • Modify: Modify the configurations of the deployment environment.

  • Clone: Generate a deployment environment that has the same configurations as the current environment.

  • Disable: Disable the deployment environment if you do not require the deployment environment. After you disable the deployment environment, developers can no longer package and deploy nodes based on the deployment environment on the Deployment Package Creation page.

  • Enable: Enable the disabled deployment environment.

  • Delete: Delete the deployment environment that you no longer require.

    Note

    After you delete a deployment environment, it cannot be restored. Proceed with caution.

What to do next

After you create a deployment environment, you can go to the Deployment Package Creation page to create a deployment package. For more information, see Create a deployment package to deploy objects in the deployment package across workspaces and Create a deployment package to deploy objects in the deployment package across clouds.