Package org.apache.pulsar.functions.secretsproviderconfigurator

Class KubernetesSecretsProviderConfigurator

java.lang.Object

org.apache.pulsar.functions.secretsproviderconfigurator.KubernetesSecretsProviderConfigurator

All Implemented Interfaces:

SecretsProviderConfigurator

public class KubernetesSecretsProviderConfigurator
extends Object
implements SecretsProviderConfigurator

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 available to the function at runtime. Then we plug in the EnvironmentBasedSecretsConfig as the secrets provider who knows how to read these environment variables.

Constructor Summary

Constructors

Constructor	Description
KubernetesSecretsProviderConfigurator()

Method Summary

Modifier and Type	Method	Description
void	configureKubernetesRuntimeSecretsProvider(io.kubernetes.client.openapi.models.V1PodSpec podSpec, String functionsContainerName, Function.FunctionDetails functionDetails)	Attaches any secrets specific stuff to the k8 container for kubernetes runtime.
void	configureProcessRuntimeSecretsProvider(ProcessBuilder processBuilder, Function.FunctionDetails functionDetails)	Attaches any secrets specific stuff to the ProcessBuilder for process runtime.
void	doAdmissionChecks(io.kubernetes.client.openapi.apis.AppsV1Api appsV1Api, io.kubernetes.client.openapi.apis.CoreV1Api coreV1Api, String jobNamespace, String jobName, Function.FunctionDetails functionDetails)	Do config checks to see whether the secrets provided are conforming.
Type	getSecretObjectType()	What is the type of the object that should be in the user secret config.
String	getSecretsProviderClassName(Function.FunctionDetails functionDetails)	Return the Secrets Provider Classname.
Map<String,String>	getSecretsProviderConfig(Function.FunctionDetails functionDetails)	Return the secrets provider config.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.pulsar.functions.secretsproviderconfigurator.SecretsProviderConfigurator

init

Constructor Details

KubernetesSecretsProviderConfigurator

public KubernetesSecretsProviderConfigurator()

Method Details

getSecretsProviderClassName

public String getSecretsProviderClassName(Function.FunctionDetails functionDetails)

Description copied from interface: SecretsProviderConfigurator

Return the Secrets Provider Classname. This will be passed to the cmdline of the instance and should contain the logic of connecting with the secrets provider and obtaining secrets.

Specified by:

getSecretsProviderClassName in interface SecretsProviderConfigurator

getSecretsProviderConfig

public Map<String,String> getSecretsProviderConfig(Function.FunctionDetails functionDetails)

Description copied from interface: SecretsProviderConfigurator

Return the secrets provider config.

Specified by:

getSecretsProviderConfig in interface SecretsProviderConfigurator

configureKubernetesRuntimeSecretsProvider

public void configureKubernetesRuntimeSecretsProvider(io.kubernetes.client.openapi.models.V1PodSpec podSpec,
 String functionsContainerName,
 Function.FunctionDetails functionDetails)

Description copied from interface: SecretsProviderConfigurator

Attaches any secrets specific stuff to the k8 container for kubernetes runtime.

Specified by:

configureKubernetesRuntimeSecretsProvider in interface SecretsProviderConfigurator

configureProcessRuntimeSecretsProvider

public void configureProcessRuntimeSecretsProvider(ProcessBuilder processBuilder,
 Function.FunctionDetails functionDetails)

Description copied from interface: SecretsProviderConfigurator

Attaches any secrets specific stuff to the ProcessBuilder for process runtime.

Specified by:

configureProcessRuntimeSecretsProvider in interface SecretsProviderConfigurator

getSecretObjectType

public Type getSecretObjectType()

Description copied from interface: SecretsProviderConfigurator

What is the type of the object that should be in the user secret config.

Specified by:

getSecretObjectType in interface SecretsProviderConfigurator

Returns:

doAdmissionChecks

public void doAdmissionChecks(io.kubernetes.client.openapi.apis.AppsV1Api appsV1Api,
 io.kubernetes.client.openapi.apis.CoreV1Api coreV1Api,
 String jobNamespace,
 String jobName,
 Function.FunctionDetails functionDetails)

Description copied from interface: SecretsProviderConfigurator

Do config checks to see whether the secrets provided are conforming.

Specified by:

doAdmissionChecks in interface SecretsProviderConfigurator