All Products
Search
Document Center

DataWorks:Create and manage workspaces

Last Updated:Sep 01, 2023

You can create, delete, and disable workspaces in the DataWorks console. On the Workspace page in SettingCenter, you can manage and configure the properties of a specific workspace and associate compute engines, such as MaxCompute projects and E-MapReduce (EMR) clusters, with a workspace for data development. This topic describes the basic operations that you can perform on a workspace.

Background information

The following table describes the operations that you can perform on a workspace and the entry points for the operations.

Operation

Description

Entry point

Create a workspace

A workspace is the basic unit in which you can manage nodes and members, assign roles, and grant permissions. All nodes are developed in specific workspaces.

DataWorks console

Delete or disable a workspace

If you no longer need to use a workspace, you can delete or disable the workspace.

  • If you delete a workspace, the code in the workspace is also deleted.

  • If you disable a workspace, the code in the workspace is retained but the workspace becomes unavailable.

Manage compute engines that are associated with a workspace

You can associate multiple types of compute engines, such as MaxCompute, E-MapReduce (EMR), and Realtime Compute for Apache Flink compute engines, with a workspace. Then, you can use the compute engines as compute engine instances of the workspace to configure and schedule nodes in the workspace, and manage the data that is stored in the compute engines.

SettingCenter

View and modify the configurations of a workspace

After you create a workspace, you can view and modify the configurations of the workspace.

Add members, assign roles, and view permissions

During data development, you need to add RAM users to a workspace as members and assign roles such as Workspace Administrator, Development, O&M, and Visitor to the members to implement collaborative data development.

Members who are assigned different roles have different permissions on DataWorks services. If built-in workspace-level roles cannot meet your business requirements, you can create custom roles.

Limits

  • Only an Alibaba Cloud account and RAM users to which the AliyunDataWorksFullAccess policy is attached can perform operations in the DataWorks console.

  • Only users who are assigned the Workspace Administrator role can perform operations on the Workspace page in SettingCenter.

Create a workspace

A workspace is the basic unit in which you can manage nodes and members, assign roles, and grant permissions. All nodes are developed in specific workspaces. Before you develop nodes, you must create a workspace. For more information about how to create a workspace, see Create a workspace.

Manage workspaces

You can go to SettingCenter and perform the following operations on a specific workspace on the Workspace page.

View and modify basic information about the workspace

  • In the Basic Properties section of the Basic Settings tab, you can view and modify basic information about the workspace.

    Parameter

    Description

    Workspace ID

    The unique identifier and name of the workspace. You cannot change the values of the parameters after a workspace is created.

    Workspace Name

    Status

    The status of the workspace. Valid values: Normal, Deleted, Initializing, Initialization Failed, Manual Disable, Deleting, Deletion Failed, Suspended (Overdue), Updating, and Update Failed.

    Note
    • If a workspace fails to be created, the workspace enters the Initialization Failed state. In this case, you can recreate the workspace.

    • A workspace administrator can disable a workspace that is in the Normal state. After the workspace is disabled, all features in the workspace cannot be used but data in the workspace is retained. Instances that are generated and scheduled to run on the current day are automatically run at their scheduling time. The instances are not automatically scheduled on the next day, and you cannot access the workspace to view information about the instances.

    • A workspace administrator can click Enable in the Actions column of a disabled workspace on the Workspaces page to recover the workspace to the Normal state.

    Display Name

    The display name of the workspace. You can use an account that is assigned the Workspace Administrator role to modify the display name.

    Mode

    The mode of the workspace. Valid values: Basic Mode and Standard Mode.

    Note
    • The configurations of a DataWorks workspace vary based on the mode of the DataWorks workspace. You must configure the parameters for the production and development environments of a DataWorks workspace that is in standard mode.

    • For a DataWorks workspace in basic mode, you can log on to the DataWorks console with an Alibaba Cloud account and upgrade the workspace from basic mode to standard mode. You can perform the upgrade operation only by using an Alibaba Cloud account. For more information, see Scenario: Upgrade a workspace from the basic mode to the standard mode.

    Owner

    The owner of the workspace. You cannot change the value of this parameter after a workspace is created. The owner of a workspace has the permissions to delete and disable the workspace.

  • In the Security Settings section of the Basic Settings tab, you can configure security settings for the workspace. The following table describes the parameters.

    Parameter

    Description

    Download SELECT Result

    Specifies whether the query results that are returned by SELECT statements in DataStudio can be downloaded. If you turn off this switch, the query results cannot be downloaded.

    Note

    Only a workspace administrator has the permissions to turn on or off this switch for a workspace.

    Change Node Owner By RAM User

    Specifies whether RAM users can be used to change the owners of their nodes.

    Sandbox Whitelist (The Whitelist Contains IP Addresses Or Domain Names That Can Be Accessed By Shell Nodes.)

    The IP addresses or domain names that can be accessed by a Shell node that runs on the shared resource group.

    Note

    You must specify public IP addresses or domain names that are accessible. For internal services, we recommend that you use exclusive resource groups to ensure network accessibility. For more information, see Exclusive resource group mode.

