HADOOP-14880. [KMS] Document&test missing KMS client side configs. Contributed by Gabor Bota.
(cherry picked from commit 97c70c7ac6881f87eee1575bcbdd28b31ecac231) Conflicts: hadoop-common-project/hadoop-kms/src/test/java/org/apache/hadoop/crypto/key/kms/server/TestKMS.java Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/a47e8e66 Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/a47e8e66 Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/a47e8e66 Branch: refs/heads/branch-2 Commit: a47e8e660f56a2b431d40aea5787fef092cc2c72 Parents: 86c2adc Author: Wei-Chiu Chuang <weic...@apache.org> Authored: Thu Oct 19 06:02:13 2017 -0700 Committer: vrushali <vrush...@apache.org> Committed: Fri Oct 20 11:22:27 2017 -0700 ---------------------------------------------------------------------- .../org/apache/hadoop/crypto/key/kms/KMSClientProvider.java | 8 +++----- .../org/apache/hadoop/fs/CommonConfigurationKeysPublic.java | 9 +++++++++ .../hadoop-common/src/main/resources/core-default.xml | 8 ++++++++ .../org/apache/hadoop/crypto/key/kms/server/TestKMS.java | 2 +- 4 files changed, 21 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hadoop/blob/a47e8e66/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/kms/KMSClientProvider.java ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/kms/KMSClientProvider.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/kms/KMSClientProvider.java index 77e09e3..42c97d3 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/kms/KMSClientProvider.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/kms/KMSClientProvider.java @@ -115,10 +115,6 @@ public class KMSClientProvider extends KeyProvider implements CryptoExtension, private static final String CONFIG_PREFIX = "hadoop.security.kms.client."; - /* It's possible to specify a timeout, in seconds, in the config file */ - public static final String TIMEOUT_ATTR = CONFIG_PREFIX + "timeout"; - public static final int DEFAULT_TIMEOUT = 60; - /* Number of times to retry authentication in the event of auth failure * (normally happens due to stale authToken) */ @@ -436,7 +432,9 @@ public class KMSClientProvider extends KeyProvider implements CryptoExtension, throw new IOException(ex); } } - int timeout = conf.getInt(TIMEOUT_ATTR, DEFAULT_TIMEOUT); + int timeout = conf.getInt( + CommonConfigurationKeysPublic.KMS_CLIENT_TIMEOUT_SECONDS, + CommonConfigurationKeysPublic.KMS_CLIENT_TIMEOUT_DEFAULT); authRetry = conf.getInt(AUTH_RETRY, DEFAULT_AUTH_RETRY); configurator = new TimeoutConnConfigurator(timeout, sslFactory); encKeyVersionQueue = http://git-wip-us.apache.org/repos/asf/hadoop/blob/a47e8e66/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CommonConfigurationKeysPublic.java ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CommonConfigurationKeysPublic.java b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CommonConfigurationKeysPublic.java index d27f61d..2edb716 100644 --- a/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CommonConfigurationKeysPublic.java +++ b/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/CommonConfigurationKeysPublic.java @@ -748,6 +748,15 @@ public class CommonConfigurationKeysPublic { * <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml"> * core-default.xml</a> */ + public static final String KMS_CLIENT_TIMEOUT_SECONDS = + "hadoop.security.kms.client.timeout"; + public static final int KMS_CLIENT_TIMEOUT_DEFAULT = 60; + + /** + * @see + * <a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml"> + * core-default.xml</a> + */ /** Default value is the number of providers specified. */ public static final String KMS_CLIENT_FAILOVER_MAX_RETRIES_KEY = "hadoop.security.kms.client.failover.max.retries"; http://git-wip-us.apache.org/repos/asf/hadoop/blob/a47e8e66/hadoop-common-project/hadoop-common/src/main/resources/core-default.xml ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-common/src/main/resources/core-default.xml b/hadoop-common-project/hadoop-common/src/main/resources/core-default.xml index 79faddc..156b25b 100644 --- a/hadoop-common-project/hadoop-common/src/main/resources/core-default.xml +++ b/hadoop-common-project/hadoop-common/src/main/resources/core-default.xml @@ -2496,6 +2496,14 @@ key will be dropped. Default = 12hrs </description> </property> +<property> + <name>hadoop.security.kms.client.timeout</name> + <value>60</value> + <description> + Sets value for KMS client connection timeout, and the read timeout + to KMS servers. + </description> +</property> <property> <name>hadoop.security.kms.client.failover.sleep.base.millis</name> http://git-wip-us.apache.org/repos/asf/hadoop/blob/a47e8e66/hadoop-common-project/hadoop-kms/src/test/java/org/apache/hadoop/crypto/key/kms/server/TestKMS.java ---------------------------------------------------------------------- diff --git a/hadoop-common-project/hadoop-kms/src/test/java/org/apache/hadoop/crypto/key/kms/server/TestKMS.java b/hadoop-common-project/hadoop-kms/src/test/java/org/apache/hadoop/crypto/key/kms/server/TestKMS.java index 5347704..a6f2bd4 100644 --- a/hadoop-common-project/hadoop-kms/src/test/java/org/apache/hadoop/crypto/key/kms/server/TestKMS.java +++ b/hadoop-common-project/hadoop-kms/src/test/java/org/apache/hadoop/crypto/key/kms/server/TestKMS.java @@ -1635,7 +1635,7 @@ public class TestKMS { public void testKMSTimeout() throws Exception { File confDir = getTestDir(); Configuration conf = createBaseKMSConf(confDir); - conf.setInt(KMSClientProvider.TIMEOUT_ATTR, 1); + conf.setInt(CommonConfigurationKeysPublic.KMS_CLIENT_TIMEOUT_SECONDS, 1); writeConf(confDir, conf); ServerSocket sock; --------------------------------------------------------------------- To unsubscribe, e-mail: common-commits-unsubscr...@hadoop.apache.org For additional commands, e-mail: common-commits-h...@hadoop.apache.org