org.springframework.cloud.deployer.spi.cloudfoundry

Class CloudFoundryTaskLauncher

java.lang.Object

org.springframework.cloud.deployer.spi.cloudfoundry.CloudFoundryTaskLauncher

All Implemented Interfaces:

org.springframework.cloud.deployer.spi.task.TaskLauncher

public class CloudFoundryTaskLauncher
extends Object

TaskLauncher implementation for CloudFoundry. When a task is launched, if it has not previously been deployed, the app is created, the package is uploaded, and the droplet is created before launching the actual task. If the app has been deployed previously, the app/package/droplet is reused and a new task is created.

Author:

Greg Turnquist, Michael Minella, Ben Hale, Ilayaperumal Gopinathan, Glenn Renfro, David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER
protected org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo	runtimeEnvironmentInfo

Constructor Summary

Constructors

Constructor and Description
CloudFoundryTaskLauncher(org.cloudfoundry.client.CloudFoundryClient client, CloudFoundryDeploymentProperties deploymentProperties, org.cloudfoundry.operations.CloudFoundryOperations operations, org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo runtimeEnvironmentInfo)

Method Summary

Modifier and Type	Method and Description
void	cancel(String id) Setup a reactor flow to cancel a running task.
void	cleanup(String id)
protected void	deleteLocalApplicationResourceFile(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest appDeploymentRequest) Always delete downloaded files for static http resources.
void	destroy(String appName)
org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo	environmentInfo()
String	getCommand(org.cloudfoundry.client.v2.applications.SummaryApplicationResponse application, org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Creates the command string required to launch a task by a service on Cloud Foundry.
protected Map<String,String>	getEnvironmentVariables(String deploymentId, org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)
String	getLog(String taskAppName)
int	getMaximumConcurrentTasks()
int	getRunningTaskExecutionCount()
protected boolean	hasCfEnv(org.springframework.core.io.Resource resource)
String	launch(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest appDeploymentRequest) Set up a reactor flow to launch a task.
protected Consumer<Throwable>	logError(String msg) Return a function usable in doOnError constructs that will unwrap unrecognized Cloud Foundry Exceptions and log the text payload.
protected boolean	maxConcurrentExecutionsReached()
org.cloudfoundry.client.v2.applications.SummaryApplicationResponse	stage(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request) Set up a reactor flow to stage a task.
org.springframework.cloud.deployer.spi.task.TaskStatus	status(String id) Lookup the current status based on task id.
protected org.springframework.cloud.deployer.spi.task.TaskStatus	toTaskStatus(org.cloudfoundry.client.v3.tasks.GetTaskResponse response)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.deployer.spi.task.TaskLauncher

environmentInfo

Field Detail

OBJECT_MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

runtimeEnvironmentInfo

protected final org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo runtimeEnvironmentInfo

Constructor Detail

CloudFoundryTaskLauncher

public CloudFoundryTaskLauncher(org.cloudfoundry.client.CloudFoundryClient client,
                                CloudFoundryDeploymentProperties deploymentProperties,
                                org.cloudfoundry.operations.CloudFoundryOperations operations,
                                org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo runtimeEnvironmentInfo)

Method Detail

launch

public String launch(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest appDeploymentRequest)

Set up a reactor flow to launch a task. Before launch, check if the base application exists. If not, deploy then launch task.

Parameters:

appDeploymentRequest - description of the application to be launched

Returns:

name of the launched task, returned without waiting for reactor pipeline to complete

destroy

public void destroy(String appName)

Specified by:

destroy in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

getLog

public String getLog(String taskAppName)

stage

public org.cloudfoundry.client.v2.applications.SummaryApplicationResponse stage(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Set up a reactor flow to stage a task. Before staging check if the base application exists. If not, then stage it.

Parameters:

request - description of the application to be staged.

Returns:

SummaryApplicationResponse containing the status of the staging.

getCommand

public String getCommand(org.cloudfoundry.client.v2.applications.SummaryApplicationResponse application,
                         org.springframework.cloud.deployer.spi.core.AppDeploymentRequest request)

Creates the command string required to launch a task by a service on Cloud Foundry.

Parameters:

application - the SummaryApplicationResponse containing the result of the requested staging.

request - The AppDeploymentRequest associated with the task staging.

Returns:

the command string

cancel

public void cancel(String id)

Setup a reactor flow to cancel a running task. This implementation opts to be asynchronous.

Specified by:

cancel in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Parameters:

id - the task's id to be canceled as returned from the TaskLauncher.launch(AppDeploymentRequest)

status

public org.springframework.cloud.deployer.spi.task.TaskStatus status(String id)

Lookup the current status based on task id.

Specified by:

status in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

Parameters:

id - taskId as returned from the TaskLauncher.launch(AppDeploymentRequest)

Returns:

the current task status

getRunningTaskExecutionCount

public int getRunningTaskExecutionCount()

Specified by:

getRunningTaskExecutionCount in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

getMaximumConcurrentTasks

public int getMaximumConcurrentTasks()

Specified by:

getMaximumConcurrentTasks in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

maxConcurrentExecutionsReached

protected boolean maxConcurrentExecutionsReached()

toTaskStatus

protected org.springframework.cloud.deployer.spi.task.TaskStatus toTaskStatus(org.cloudfoundry.client.v3.tasks.GetTaskResponse response)

cleanup

public void cleanup(String id)

Specified by:

cleanup in interface org.springframework.cloud.deployer.spi.task.TaskLauncher

logError

protected Consumer<Throwable> logError(String msg)

Return a function usable in doOnError constructs that will unwrap unrecognized Cloud Foundry Exceptions and log the text payload.

deleteLocalApplicationResourceFile

protected void deleteLocalApplicationResourceFile(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest appDeploymentRequest)

Always delete downloaded files for static http resources. Conditionally delete maven resources.

Parameters:

appDeploymentRequest -

getEnvironmentVariables

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

hasCfEnv

protected boolean hasCfEnv(org.springframework.core.io.Resource resource)

environmentInfo

public org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo environmentInfo()