All Products
Search
Document Center

DataWorks:Graceful undeployment

Last Updated:Sep 23, 2024

Data Governance Center provides a complete undeployment solution for invalid tasks or tables that are identified during data governance. The solution supports various features, such as undeployment risk evaluation, undeployment notification push, and undeployment process management. This solution eliminates the need to manually identify undeployment risks. This solution also resolves the issue that you cannot undeploy tasks whose descendant tasks are normally scheduled or cannot determine whether to undeploy tasks due to unforeseeable risks. The solution also allows you to undeploy multiple tasks or tables at the same time. This facilitates centralized management and execution and improves the undeployment efficiency.

Background information

Graceful undeployment supports analysis of undeployment impacts and management of the undeployment process, which are not supported in the traditional undeployment. Task undeployment notifications can be sent to related personnel by using various methods at each phase of the task undeployment process.

No.

Operation

Description

1

Select the objects that you want to undeploy

You can manually specify the objects that you want to undeploy or select the objects that are automatically recommended by the system. You can evaluate the impact scope and risks of the undeployment.

2

Configure undeployment settings

You can manage the entire undeployment process.

  • For example, you can delay or suspend the scheduling of the objects that you want to undeploy. You can also specify a silence period for the delay or suspension step.

    • Delay scheduling: Delay the scheduling time of the objects that you want to undeploy. In this case, you delay the time when the output tables of the objects and their descendant objects are generated.

    • Suspend scheduling: Freeze the objects that you want to undeploy. To freeze the objects, go to the Cycle Task page in Operation Center, find the objects that you want to freeze, and freeze the objects. The objects and their descendant objects no longer generate tables.

  • You can rename the output tables of the objects that you want to undeploy. After the silence period that you specified for the rename step expires, you can undeploy the objects.

Note

Silence period: the duration between the time when the step in the current phase is performed to the time when you can perform the next step. For example, you specify a silence period for the scheduling suspension step of an object that you want to undeploy. In this case, you can undeploy the object only after the silence period expires.

3

Specify the method to execute the undeployment plan

The step in each phase of the undeployment process can be manually or automatically triggered.

4

View and manage the undeployment plan

You can view the details of an undeployment plan and perform various operations on the tasks that are specified in the plan. For example, you can view the details of the tasks, cancel task undeployment, or roll back the undeployment operation.

Limits

  • Only workspace administrators, tenant-level or workspace-level data governance administrators, and O&M personnel can create undeployment plans. For information about how to assign roles to workspace members, see the "Add a RAM user to a workspace as a member and assign roles to the member" section in the Manage permissions on workspace-level services topic.

  • You can add only objects in the same workspace to an undeployment plan.

  • Only Alibaba Cloud accounts, RAM users to which the AliyunDataWorksFullAccess policy is attached, and workspace administrators can perform all operations on an undeployment plan. O&M personnel have all permissions only on the undeployment plans they created. O&M personnel have only read permissions on the undeployment plans that are created by other users. Tenant-level or workspace-level data governance administrators can create, configure, and delete undeployment plans but cannot start or execute tasks on which they do not have permissions.

  • Up to 200 objects can be added to an undeployment plan.

  • The graceful undeployment feature allows you to roll back the operations performed on a task before the undeployment phase of the process, and allows you to roll back the operations performed on a table before the undeployment completion phase of the process.

Precautions

  • You cannot select an object that is already added to an undeployment plan. An object can be added to only one undeployment plan.

  • Specific types of objects cannot be added to an undeployment plan. For example, you cannot add the root node of a workspace to an undeployment plan or add a zero load node that you created for an undeployment plan to the undeployment plan.

  • If an object that you want to undeploy has descendant objects and the scheduling dependencies between the descendant objects and the object are not removed within the specified period of time, the system generates a zero load node and configures the zero load node as the ancestor node of the descendant objects.

  • The operations that you need to perform to create a task undeployment plan vary based on the type of task. You can follow on-screen instructions to create a task undeployment plan for a type of task.

Create an undeployment plan

  1. Go to the Data Governance Center page.

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

    2. In the upper-left corner of the DataStudio page, click the 图标 icon and choose All Products > Data Governance > Data Governance Center.

  2. In the top navigation bar of the Data Governance Center page, click Workbench. The Governance Issue page appears.

  3. In the left-side navigation pane, click Graceful Shutdown.

  4. In the upper part of the Graceful Shutdown page, select the workspace to which the objects that you want to undeploy belong from the Workspace drop-down list. Only the workspaces to which you are added as a member are displayed in the drop-down list.

    To join a workspace, you must contact the administrator of the workspace. For more information, see the "Add a RAM user to a workspace as a member and assign roles to the member" section in the Manage permissions on workspace-level services topic.

  5. On the Graceful Shutdown page, click Create Plan.

    You can also find the tasks that you want to undeploy from the workspace perspective on the Governance Issue page, and click Create Plan in the Actions column of the tasks to go to the Create Plan page.

