pulsar-commits mailing list archives

[GitHub] cckellogg commented on a change in pull request #2855: Secretprovider interfaces and some default implementations

Date

Sat, 27 Oct 2018 05:33:46 GMT

cckellogg commented on a change in pull request #2855: Secretprovider interfaces and some default
implementations
URL: https://github.com/apache/pulsar/pull/2855#discussion_r228702112
##########
File path: pulsar-functions/secrets/src/main/java/org/apache/pulsar/functions/secretsproviderconfigurator/KubernetesSecretsProviderConfigurator.java
##########
@@ -0,0 +1,87 @@
+/**
+ * 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.pulsar.functions.secretsproviderconfigurator;
+
+import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
+import io.kubernetes.client.models.V1Container;
+import io.kubernetes.client.models.V1EnvVar;
+import io.kubernetes.client.models.V1EnvVarSource;
+import io.kubernetes.client.models.V1SecretKeySelector;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.pulsar.functions.proto.Function;
+import org.apache.pulsar.functions.secretsprovider.EnvironmentBasedSecretsProvider;
+
+import java.lang.reflect.Type;
+import java.util.Map;
+
+/**
+ * This file defines the SecretsProviderConfigurator that will be used by default for running
in Kubernetes.
+ * As such this implementation is strictly when workers are configured to use kubernetes
runtime.
+ * We use kubernetes in built secrets and bind them as environment variables within the function
container
+ * to ensure that the secrets are availble to the function at runtime. Then we plug in the
+ * EnvironmentBasedSecretsConfig as the secrets provider who knows how to read these environment
variables
+ */
+public class KubernetesSecretsProviderConfigurator implements SecretsProviderConfigurator
{
+ @Override
+ public String getSecretsProviderClassName(Function.FunctionDetails functionDetails) {
+ switch (functionDetails.getRuntime()) {
+ case JAVA:
+ return EnvironmentBasedSecretsProvider.class.getName();
+ case PYTHON:
+ return "secretsprovider.EnvironmentBasedSecretsProvider";
+ default:
+ throw new RuntimeException("Unknown function runtime " + functionDetails.getRuntime());
+ }
+ }
+
+ @Override
+ public Map<String, String> getSecretsProviderConfig(Function.FunctionDetails functionDetails)
{
+ return null;
+ }
+
+ @Override
+ public void configureKubernetesRuntimeSecretsProvider(V1Container container, Function.FunctionDetails
functionDetails) {
+ if (!StringUtils.isEmpty(functionDetails.getSecretsMap())) {
+ Type type = new TypeToken<Map<String, Object>>() {
+ }.getType();
+ Map<String, Object> secretsMap = new Gson().fromJson(functionDetails.getSecretsMap(),
type);
+ for (Map.Entry<String, Object> entry : secretsMap.entrySet()) {
+ final V1EnvVar secretEnv = new V1EnvVar();
+ Map<String, String> kv = (Map<String, String>) entry.getValue();
+ secretEnv.name(entry.getKey())
+ .valueFrom(new V1EnvVarSource()
+ .secretKeyRef(new V1SecretKeySelector()
+ .name(kv.entrySet().iterator().next().getKey())
Review comment:
should this look for specific keys in the Map? There should be some error checking? What
if the first key is unexpected or unknown value? The provider should provide some validation
of the secret object and not process it if it's not configured correctly. Can there be some
unit tests with this too?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services