Synchronizing Users

Prerequisites

• You have created a GaussDB(DWS) or MRS Ranger data connection in Management Center. For details, see Creating a Data Connection.
• You have configured permissions for the dlg_agency by referring to Preparation 1: Authorizing dlg_agency.

Constraints

• In a DataArts Studio instance, each MRS/GaussDB(DWS) cluster can have only one user synchronization task.
• If a user synchronization task keeps running for more than half an hour, the task will be stopped due to timeout. If the synchronization fails for more than 10 consecutive times, the task will be stopped.
• Federated users have only user group information and cannot be synchronized.
• The data source synchronizes only the user information of its own tenant and cannot synchronize the clusters from data sources of other tenants who are not connected through IP connections.
• User synchronization is available only for MRS Hive and GaussDB(DWS) data sources. For the GaussDB(DWS) data source, user synchronization is mandatory. For the MRS data source, you can create MRS users with the same name as IAM users so that user synchronization is not needed. DLI uses IAM users for authentication. Therefore, user synchronization is not required.
• The restrictions on MRS user synchronization tasks are as follows:
  • If a human-machine user with the same name as the user to be synchronized exists in MRS, the MRS user synchronization task fails. No error message is displayed for this error. You are advised to use either of the following methods to resolve this issue:
    • Use the IAM user synchronization function on the MRS cluster details page, rather than run the user synchronization task on the DataArts Security console again. The IAM user synchronization function is similar to the user synchronization task, except that if there are users with the same name, only these users will fail to be synchronized, and the other users can still be synchronized successfully.
    • Log in to MRS Manager, choose System > Permission > User, and delete the human-machine user with the same name as the user to be synchronized.
    • On the IAM console, delete the user to be synchronized with the same name as the MRS human-machine user.
  • Before MRS data source synchronization, ensure that the user or user group has at least one of the following permissions. Otherwise, the user or user group will not be synchronized.
    • Tenant Administrator
    • MRS FullAccess
    • MRS CommonOperations
    • MRS ReadOnlyAccess
    • MRS Administrator
    • MRS Admin
    • MRS User
    • MRS Viewer
    • Self Define (any custom policy)
• The restrictions on GaussDB(DWS) user synchronization tasks are as follows:
  • GaussDB(DWS) user synchronization is supported only when the guest_agent version of a GaussDB(DWS) cluster is 8.2.1, or later than 8.2.1 and earlier than 9.0.0. For details about how to check the guest_agent version of a GaussDB(DWS) cluster, see Viewing the guest_agent Version of a GaussDB(DWS) Cluster.
  • Before GaussDB(DWS) user synchronization, ensure that the users at least have the DWS Database Access permission. Otherwise, the synchronization will fail.
  • To synchronize GaussDB(DWS) users, you must configure the following permissions for the dlg_agency. For details, see Preparation 1: Authorizing dlg_agency.
    • dws:dbAuthority:syncIamUse
    • iam:users:listUsers
    • iam:groups:listGroups
    • iam:users:listUsersForGroup

Creating a User Synchronization Task

1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts Security.
   Figure 1 DataArts Security
   

2. In the left navigation pane on the DataArts Security console, choose User Synchronization.
3. On the Synchronization Tasks page, click Create to create a user synchronization task.
   Figure 2 Creating a user synchronization task
   

4. For details about how to set parameters for creating a user synchronization task, see Table 1. After setting the parameters, click OK to create a user synchronization task.
   Figure 3 Creating a user synchronization task
   

   Table 1 Parameters for creating a user synchronization task

   Parameter	Description
   *Select Cluster	Select a GaussDB(DWS) or MRS cluster that is connected through a GaussDB(DWS) or MRS data connection.
   *Cluster Type	You do not need to set this parameter. A matched cluster type is automatically selected.
   *Data Connection	You do not need to set this parameter. The data source cluster is automatically selected.
   *Scheduling Time	Select the time period for scheduling, with the start time included and end time excluded. For example, if the scheduling time is set to 00-05, the task runs from 00:00 to 05:00 every day. Scheduling is triggered at 00:00 but not at 05:00.
   *Scheduling Period	The task can be scheduled by hour or minute.
   *Interval	Select a proper scheduling interval based on the selected scheduling period. The scheduling interval is the interval from the last running time. Manual synchronization is also counted in the running time. For example, if a task starts at 20:00 and manually executed at 20:03, and the interval is five minutes, the task is scheduled again at 20:08.

5. After the user synchronization task is created, it does not run directly. You need to manually synchronize or schedule the task. The task takes effect after it is successfully synchronized. For details, see Synchronizing or Scheduling Tasks.

Related Operations

• Synchronizing or scheduling tasks: On the user synchronization task page, click Synchronize or choose More > Start Schedule in the Operation column of the corresponding task. If a task has not been executed before and is scheduled for the first time, the task is triggered immediately.
  

  If a task fails to be executed, perform the following operations:

  • If the error message indicates insufficient permissions, see Preparation 1: Authorizing dlg_agency.
  • If the error message indicates that the GaussDB(DWS) IAM credential fails to be downloaded, check whether the current user has at least the GaussDB(DWS) database access permission.
  • If error message "Mrs sync failed, please check the failure cause on the MRS page" is displayed for the MRS task, log in to the MRS console and choose Operation Logs in the navigation pane to view the cause.
  • If the MRS operation logs do not contain error information, the synchronization failure cause is that the IAM username conflicts with the name of an existing MRS human-machine user. Log in to MRS Manager and delete the human-machine user with the same name as the IAM user. The default description of the IAM username for the synchronization is IAM Custom Policy User, and the IAM user cannot be deleted. A common MRS human-machine user can be deleted.
  • Handle other errors based on the error messages and logs.
• Viewing task logs: On the user synchronization task page, locate the task whose logs need to be viewed and click Details in the Operation column to view the run logs. A maximum of 20 logs are displayed.

  If a task fails to be executed, you can locate the failure cause based on logs, rectify the fault, and try to execute the task again. If the fault persists, contact technical support for assistance.

• Editing a task: On the user synchronization task page, click More in the Operation column and select Edit to edit the user synchronization task.
• Deleting a task: On the user synchronization task page, click More in the Operation column and select Delete to delete the user synchronization task. To delete multiple tasks at a time, select the tasks and click Delete above the task list.
  

  The deletion operation cannot be undone. Exercise caution when performing this operation.