org.springframework.cloud.deployer.spi.kubernetes

Class DeploymentPropertiesResolver

java.lang.Object

org.springframework.cloud.deployer.spi.kubernetes.DeploymentPropertiesResolver

public class DeploymentPropertiesResolver
extends Object

Class that resolves the appropriate deployment properties based on the property prefix being used. Currently, both the Deployer/TaskLauncher and the Scheduler use this resolver to retrieve the deployment properties for the given Kubernetes deployer properties.

Author:

Chris Schaefer, Ilayaperumal Gopinathan

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	STATEFUL_SET_IMAGE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeploymentPropertiesResolver(String propertyPrefix, KubernetesDeployerProperties properties)

Method Summary

Modifier and Type	Method and Description
protected static KubernetesDeployerProperties	bindProperties(Map<String,String> kubernetesDeployerProperties, String propertyKey, String yamlLabel) Binds the YAML formatted value of a deployment property to a KubernetesDeployerProperties instance.
protected ImagePullPolicy	deduceImagePullPolicy(Map<String,String> kubernetesDeployerProperties) Get the image pull policy for the deployment request.
protected Map<String,io.fabric8.kubernetes.api.model.Quantity>	deduceResourceLimits(Map<String,String> kubernetesDeployerProperties) Get the resource limits for the deployment request.
protected Map<String,io.fabric8.kubernetes.api.model.Quantity>	deduceResourceRequests(Map<String,String> kubernetesDeployerProperties) Get the resource requests for the deployment request.
protected EntryPointStyle	determineEntryPointStyle(Map<String,String> deploymentProperties)
protected io.fabric8.kubernetes.api.model.Affinity	getAffinityRules(Map<String,String> kubernetesDeployerProperties)
protected Map<String,String>	getAppEnvironmentVariables(Map<String,String> deploymentProperties)
protected List<io.fabric8.kubernetes.api.model.EnvVar>	getConfigMapKeyRefs(Map<String,String> deploymentProperties)
protected List<String>	getContainerCommand(Map<String,String> deploymentProperties) The list represents a single command with many arguments.
protected List<Integer>	getContainerPorts(Map<String,String> deploymentProperties)
protected Map<String,String>	getDeploymentLabels(Map<String,String> kubernetesDeployerProperties)
protected String	getDeploymentServiceAccountName(Map<String,String> kubernetesDeployerProperties)
protected boolean	getHostNetwork(Map<String,String> kubernetesDeployerProperties) Get the hostNetwork setting for the deployment request.
protected String	getImagePullSecret(Map<String,String> kubernetesDeployerProperties)
protected io.fabric8.kubernetes.api.model.Container	getInitContainer(Map<String,String> kubernetesDeployerProperties)
protected Map<String,String>	getJobAnnotations(Map<String,String> kubernetesDeployerProperties)
protected Map<String,String>	getNodeSelectors(Map<String,String> deploymentProperties) Get the nodeSelectors setting for the deployment request.
protected Map<String,String>	getPodAnnotations(Map<String,String> kubernetesDeployerProperties)
protected io.fabric8.kubernetes.api.model.PodSecurityContext	getPodSecurityContext(Map<String,String> kubernetesDeployerProperties)
protected String	getPropertyPrefix()
protected RestartPolicy	getRestartPolicy(Map<String,String> kubernetesDeployerProperties)
protected List<io.fabric8.kubernetes.api.model.EnvVar>	getSecretKeyRefs(Map<String,String> deploymentProperties)
protected Map<String,String>	getServiceAnnotations(Map<String,String> kubernetesDeployerProperties)
protected String	getStatefulSetInitContainerImageName(Map<String,String> kubernetesDeployerProperties)
protected String	getStatefulSetStorage(Map<String,String> kubernetesDeployerProperties) Get the StatefulSet storage value to be set in VolumeClaim template for the given deployment properties.
protected String	getStatefulSetStorageClassName(Map<String,String> kubernetesDeployerProperties) Get the StatefulSet storage class name to be set in VolumeClaim template for the deployment properties.
protected String	getTaskServiceAccountName(Map<String,String> kubernetesDeployerProperties)
protected List<io.fabric8.kubernetes.api.model.Toleration>	getTolerations(Map<String,String> kubernetesDeployerProperties)
protected List<io.fabric8.kubernetes.api.model.VolumeMount>	getVolumeMounts(Map<String,String> deploymentProperties) Volume mount deployment properties are specified in YAML format:
protected List<io.fabric8.kubernetes.api.model.Volume>	getVolumes(Map<String,String> kubernetesDeployerProperties) 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.

Methods inherited from class java.lang.Object

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

Field Detail

STATEFUL_SET_IMAGE_NAME

protected static final String STATEFUL_SET_IMAGE_NAME

See Also:

Constant Field Values

Constructor Detail

DeploymentPropertiesResolver

protected DeploymentPropertiesResolver(String propertyPrefix,
                                       KubernetesDeployerProperties properties)

Method Detail

getPropertyPrefix

protected String getPropertyPrefix()

getTolerations

protected List<io.fabric8.kubernetes.api.model.Toleration> getTolerations(Map<String,String> kubernetesDeployerProperties)

getVolumes

protected List<io.fabric8.kubernetes.api.model.Volume> getVolumes(Map<String,String> kubernetesDeployerProperties)

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:

kubernetesDeployerProperties - the kubernetes deployer properties map

Returns:

the configured volumes

deduceResourceLimits

protected Map<String,io.fabric8.kubernetes.api.model.Quantity> deduceResourceLimits(Map<String,String> kubernetesDeployerProperties)

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:

kubernetesDeployerProperties - the kubernetes deployment properties map

