com.microsoft.jenkins.kubernetes

Class KubernetesClientWrapper

java.lang.Object

com.microsoft.jenkins.kubernetes.KubernetesClientWrapper

public class KubernetesClientWrapper
extends Object

Constructor Summary

Constructors

Constructor and Description
KubernetesClientWrapper(String kubeConfigFilePath)
KubernetesClientWrapper(String server, String certificateAuthorityData, String clientCertificateData, String clientKeyData)

Method Summary

Modifier and Type	Method and Description
void	apply(hudson.FilePath[] configFiles) Apply Kubernetes configurations through the given Kubernetes client.
void	createOrReplaceSecrets(String kubernetesNamespace, String secretName, List<ResolvedDockerRegistryEndpoint> credentials) Construct the dockercfg with all the provided credentials, and create a new Secret resource for the Kubernetes cluster.
io.fabric8.kubernetes.client.KubernetesClient	getClient()
PrintStream	getLogger()
ResourceUpdateMonitor	getResourceUpdateMonitor()
hudson.util.VariableResolver<String>	getVariableResolver()
static io.fabric8.kubernetes.client.Config	kubeConfigFromFile(String filePath) Build config from the kubeconfig file.
static String	prepareSecretName(String nameCfg, String defaultName, hudson.EnvVars envVars)
KubernetesClientWrapper	withLogger(PrintStream log)
KubernetesClientWrapper	withResourceUpdateMonitor(ResourceUpdateMonitor monitor)
KubernetesClientWrapper	withVariableResolver(hudson.util.VariableResolver<String> resolver)

Methods inherited from class java.lang.Object

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

Constructor Detail

KubernetesClientWrapper

public KubernetesClientWrapper(String kubeConfigFilePath)

KubernetesClientWrapper

public KubernetesClientWrapper(String server,
                               String certificateAuthorityData,
                               String clientCertificateData,
                               String clientKeyData)

Method Detail

getClient

public io.fabric8.kubernetes.client.KubernetesClient getClient()

getLogger

public PrintStream getLogger()

withLogger

public KubernetesClientWrapper withLogger(PrintStream log)

getVariableResolver

public hudson.util.VariableResolver<String> getVariableResolver()

withVariableResolver

public KubernetesClientWrapper withVariableResolver(hudson.util.VariableResolver<String> resolver)

getResourceUpdateMonitor

public ResourceUpdateMonitor getResourceUpdateMonitor()

withResourceUpdateMonitor

public KubernetesClientWrapper withResourceUpdateMonitor(ResourceUpdateMonitor monitor)

apply

public void apply(hudson.FilePath[] configFiles)
           throws IOException,
                  InterruptedException

Apply Kubernetes configurations through the given Kubernetes client.

Parameters:

configFiles - The configuration files to be deployed

Throws:

IOException - exception on IO

InterruptedException - interruption happened during blocking IO operations

createOrReplaceSecrets

public void createOrReplaceSecrets(String kubernetesNamespace,
                                   String secretName,
                                   List<ResolvedDockerRegistryEndpoint> credentials)
                            throws IOException

Construct the dockercfg with all the provided credentials, and create a new Secret resource for the Kubernetes cluster.

This can be used by the Pods later to pull images from the private container registry.

Parameters:

kubernetesNamespace - The namespace in which the Secret should be created / updated

secretName - The name of the Secret

credentials - All the configured credentials

Throws:

IOException - exception on IO

See Also:

Pull an Image from a Private Registry

kubeConfigFromFile

public static io.fabric8.kubernetes.client.Config kubeConfigFromFile(String filePath)

Build config from the kubeconfig file.

This requires to update the system property. In order to avoid changing the system property at the same time from multiple running jobs, the method is marked as synchronized.

Parameters:

filePath - the kubeconfig file path

Returns:

the config that can be used to build KubernetesClient

prepareSecretName

public static String prepareSecretName(String nameCfg,
                                       String defaultName,
                                       hudson.EnvVars envVars)