Github user vanzin commented on a diff in the pull request:
https://github.com/apache/spark/pull/14065#discussion_r72490136
--- Diff:
yarn/src/main/scala/org/apache/spark/deploy/yarn/security/ConfigurableCredentialManager.scala
---
@@ -0,0 +1,96 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark.deploy.yarn.security
+
+import java.util.ServiceLoader
+
+import scala.collection.JavaConverters._
+
+import org.apache.hadoop.conf.Configuration
+import org.apache.hadoop.security.Credentials
+
+import org.apache.spark.SparkConf
+import org.apache.spark.internal.Logging
+import org.apache.spark.util.Utils
+
+/**
+ * A ConfigurableCredentialManager to manage all the registered credential
providers and offer
+ * APIs for other modules to obtain credentials as well as renewal time.
By default
+ * [[HDFSCredentialProvider]], [[HiveCredentialProvider]] and
[[HBaseCredentialProvider]] will
+ * be loaded in if not explicitly disabled, any plugged-in credential
provider wants to be
+ * managed by ConfigurableCredentialManager needs to implement
[[ServiceCredentialProvider]]
+ * interface and put into resources/META-INF/services to be loaded by
ServiceLoader.
+ *
+ * Also each credential provider is controlled by
+ * spark.yarn.security.credentials.{service}.enabled, it will not be
loaded in if set to false.
+ */
+private[yarn] final class ConfigurableCredentialManager (
+ sparkConf: SparkConf, hadoopConf: Configuration) extends Logging {
+ private val deprecatedProviderEnabledConfig =
"spark.yarn.security.tokens.%s.enabled"
+ private val providerEnabledConfig =
"spark.yarn.security.credentials.%s.enabled"
+
+ // Maintain all the registered credential providers
+ private val credentialProviders = {
+ val providers = ServiceLoader.load(classOf[ServiceCredentialProvider],
+ Utils.getContextOrSparkClassLoader).asScala
+
+ // Filter out credentials in which
spark.yarn.security.credentials.{service}.enabled is false.
+ providers.filter { p =>
+
sparkConf.getOption(providerEnabledConfig.format(p.serviceName)).map(_.toBoolean)
+ .orElse {
+
sparkConf.getOption(deprecatedProviderEnabledConfig.format(p.serviceName)).map
{ c =>
+
logWarning(s"${deprecatedProviderEnabledConfig.format(p.serviceName)} is
deprecated, " +
+ s"using ${providerEnabledConfig.format(p.serviceName)}
instead")
+ c.toBoolean
+ }
+ }.getOrElse(true)
+ }.map { p => (p.serviceName, p) }.toMap
+ }
+
+ /**
+ * Get credential provider for the specified service.
+ */
+ def getServiceCredentialProvider(service: String):
Option[ServiceCredentialProvider] = {
+ credentialProviders.get(service)
+ }
+
+ /**
+ * Obtain credentials from all the registered providers.
+ * @return nearest time of next renewal, Long.MaxValue if all the
credentials aren't renewable,
+ * otherwise the nearest renewal time of any credentials will be
returned.
+ */
+ def obtainCredentials(hadoopConf: Configuration, creds: Credentials):
Long = {
+ credentialProviders.values.flatMap { provider =>
+ if (provider.isCredentialRequired(hadoopConf)) {
+ provider.obtainCredentials(hadoopConf, creds)
+ } else {
+ logDebug(s"Service ${provider.serviceName} does not require a
token." +
+ s" Check your configuration to see if security is disabled or
not.")
+ None
+ }
+ }.foldLeft(Long.MaxValue)(math.min)
+ }
+
+ def credentialRenewer: AMCredentialRenewer = {
--- End diff --
The method is named as if it were a property, yet it returns something
different on every call. It should have a signature that reflects that. e.g.
`newCredentialRenewer()`. scaladoc would be nice too, especially to clarify
that the caller is responsible for the lifecycle of the returned instance.
Also applies to `credentialUpdater`.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
