org.springframework.cloud.deployer.spi.app

Interface AppDeployer

All Known Subinterfaces:

MultiStateAppDeployer

public interface AppDeployer

SPI defining a runtime environment capable of deploying and managing the lifecycle of apps that are intended to run indefinitely (until undeployed), as opposed to tasks.

Author:

Mark Fisher, Patrick Peralta, Marius Bogoevici, Janne Valkealahti, Thomas Risberg, Ilayaperumal Gopinathan, David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNT_PROPERTY_KEY The deployment property for the count (number of app instances).
static String	CPU_PROPERTY_KEY The deployment property for the cpu setting for the container that will run the app.
static String	DISK_PROPERTY_KEY The deployment property for the disk setting for the container that will run the app.
static String	GROUP_PROPERTY_KEY The deployment property for the group to which an app belongs.
static String	INDEXED_PROPERTY_KEY The deployment property that indicates if each app instance should have an index value within a sequence from 0 to N-1, where N is the value of the "spring.cloud.deployer.count" property.
static String	INSTANCE_INDEX_PROPERTY_KEY The property to be set at each instance level to specify the sequence number amongst 0 to N-1, where N is the value of the "spring.cloud.deployer.count" property.
static String	MEMORY_PROPERTY_KEY The deployment property for the memory setting for the container that will run the app.
static String	PREFIX Common prefix used for deployment properties.

Method Summary

Modifier and Type	Method and Description
String	deploy(AppDeploymentRequest request) Deploy an app using an AppDeploymentRequest.
RuntimeEnvironmentInfo	environmentInfo() Return the environment info for this deployer.
default String	getLog(String id) Return the log of the application identified by the deployment id.
default void	scale(AppScaleRequest appScaleRequest) Scale an app according to given values.
AppStatus	status(String id) Return the AppStatus for an app represented by a deployment id.
default reactor.core.publisher.Flux<AppStatus>	statusesReactive(String... ids) Return the AppStatuss for an app represented by a deployment ids.
default reactor.core.publisher.Mono<AppStatus>	statusReactive(String id) Return the AppStatus for an app represented by a deployment id.
void	undeploy(String id) Un-deploy an app using its deployment id.

Field Detail

PREFIX

static final String PREFIX

Common prefix used for deployment properties.

See Also:

Constant Field Values

COUNT_PROPERTY_KEY

static final String COUNT_PROPERTY_KEY

The deployment property for the count (number of app instances). If not provided, a deployer should assume 1 instance.

See Also:

Constant Field Values

GROUP_PROPERTY_KEY

static final String GROUP_PROPERTY_KEY

The deployment property for the group to which an app belongs. If not provided, a deployer should assume no group.

See Also:

Constant Field Values

INDEXED_PROPERTY_KEY

static final String INDEXED_PROPERTY_KEY

The deployment property that indicates if each app instance should have an index value within a sequence from 0 to N-1, where N is the value of the "spring.cloud.deployer.count" property. If not provided, a deployer should assume app instance indexing is not necessary.

See Also:

Constant Field Values

INSTANCE_INDEX_PROPERTY_KEY

static final String INSTANCE_INDEX_PROPERTY_KEY

The property to be set at each instance level to specify the sequence number amongst 0 to N-1, where N is the value of the "spring.cloud.deployer.count" property. Specified as CAPITAL_WITH_UNDERSCORES as this is typically passed as an environment variable, but when targeting a Spring app, other variations may apply.

See Also:

INDEXED_PROPERTY_KEY, Constant Field Values

MEMORY_PROPERTY_KEY

static final String MEMORY_PROPERTY_KEY

The deployment property for the memory setting for the container that will run the app. The memory is specified in Mebibytes, by default, with optional case-insensitive trailing unit 'm' and 'g' being supported, for mebi- and giga- respectively.

1 MiB = 2^20 bytes = 1024*1024 bytes vs. the decimal based 1MB = 10^6 bytes = 1000*1000 bytes,

Implementations are expected to translate this value to the target platform as faithfully as possible.

See Also:

ByteSizeUtils, Constant Field Values

DISK_PROPERTY_KEY

static final String DISK_PROPERTY_KEY

The deployment property for the disk setting for the container that will run the app. The memory is specified in Mebibytes, by default, with optional case-insensitive trailing unit 'm' and 'g' being supported, for mebi- and giga- respectively.

1 MiB = 2^20 bytes = 1024*1024 bytes vs. the decimal based 1MB = 10^6 bytes = 1000*1000 bytes,

Implementations are expected to translate this value to the target platform as faithfully as possible.

See Also:

ByteSizeUtils, Constant Field Values

CPU_PROPERTY_KEY

static final String CPU_PROPERTY_KEY

The deployment property for the cpu setting for the container that will run the app. The cpu is specified as whole multiples or decimal fractions of virtual cores. Some platforms will not support setting cpu and will ignore this setting. Other platforms may require whole numbers and might round up. Exactly how this property affects the deployments will vary between implementations.

See Also:

Constant Field Values

Method Detail

deploy

String deploy(AppDeploymentRequest request)

Deploy an app using an AppDeploymentRequest. The returned id is later used with undeploy(String) or status(String) to undeploy an app or check its status, respectively. Implementations may perform this operation asynchronously; therefore a successful deployment may not be assumed upon return. To determine the status of a deployment, invoke status(String).

Parameters:

request - the app deployment request

Returns:

the deployment id for the app

Throws:

IllegalStateException - if the app has already been deployed

undeploy

void undeploy(String id)

Un-deploy an app using its deployment id. Implementations may perform this operation asynchronously; therefore a successful un-deployment may not be assumed upon return. To determine the status of a deployment, invoke status(String).

Parameters:

id - the app deployment id, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)

Throws:

IllegalStateException - if the app has not been deployed

status

AppStatus status(String id)

Return the AppStatus for an app represented by a deployment id.

Parameters:

id - the app deployment id, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)

Returns:

the app deployment status

statusReactive

default reactor.core.publisher.Mono<AppStatus> statusReactive(String id)

Return the AppStatus for an app represented by a deployment id.

Parameters:

id - the app deployment id, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)

Returns:

the app deployment status

statusesReactive

default reactor.core.publisher.Flux<AppStatus> statusesReactive(String... ids)

Return the AppStatuss for an app represented by a deployment ids.

Parameters:

ids - the app deployment ids, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)

Returns:

the app deployment statuses

environmentInfo

RuntimeEnvironmentInfo environmentInfo()

Return the environment info for this deployer.

Returns:

the runtime environment info

getLog

default String getLog(String id)

Return the log of the application identified by the deployment id.

Parameters:

id - the id of the deployment.

Returns:

the application log

scale

default void scale(AppScaleRequest appScaleRequest)

Scale an app according to given values.

Parameters:

appScaleRequest - an AppScaleRequest.