Customize Services: User Sync

How to customize Ranger User Sync for either UNIX or LDAP/AD when installing Ranger via Ambari.

• Customize User Sync for UNIX:
  1. On the Customize Services page, select the Ranger User Info tab.
  2. Click Yes under Enable User Sync.
  3. Use the Sync Source drop-down to select UNIX, then set the following properties.

     Table 1. UNIX User Sync Properties

     Property	Description	Default Value
     Sync Source	Only sync users above this user ID.	500
     Password File	The location of the password file on the Linux server.	/etc/passwd
     Group File	The location of the groups file on the Linux server.	/etc/group

     

• Customize User Sync for LDAP/AD:
  1. On the Customize Services page, select the Ranger User Info tab.
  2. Click Yes under Enable User Sync.
  3. Use the Sync Source drop-down to select LDAP/AD.
  4. Set the following properties on the Common Configs tab.

     Table 2. LDAP/AD Common Configs

     Property	Description	Default Value	Sample Values
     LDAP/AD URL	Add URL depending upon LDAP/AD sync source	ldap://{host}:{port}	ldap://ldap.example.com:389 or ldaps://ldap.example.com:636
     Bind Anonymous	If Yes is selected, the Bind User and Bind User Password are not required.	NO
     Bind User	The location of the groups file on the Linux server.	The full distinguished name (DN), including common name (CN), of an LDAP/AD user account that has privileges to search for users. The LDAP bind DN is used to connect to LDAP and query for users and groups.	cn=admin,dc=example,dc=com or admin@example.com
     Bind User Password	The password of the Bind User.
     Incremental Sync	If Yes is selected, Ranger Usersync saves the latest timestamp of all the objects that are synced previously and uses that timestamp to perform the next sync. Usersync then uses a polling mechanism to perform incremental sync by using LDAP attributes uSNChanged (for AD) or modifytimestamp (for LDAP). Enabling Incremental Sync for the first time will initiate a full sync; subsequent sync operations will be incremental. When Incremental Sync is enabled, Group Sync (under the Group Configs tab) is mandatory. Recommended for large deployments.	For upgrade installations: No For new installations: Yes	Yes

     

  5. Set the following properties on the User Configs tab.

     Table 3. LDAP/AD User Configs

     Property	Description	Default Value	Sample Values
     Group User Map Sync	Sync specific groups for users.	Yes	Yes
     Username Attribute	The LDAP user name attribute.		sAMAccountName for AD, uid or cn for OpenLDAP
     User Object Class	Object class to identify user entries.	person	top, person, organizationalPerson, user, or posixAccount
     User Search Base	Search base for users. Ranger can search multiple OUs in AD. Ranger UserSync module performs a user search on each configured OU and adds all the users into single list. Once all the OUs are processed, a user’s group membership is computed based on the group search.		cn=users,dc=example,dc=com;ou=example1,ou=example2
     User Search Filter	Optional additional filter constraining the users selected for syncing.		Sample filter to retrieve all the users: cn=* Sample filter to retrieve all the users who are members of groupA or groupB: (|(memberof=CN=GroupA,OU=groups,DC=example,DC=com)(memberof=CN=GroupB,OU=groups,DC=example,DC=com))
     User Search Scope	This value is used to limit user search to the depth from search base.	sub	base, one, or sub
     User Group Name Attribute	Attribute from user entry whose values would be treated as group values to be pushed into the Access Manager database. You can provide multiple attribute names separated by commas.	memberof,ismemberof	memberof, ismemberof, or gidNumber
     Enable User Search	This option is available only when the "Enable Group Search First" option is selected.	No	Yes

     

  6. Set the following properties on the Group Configs tab.

     Table 4. LDAP/AD Group Configs

     Property	Description	Default Value	Sample Values
     Enable Group Sync	If Enable Group Sync is set to No, the group names the users belong to are derived from “User Group Name Attribute”. In this case no additional group filters are applied. If Enable Group Sync is set to Yes, the groups the users belong to are retrieved from LDAP/AD using the following group-related attributes. Enabled by default if "Incremental Sync" is enabled under the Common Configs tab.	No	Yes
     Group Member Attribute	The LDAP group member attribute name.		member
     Group Name Attribute	The LDAP group name attribute.		distinguishedName for AD, cn for OpenLdap
     Group Object Class	LDAP Group object class.		group, groupofnames, or posixGroup
     Group Search Base	Search base for groups. Ranger can search multiple OUs in AD. Ranger UserSync module performs a user search on each configured OU and adds all the users into single list. Once all the OUs are processed, a user’s group membership is computed based on the group search configuration. Each OU segment needs to be separated by a ; (semi-colon).		ou=groups,DC=example,DC=com;ou=group1;ou=group2
     Group Search Filter	Optional additional filter constraining the groups selected for syncing.		Sample filter to retrieve all groups: cn=* Sample filter to retrieve only the groups whose cn is Engineering or Sales: (|(cn=Engineering)(cn=Sales))
     Enable Group Search First	When Enable Group Search First is selected, there are two possible ways of retrieving users: If Enable User Search is not selected: users are retrieved from the “member” attribute of the group. If Enable User Search is selected: user membership is computed by performing an LDAP search based on the user configuration.	No	Yes
     state: anchor=nested_ldapad_syncSync Nested Groups	Enables nested group memberships in Ranger so that the policies configured for parent groups are applied for all the members in the subgroups. If a group itself is a member of another group, the users belonging to the member group are part of the parent group as well. Group Hierarchy Levels determines evaluated nested group depth. If you do not see the Sync Nested Groups flag, upgrade to Ambari 2.6.0+.	No	Yes, No
     Group Hierarchy Levels	Determines how many nested groups to evaluate in support of Sync Nested Groups. If Group Hierarchy Levels is greyed out, enable Sync Nested Groups. Set to any integer >0.	0	2