Same-workspace deployment

Updated at:
Copy as MD

DataWorks allows you to add objects such as nodes, functions, resources, and components to a deployment package for batch deployment. This topic describes how to create and deploy a deployment package within a single workspace.

Use case

This feature is only available for workspaces that are in standard mode and use the new version of Data Studio. It allows you to batch deploy objects, such as nodes, functions, resources, and components, from the development environment to the production environment within the same workspace.

Note

For batch deployment in workspaces that are in standard mode and use the legacy Data Studio, see Deploy tasks.

Limitations

Permission limitations

  • Initiate a deployment process: Members with the Workspace Administrator or Development role can start a deployment process in Data Studio.

  • Create a deployment package: Members with the Development role can create a deployment package in the Deployment Center.

  • Deploy a deployment package: Members with the Operator, Deployer, or Workspace Administrator role can deploy a deployment package.

To learn how to add members to a workspace and grant them permissions, see Manage permissions on workspace-level modules.

Environment limitations

  • Only workspaces that are in standard mode and use the new version of Data Studio can use the Deployment Center to batch deploy tasks from the development environment to the production environment within the same workspace.

  • Workspaces in basic mode have only one environment, so you cannot use the Deployment Center for batch deployment within the same workspace. To perform batch deployment, go to Data Studio and use batch operations.

Deployment process

The following figure shows the deployment process within a single workspace.

Publishing workflow diagram

Procedure

Note

This topic describes the batch task deployment process for workspaces that are in standard mode and use the new version of Data Studio. For information about the batch deployment process in workspaces that are in standard mode and use the legacy Data Studio, see Deploy tasks.

Step 1: Initiate deployment

  1. In Data Studio (new), find the node, function, or other object that you want to deploy, and click Deploy on the top toolbar to start the deployment process.

  2. In the deployment process, click Start Production Deployment and wait for the process to reach the Deploy to Production Environment step.

    Note
    • Members with the Workspace Administrator or Development role can start a deployment process in Data Studio.

    • In this example, a user with the Development role creates a deployment process. Only members with the Operator, Deployer, or Workspace Administrator role can deploy to production. Therefore, the Deploy button is unavailable.

    The deployment process consists of five stages: Build Deployment Package, Development Checker, Deploy to Development Environment, Production Checker, and Deploy to Production Environment. The first four stages are complete, and the process is waiting for confirmation at the fifth stage.

Step 2: Create a deployment package

Note

Members with the Development role can create a deployment package in the Deployment Center. If you have the Workspace Administrator role, you do not need to manually create a deployment package. After you select the objects to deploy, you can directly batch deploy them, and the system automatically generates a deployment package.

  1. Log on to the Deployment Center of the source workspace as a member with the Development role.

    You can go to any DataWorks module, click the image icon in the upper-left corner of the page, and then choose All Products > More > Deployment Center to go to the Deployment Center.

  2. In the left-side navigation pane, click Nodes to Deploy to view the objects that are ready for deployment. In the Actions column of the desired object, click Add to Deployment Package. After you add an object, the number of objects to deploy is displayed on the View Deployment Package button.

    Note
    • You can also select multiple objects to deploy and click Batch Add to Deployment Package at the bottom of the page.

    • If you clicked Terminate Deployment in the deployment process in Data Studio, the corresponding objects to deploy are no longer displayed here.

  3. After you add objects to the deployment package, click View Deployment Package to check whether the objects in the deployment package meet your expectations. You can click Remove to remove unwanted objects from the deployment package.

  4. On the Pending Deployment page, click Deployment Package Creation and follow the on-screen instructions to create a deployment package.

    Note

    If you have the Workspace Administrator role, the Deployment Package Creation button is not displayed. Instead, the Deploy All button is displayed, which allows you to directly deploy the objects.

Step 3: Deploy the deployment package

  1. Log on to the Deployment Center as a member with the Operator, Deployer, or Workspace Administrator role.

    You can go to any DataWorks module, click the image icon in the upper-left corner of the page, and then choose All Products > More > Deployment Center to go to the Deployment Center.

  2. In the left-side navigation pane, click Deployment Packages to view the deployment packages that have been created.

  3. In the Actions column of the desired deployment package, click Deploy and follow the on-screen instructions to complete the deployment.

Step 4: View deployment results

  1. After a deployment package is created and deployed, you can go to the Deployment Packages page in the source workspace to view the deployment results.

  2. After the deployment succeeds, click the image icon in the upper-left corner of the page and choose All Products > Data Development and O&M > Operation Center to go to the production environment. Then, go to Auto Triggered Task O&M > Scheduled Tasks to view the deployed scheduled tasks.