Returns:

the resource limits to use

deduceImagePullPolicy

protected ImagePullPolicy deduceImagePullPolicy(Map<String,String> kubernetesDeployerProperties)

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:

kubernetesDeployerProperties - the kubernetes deployment properties map

Returns:

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

deduceResourceRequests

protected Map<String,io.fabric8.kubernetes.api.model.Quantity> deduceResourceRequests(Map<String,String> kubernetesDeployerProperties)

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:

kubernetesDeployerProperties - the kubernetes deployer properties map

Returns:

the resource requests to use

getStatefulSetStorageClassName

protected String getStatefulSetStorageClassName(Map<String,String> kubernetesDeployerProperties)

Get the StatefulSet storage class name to be set in VolumeClaim template for the deployment properties.

Parameters:

kubernetesDeployerProperties - the kubernetes deployer properties

Returns:

the storage class name

getStatefulSetStorage

protected String getStatefulSetStorage(Map<String,String> kubernetesDeployerProperties)

Get the StatefulSet storage value to be set in VolumeClaim template for the given deployment properties.

Parameters:

kubernetesDeployerProperties - the kubernetes deployer properties

Returns:

the StatefulSet storage

getHostNetwork

protected boolean getHostNetwork(Map<String,String> kubernetesDeployerProperties)

Get the hostNetwork setting for the deployment request.

Parameters:

kubernetesDeployerProperties - the kubernetes deployment properties map

Returns:

Whether host networking is requested

getNodeSelectors

protected Map<String,String> getNodeSelectors(Map<String,String> deploymentProperties)

Get the nodeSelectors setting for the deployment request.

Parameters:

deploymentProperties - The deployment request deployment properties.

Returns:

map of nodeSelectors

getImagePullSecret

protected String getImagePullSecret(Map<String,String> kubernetesDeployerProperties)

getDeploymentServiceAccountName

protected String getDeploymentServiceAccountName(Map<String,String> kubernetesDeployerProperties)

getPodSecurityContext

protected io.fabric8.kubernetes.api.model.PodSecurityContext getPodSecurityContext(Map<String,String> kubernetesDeployerProperties)

getAffinityRules

protected io.fabric8.kubernetes.api.model.Affinity getAffinityRules(Map<String,String> kubernetesDeployerProperties)

getInitContainer

protected io.fabric8.kubernetes.api.model.Container getInitContainer(Map<String,String> kubernetesDeployerProperties)

getPodAnnotations

protected Map<String,String> getPodAnnotations(Map<String,String> kubernetesDeployerProperties)

getServiceAnnotations

protected Map<String,String> getServiceAnnotations(Map<String,String> kubernetesDeployerProperties)

getDeploymentLabels

protected Map<String,String> getDeploymentLabels(Map<String,String> kubernetesDeployerProperties)

getRestartPolicy

protected RestartPolicy getRestartPolicy(Map<String,String> kubernetesDeployerProperties)

getTaskServiceAccountName

protected String getTaskServiceAccountName(Map<String,String> kubernetesDeployerProperties)

bindProperties

protected static KubernetesDeployerProperties bindProperties(Map<String,String> kubernetesDeployerProperties,
                                                             String propertyKey,
                                                             String yamlLabel)

Binds the YAML formatted value of a deployment property to a KubernetesDeployerProperties instance.

Parameters:

kubernetesDeployerProperties - the map of Kubernetes deployer properties

propertyKey - the property key to obtain the value to bind for

yamlLabel - the label representing the field to bind to

Returns:

a KubernetesDeployerProperties with the bound property data

getStatefulSetInitContainerImageName

protected String getStatefulSetInitContainerImageName(Map<String,String> kubernetesDeployerProperties)

getJobAnnotations

protected Map<String,String> getJobAnnotations(Map<String,String> kubernetesDeployerProperties)

getVolumeMounts

protected List<io.fabric8.kubernetes.api.model.VolumeMount> getVolumeMounts(Map<String,String> deploymentProperties)

Volume mount deployment properties are specified in YAML format:

spring.cloud.deployer.kubernetes.volumeMounts=[{name: 'testhostpath', mountPath: '/test/hostPath'}, {name: 'testpvc', mountPath: '/test/pvc'}, {name: 'testnfs', mountPath: '/test/nfs'}]

Volume mounts can be specified as deployer properties as well as app deployment properties. Deployment properties override deployer properties.

Parameters:

deploymentProperties - the deployment properties from AppDeploymentRequest

Returns:

the configured volume mounts

getContainerCommand

protected List<String> getContainerCommand(Map<String,String> deploymentProperties)

The list represents a single command with many arguments.

Parameters:

deploymentProperties - the kubernetes deployer properties map

Returns:

a list of strings that represents the command and any arguments for that command

getContainerPorts

protected List<Integer> getContainerPorts(Map<String,String> deploymentProperties)

Parameters:

deploymentProperties - the kubernetes deployer properties map

Returns:

a list of Integers to add to the container

getAppEnvironmentVariables

protected Map<String,String> getAppEnvironmentVariables(Map<String,String> deploymentProperties)

Parameters:

deploymentProperties - the kubernetes deployer properties map

Returns:

a List of EnvVar objects for app specific environment settings

determineEntryPointStyle

protected EntryPointStyle determineEntryPointStyle(Map<String,String> deploymentProperties)

getConfigMapKeyRefs

protected List<io.fabric8.kubernetes.api.model.EnvVar> getConfigMapKeyRefs(Map<String,String> deploymentProperties)

getSecretKeyRefs

protected List<io.fabric8.kubernetes.api.model.EnvVar> getSecretKeyRefs(Map<String,String> deploymentProperties)