UserMappingFile

Key Name Default Value Required

UserMappingFile

None

No

Description

The full path to a JSON file that maps your HBase user name to a Kerberos user principal name and a keytab file.

Note:

This option is applicable only when the authentication mechanism is set to Advanced Kerberos (AUTHTYPE=3).

The mapping in the JSON file must be written using the following schema, where [UserName] is the HBase user name, [KerberosUPN] is the Kerberos user principal name, and [KeytabFile] is the full path to the keytab file:

{

"[UserName]": {

"principal" : "[KerberosUPN]",

"keytabfile": "[KeytabFile]"

},

...

}

For example, the following file maps the HBase user name simba to the simba@SIMBA Kerberos user principal name and the /tmp/simba.keytab file:

{

"simba": {

"principal" : "simba@SIMBA",

"keytabfile": "/tmp/simba.keytab"

},

...

}

If parts of the mapping are invalid or not defined, then the following occurs:

  • If the mapping file fails to specify a Kerberos user principal name, then the connector uses the HBase user name as the Kerberos user principal name.
  • If the mapping file fails to specify a keytab file, then the connector uses the keytab file that is specified in the DefaultKeytabFile setting.
  • If the entire mapping file is invalid or not defined, then the connector does both of the actions described above.