Manage workspace members and roles

On the Workspace Members tab, you can add RAM users to the current workspace as members, remove members from the current workspace, and assign roles to members. On the Workspace Roles tab, you can view and manage roles in the current workspace.

  1. Add a workspace member

    You can add a RAM user to the current workspace as a member and assign workspace-level roles to the member. This way, the member has all permissions of the workspace-level roles. For more information, see Add a RAM user to a workspace as a member and assign roles to the member.

    Note

    You can assign workspace-level custom roles or built-in roles to RAM users. Workspace-level custom roles can be created only by the workspace administrator on the Workspace Roles tab. Users who are assigned different roles have different permissions on workspace-level services. For more information, see Manage permissions on workspace-level services.

  2. Manage member roles

    You can view built-in or custom roles in the current workspace. If built-in roles cannot meet your business requirements, you can create custom roles. You can allow a custom role to have permissions on specific workspace-level services. You can also configure permission mappings between custom roles and MaxCompute project roles based on your business requirements. For more information, see Manage permissions on workspace-level services.

    Note

    Only an Alibaba Cloud account or a RAM user to which the ODPS admin or Superadmin role of a MaxCompute project is assigned can configure permission mappings.

Associate computing resources

DataWorks allows you to associate compute engines with a workspace and use the compute engines as compute engine instances of the workspace to configure and schedule nodes in the workspace. On the Compute Engine Information tab, you can associate compute engines with the workspace or disassociate compute engines from the workspace. For more information, see Associate compute engines with a workspace and manage the compute engines.

View permissions

On the Permissions tab, you can view the permissions of each built-in role. For more information, see Permissions of built-in workspace-level roles.

Delete or disable a workspace

On the Workspaces page in the DataWorks console, you can move the pointer over the 更多 icon in the Actions column of a workspace and select Delete Workspace to delete the workspace or Disable Workspace to disable the workspace.

  • Delete Workspace: After you delete a workspace, you cannot recover it. We recommend that you do not perform this operation unless the operation is necessary.

  • Disable Workspace:

    • After you disable a workspace, the system no longer generates instances for auto triggered nodes in the workspace. The instances that are generated before you disable the workspace are automatically scheduled at the specified time. However, you cannot access the workspace to view information about these instances.

    • After you disable a workspace, compute engine instances that are associated with the workspace still exist, and you may be still charged for the compute engine instances that you use to store data. You are not charged in the DataWorks service but in the Alibaba Cloud services to which the compute engine instances you use belong. If you have questions about billing, you can contact the technical support of the Alibaba Cloud services.

What to do next

You have learned how to create and manage workspaces. During data development, you also need to perform other operations. For example, you need to associate a resource group with a workspace, add RAM users to a workspace as members, and add data sources.

  • When you activate DataWorks, you are provided with pay-as-you-go shared resource groups by default. You can purchase a subscription exclusive resource group or upgrade the DataWorks service to an advanced edition to use more advanced features. For example, you can use servers in your data center as a resource group after you upgrade DataWorks to an advanced edition. For more information about different types of resource groups, see Overview.

  • If you want to use DataWorks to synchronize data between data sources, you must add the data sources to DataWorks and configure information about the data sources. This way, when you configure a data synchronization node, you can determine the database from which you want to read data and the database to which you want to write data based on the names of the data sources. For more information, see Add and manage data sources.

  • If you want to collaborate with other RAM users to perform data development operations in a workspace, you can add the RAM users to the workspace as members and assign different roles to them for collaborative development. For more information, see Overview of the DataWorks permission management system.