Select the objects that you want to undeploy

In the To-Be-Undeployed Object section, you can select a task or a table based on your business requirements.

  • Undeploy tasks: Select Add to-be-undeployed Object or Import Based on Lineage to add tasks that you want to undeploy.

  • Undeploy tables: Select only Add to-be-undeployed Object to add tables that you want to undeploy.

Note
  • You cannot select an object that is already added to an undeployment plan. An object can be added to only one undeployment plan.

  • Specific types of objects cannot be added to an undeployment plan. For example, you cannot add the root node of a workspace to an undeployment plan or add a zero load node that you created for an undeployment plan to the undeployment plan.

Configure undeployment settings

After you add the objects that you want to undeploy, you can configure fine-grained settings for the entire undeployment process. The following phases are included: start undeployment, delay scheduling, suspend scheduling, undeploy objects, rename output tables of the objects, remove the output tables, and complete undeployment. You can decide whether to perform the step in a specific phase of the entire undeployment process. If you do not select the check box of a specific phase, you do not need to configure the parameters for this phase and you are redirected to the next phase.

Parameter

Description

Send Notification

The method that is used to send undeployment notifications. Valid values: System Prompt, Email, and DingTalk Chatbot. For information about how to configure a DingTalk chatbot, see the "Scenario practices: Send alert notifications to a DingTalk group" section in the Create a custom alert rule topic.

Note

For information about system prompt messages, go to the Data Governance Center page and click Workbench. In the left-side navigation pane, click Governance Reminder in the To-do List section.

Notification Recipient

The personnel to whom an undeployment notification is sent. The owner of a to-be-undeployed task, the owner of the output table of a to-be-undeployed task, and the owner of the baseline to which a to-be-undeployed task belongs are supported. The valid values of the parameter vary based on the undeployment phase.

Silence Period

The duration between the time when the step in the current phase is performed to the time when you can perform the next step. For example, you specify a silence period for the scheduling suspension step of an object that you want to undeploy. In this case, you can undeploy the object only after the silence period expires.

Specify the method to execute the undeployment plan

You can specify the method to perform the step in each phase of the undeployment plan. The step in each phase can be manually or automatically triggered.

  • Manual trigger: The step in each phase of the undeployment process must be confirmed by the creator of the undeployment plan before the next step can be performed.

  • Automatic trigger: The step in each phase of the undeployment process starts to be performed after the configured silence period expires. Then, you are navigated to the step in the next phase.

View and manage the undeployment plan

On the Graceful Shutdown page, you can view the list of undeployment plans. You can execute, cancel, or delete an undeployment plan.

Note
  • If you cancel an undeployment plan, the system cancels undeployment for tasks that are in the Undeploying state in the undeployment plan. Undeployed tasks are not affected.

  • If you delete an undeployment plan, the system cancels undeployment for tasks that are in the Undeploying state in the undeployment plan. Undeployed tasks are not affected. After the undeployment is canceled, the system deletes the undeployment plan. The deletion operation is irreversible.

You can click Execution Details in the Actions column of a task undeployment plan to view the configuration details of the plan. You can also perform the operations that are described in the following table on a single task that you want to undeploy in the plan.

Operation

Description

View details

You can view the undeployment details of a single task, such as the undeployment progress, task status, and the execution details of each phase. You can also perform various operations on the task, such as canceling undeployment for the task and rolling back the undeployment operation for the task.

  • Cancel undeployment for a single task: You can cancel the unfinished steps of the task undeployment process for the task.

  • Roll back the undeployment operation for a single task: You can roll back all undeployment steps for the task to the initial states. You cannot roll back a single step for the task.

    Note
    • If an undeployment plan is canceled, the rollback operation is not supported.

    • If a substep of the step in the current phase is being performed, the rollback operation is not supported.

    • You cannot roll back the operations performed on a task after the undeployment phase of the process. You cannot roll back the operations performed on an object (task or table) after the undeployment completion phase of the process.

Go to Operation Center

You can go to the Operation Center in the production environment to view the O&M details of the task.

Go to the configuration tab of the task

You can go to the configuration tab of the task in DataStudio to modify the task.