org.springframework.cloud.deployer.spi.kubernetes

Class AbstractKubernetesDeployer

java.lang.Object

org.springframework.cloud.deployer.spi.kubernetes.AbstractKubernetesDeployer

Direct Known Subclasses:

KubernetesAppDeployer, KubernetesTaskLauncher

public class AbstractKubernetesDeployer
extends Object

Abstract base class for a deployer that targets Kubernetes.

Author:

Florian Rosenberg, Thomas Risberg, Mark Fisher, Donovan Muller, David Turanski, Chris Schaefer, Enrique Medina Montenegro, Ilayaperumal Gopinathan

Field Summary

Fields

Modifier and Type	Field and Description
protected io.fabric8.kubernetes.client.KubernetesClient	client
protected ContainerFactory	containerFactory
protected org.apache.commons.logging.Log	logger
protected KubernetesDeployerProperties	properties
protected static String	SPRING_APP_KEY
protected static String	SPRING_DEPLOYMENT_KEY
protected static String	SPRING_GROUP_KEY
protected static String	SPRING_MARKER_KEY
protected static String	SPRING_MARKER_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractKubernetesDeployer()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.cloud.deployer.spi.app.AppStatus	buildAppStatus(String id, io.fabric8.kubernetes.api.model.PodList podList, io.fabric8.kubernetes.api.model.ServiceList services)
protected Map<String,String>	createIdMap(String appId, org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Creates a map of labels for a given ID.
protected io.fabric8.kubernetes.api.model.PodSpec	createPodSpec(String appId, org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request, Integer port, boolean neverRestart) Create a PodSpec to be used for app and task deployments
protected org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo	createRuntimeEnvironmentInfo(Class spiClass, Class implementationClass) Create the RuntimeEnvironmentInfo.
protected ImagePullPolicy	deduceImagePullPolicy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Get the image pull policy for the deployment request.
protected Map<String,io.fabric8.kubernetes.api.model.Quantity>	deduceResourceLimits(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Get the resource limits for the deployment request.
protected Map<String,io.fabric8.kubernetes.api.model.Quantity>	deduceResourceRequests(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Get the resource requests for the deployment request.
protected boolean	getHostNetwork(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Get the hostNetwork setting for the deployment request.
protected String	getStatefulSetStorage(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)
protected String	getStatefulSetStorageClassName(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)
protected List<io.fabric8.kubernetes.api.model.Volume>	getVolumes(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Volume deployment properties are specified in YAML format: spring.cloud.deployer.kubernetes.volumes=[{name: testhostpath, hostPath: { path: '/test/override/hostPath' }}, {name: 'testpvc', persistentVolumeClaim: { claimName: 'testClaim', readOnly: 'true' }}, {name: 'testnfs', nfs: { server: '10.0.0.1:111', path: '/test/nfs' }}] Volumes can be specified as deployer properties as well as app deployment properties.
protected void	logPossibleDownloadResourceMessage(org.springframework.core.io.Resource resource)

Methods inherited from class java.lang.Object

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

Field Detail

SPRING_DEPLOYMENT_KEY

protected static final String SPRING_DEPLOYMENT_KEY

See Also:

Constant Field Values

SPRING_GROUP_KEY

protected static final String SPRING_GROUP_KEY

See Also:

Constant Field Values

SPRING_APP_KEY

protected static final String SPRING_APP_KEY

See Also:

Constant Field Values

SPRING_MARKER_KEY

protected static final String SPRING_MARKER_KEY

See Also:

Constant Field Values

SPRING_MARKER_VALUE

protected static final String SPRING_MARKER_VALUE

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

containerFactory

protected ContainerFactory containerFactory

client

protected io.fabric8.kubernetes.client.KubernetesClient client

properties

protected KubernetesDeployerProperties properties

Constructor Detail

AbstractKubernetesDeployer

public AbstractKubernetesDeployer()

Method Detail

createRuntimeEnvironmentInfo

protected org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo createRuntimeEnvironmentInfo(Class spiClass,
                                                                                                          Class implementationClass)

Create the RuntimeEnvironmentInfo.

Parameters:

spiClass - the SPI interface class

implementationClass - the SPI implementation class

Returns:

the Kubernetes runtime environment info

createIdMap

protected Map<String,String> createIdMap(String appId,
                                         org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Creates a map of labels for a given ID. This will allow Kubernetes services to "select" the right ReplicationControllers.

Parameters:

appId - the application id

request - The AppDeploymentRequest

Returns:

the built id map of labels

buildAppStatus

protected org.springframework.cloud.deployer.spi.app.AppStatus buildAppStatus(String id,
                                                                              io.fabric8.kubernetes.api.model.PodList podList,
                                                                              io.fabric8.kubernetes.api.model.ServiceList services)

createPodSpec

protected io.fabric8.kubernetes.api.model.PodSpec createPodSpec(String appId,
                                                                org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request,
                                                                Integer port,
                                                                boolean neverRestart)

Create a PodSpec to be used for app and task deployments

Parameters:

appId - the app ID

request - app deployment request

port - port to use for app or null if none

neverRestart - use restart policy of Never

Returns:

the PodSpec

getVolumes

protected List<io.fabric8.kubernetes.api.model.Volume> getVolumes(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Volume deployment properties are specified in YAML format: spring.cloud.deployer.kubernetes.volumes=[{name: testhostpath, hostPath: { path: '/test/override/hostPath' }}, {name: 'testpvc', persistentVolumeClaim: { claimName: 'testClaim', readOnly: 'true' }}, {name: 'testnfs', nfs: { server: '10.0.0.1:111', path: '/test/nfs' }}] Volumes can be specified as deployer properties as well as app deployment properties. Deployment properties override deployer properties.

Parameters:

request - the AppDeploymentRequest

Returns:

the configured volumes

deduceResourceLimits

protected Map<String,io.fabric8.kubernetes.api.model.Quantity> deduceResourceLimits(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Get the resource limits for the deployment request. A Pod can define its maximum needed resources by setting the limits and Kubernetes can provide more resources if any are free.

Falls back to the server properties if not present in the deployment request.

Parameters:

request - The deployment properties.

Returns:

the resource limits to use

deduceImagePullPolicy

protected ImagePullPolicy deduceImagePullPolicy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Get the image pull policy for the deployment request. If it is not present use the server default. If an override for the deployment is present but not parseable, fall back to a default value.

Parameters:

request - The deployment request.

Returns:

The image pull policy to use for the container in the request.

deduceResourceRequests

protected Map<String,io.fabric8.kubernetes.api.model.Quantity> deduceResourceRequests(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Get the resource requests for the deployment request. Resource requests are guaranteed by the Kubernetes runtime. Falls back to the server properties if not present in the deployment request.

Parameters:

request - The deployment properties.

Returns:

the resource requests to use

getStatefulSetStorageClassName

protected String getStatefulSetStorageClassName(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

getStatefulSetStorage

protected String getStatefulSetStorage(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

getHostNetwork

protected boolean getHostNetwork(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Get the hostNetwork setting for the deployment request.

Parameters:

request - The deployment request.

Returns:

Whether host networking is requested

logPossibleDownloadResourceMessage

protected void logPossibleDownloadResourceMessage(org.springframework.core.io.Resource resource)