Associate an OpenSearch computing resource

Updated at:
Copy as MD

Associate your OpenSearch instance as a computing resource in DataWorks so that you can develop and manage OpenSearch data synchronization and development tasks.

Prerequisites

  • You have purchased an OpenSearch Vector Search Edition instance.

    Note

    We recommend that the OpenSearch Vector Search Edition instance and the DataWorks workspace are in the same Region. If they are in different regions, you cannot associate the instance as a computing resource.

  • You have created a workspace in DataWorks, and the RAM user that you use has been added to the workspace and assigned the Workspace Administrator role.

    Important

    Only workspaces that Use Data Studio (New Version) are supported.

  • You have associated a resource group with the workspace and ensured network connectivity.

Limitations

  • Product limitation: You can associate only OpenSearch Vector Search Edition instances as OpenSearch computing resources.

  • Region limitation: China (Hangzhou), China (Shanghai), China (Beijing), China (Shenzhen), China (Hong Kong), Singapore, and Germany (Frankfurt).

  • Permission limitation:

    User

    Required permissions

    Alibaba Cloud account

    No additional permissions are required.

    RAM user or RAM role

    Only workspace members with the O&M or Workspace Administrator role, or those with the AliyunDataWorksFullAccess permission, can create computing resources. For more information, see Grant workspace administrator permissions.

Go to the computing resource list page

  1. Log on to the DataWorks console. In the navigation pane on the left, switch to the target region and click More > Management Center. Select your workspace from the drop-down list and click Go to Management Center.

  2. In the navigation pane on the left, click Computing Resources to open the computing resource list page.

Associate an OpenSearch computing resource

On the computing resource list page, perform the following steps to associate an OpenSearch computing resource.

  1. Select the computing resource type.

    1. Click Associate Computing Resources to go to the Associate Computing Resources page.

    2. On the Associate Computing Resources page, select OpenSearch. The Associate OpenSearch Computing Resource configuration page opens.

  2. Configure the OpenSearch computing resource.

    On the Associate OpenSearch Computing Resource configuration page, configure the following parameters:

    Parameter

    Description

    OpenSearch Instance

    Select an OpenSearch instance that you have purchased. You can also click Create in the drop-down list to open the OpenSearch purchase page and purchase an OpenSearch Vector Search Edition instance.

    Note

    If you isolated the development and production environments when you created the workspace, you must select a separate OpenSearch instance for each environment.

    Username

    Enter the username that you set when you created the OpenSearch instance. You can view the username on the OpenSearch instance management page.

    Password

    Enter the password that you set when you created the OpenSearch instance.

    Computing Resource Instance Name

    Enter a name for the computing resource. Tasks use this name to select the resource at runtime.

  3. Test network connectivity.

    In the connection configuration section, select the resource group that DataWorks uses to run OpenSearch offline synchronization tasks. Then, click Test Connectivity to ensure that the resource group can access your OpenSearch instance. For more information, see Overview of network connectivity solutions.

  4. Click Confirm to complete the OpenSearch computing resource configuration.

Note

When you associate an OpenSearch computing resource, DataWorks automatically creates an OpenSearch data source with the same name in the Data Sources section of the workspace.

What to do next

After you associate the OpenSearch computing resource, you can develop offline synchronization tasks in a Data Integration > Batch Sync node in Data Studio. For more information, see Offline synchronization nodes.