diff --git a/hadoop-common-project/hadoop-kms/src/site/markdown/index.md.vm b/hadoop-common-project/hadoop-kms/src/site/markdown/index.md.vm index d7599de556..6ea21d5cf4 100644 --- a/hadoop-common-project/hadoop-kms/src/site/markdown/index.md.vm +++ b/hadoop-common-project/hadoop-kms/src/site/markdown/index.md.vm @@ -791,10 +791,62 @@ This secret sharing can be done using a Zookeeper service which is configured in $H4 Delegation Tokens Similar to HTTP authentication, KMS uses Hadoop Authentication for delegation tokens too. +Under HA, every KMS instance must verify the delegation token given by another KMS instance. +To do this, all the KMS instances must use ZKDelegationTokenSecretManager to retrieve +the TokenIdentifiers and DelegationKeys from ZooKeeper. -Under HA, A KMS instance must verify the delegation token given by another KMS instance, by checking the shared secret used to sign the delegation token. To do this, all KMS instances must be able to retrieve the shared secret from ZooKeeper. +Sample configuration in `etc/hadoop/kms-site.xml`: -Please see the examples given in HTTP Authentication section to configure ZooKeeper for secret sharing. +```xml + + hadoop.kms.authentication.zk-dt-secret-manager.enable + true + + If true, Hadoop KMS uses ZKDelegationTokenSecretManager to persist + TokenIdentifiers and DelegationKeys in ZooKeeper. + + + + hadoop.kms.authentication.zk-dt-secret-manager.zkConnectionString + #HOSTNAME#:#PORT#,... + + The ZooKeeper connection string, a comma-separated list of hostnames and port. + + + + hadoop.kms.authentication.zk-dt-secret-manager.znodeWorkingPath + /hadoop-kms/zkdtsm + + The ZooKeeper znode path where the KMS instances will store and retrieve + the secret from. All the KMS instances that need to coordinate should point to the same path. + + + + hadoop.kms.authentication.zk-dt-secret-manager.zkAuthType + sasl + + The ZooKeeper authentication type, 'none' (default) or 'sasl' (Kerberos). + + + + hadoop.kms.authentication.zk-dt-secret-manager.kerberos.keytab + /etc/hadoop/conf/kms.keytab + + The absolute path for the Kerberos keytab with the credentials to + connect to ZooKeeper. This parameter is effective only when + hadoop.kms.authentication.zk-dt-secret-manager.zkAuthType is set to 'sasl'. + + + + hadoop.kms.authentication.zk-dt-secret-manager.kerberos.principal + kms/#HOSTNAME# + + The Kerberos service principal used to connect to ZooKeeper. + This parameter is effective only when + hadoop.kms.authentication.zk-dt-secret-manager.zkAuthType is set to 'sasl'. + + +``` $H3 KMS HTTP REST API