io.fabric8.kubernetes.pipeline.devops

Class ApplyStepExecution

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl

org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution<String>

io.fabric8.kubernetes.pipeline.devops.ApplyStepExecution

All Implemented Interfaces:

Serializable

public class ApplyStepExecution
extends org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution<String>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplyStepExecution()

Method Summary

Modifier and Type	Method and Description
protected void	addEnvironmentAnnotations(io.fabric8.kubernetes.api.model.HasMetadata resource)
protected static void	addPropertiesFileToMap(File file, Map<String,String> answer)
protected static void	addPropertiesFileToMap(URL url, Map<String,String> answer)
void	addRegistryToImageNameIfNotPresent(Iterable<io.fabric8.kubernetes.api.model.HasMetadata> items, String registry)
static io.fabric8.openshift.api.model.Route	createRouteForService(String routeDomainPostfix, String namespace, io.fabric8.kubernetes.api.model.Service service, hudson.model.TaskListener listener)
protected void	createRoutes(io.fabric8.kubernetes.client.KubernetesClient kubernetes, Collection<io.fabric8.kubernetes.api.model.HasMetadata> collection, String namespace)
String	getDeploymentEventJson(String resource, String environment, String environmentName)
GitConfig	getGitConfig()
io.fabric8.kubernetes.client.KubernetesClient	getKubernetes()
io.fabric8.devops.ProjectConfig	getProjectConfig()
static boolean	hasRegistry(String imageName) Checks to see if there's a registry name already provided in the image name Code influenced from docker-maven-plugin
String	run()
protected static boolean	shouldCreateRouteForService(io.fabric8.kubernetes.api.model.Service service, String id, hudson.model.TaskListener listener) Should we try to create a route for the given service?
protected String	tryDefaultAnnotationEnvVar(String envVarName) Tries to default some environment variables if they are not already defined.

Methods inherited from class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution

start, stop

Methods inherited from class org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl

inject, onResume

Methods inherited from class org.jenkinsci.plugins.workflow.steps.StepExecution

applyAll, applyAll, getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplyStepExecution

public ApplyStepExecution()

Method Detail

run

public String run()
           throws Exception

Specified by:

run in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution<String>

Throws:

Exception

createRoutes

protected void createRoutes(io.fabric8.kubernetes.client.KubernetesClient kubernetes,
                            Collection<io.fabric8.kubernetes.api.model.HasMetadata> collection,
                            String namespace)
                     throws hudson.AbortException

Throws:

hudson.AbortException

createRouteForService

public static io.fabric8.openshift.api.model.Route createRouteForService(String routeDomainPostfix,
                                                                         String namespace,
                                                                         io.fabric8.kubernetes.api.model.Service service,
                                                                         hudson.model.TaskListener listener)

shouldCreateRouteForService

protected static boolean shouldCreateRouteForService(io.fabric8.kubernetes.api.model.Service service,
                                                     String id,
                                                     hudson.model.TaskListener listener)

Should we try to create a route for the given service?

By default lets ignore the kubernetes services and any service which does not expose ports 80 and 443

Returns:

true if we should create an OpenShift Route for this service.

addRegistryToImageNameIfNotPresent

public void addRegistryToImageNameIfNotPresent(Iterable<io.fabric8.kubernetes.api.model.HasMetadata> items,
                                               String registry)
                                        throws Exception

Throws:

Exception

hasRegistry

public static boolean hasRegistry(String imageName)

Checks to see if there's a registry name already provided in the image name Code influenced from docker-maven-plugin

Parameters:

imageName -

Returns:

true if the image name contains a registry

addEnvironmentAnnotations

protected void addEnvironmentAnnotations(io.fabric8.kubernetes.api.model.HasMetadata resource)
                                  throws hudson.AbortException

Throws:

hudson.AbortException

tryDefaultAnnotationEnvVar

protected String tryDefaultAnnotationEnvVar(String envVarName)
                                     throws hudson.AbortException

Tries to default some environment variables if they are not already defined.

This can happen if using Jenkins Workflow which doens't seem to define BUILD_URL or GIT_URL for example

Returns:

the value of the environment variable name if it can be found or calculated

Throws:

hudson.AbortException

addPropertiesFileToMap

protected static void addPropertiesFileToMap(File file,
                                             Map<String,String> answer)
                                      throws hudson.AbortException

Throws:

hudson.AbortException

addPropertiesFileToMap

protected static void addPropertiesFileToMap(URL url,
                                             Map<String,String> answer)
                                      throws hudson.AbortException

Throws:

hudson.AbortException

getGitConfig

public GitConfig getGitConfig()
                       throws hudson.AbortException

Throws:

hudson.AbortException

getProjectConfig

public io.fabric8.devops.ProjectConfig getProjectConfig()
                                                 throws hudson.AbortException

Throws:

hudson.AbortException

getDeploymentEventJson

public String getDeploymentEventJson(String resource,
                                     String environment,
                                     String environmentName)
                              throws IOException,
                                     InterruptedException

Throws:

IOException

InterruptedException

getKubernetes

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