public interface AppDeployer
tasks
.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.
|
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.
|
AppStatus |
status(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.
|
static final String PREFIX
static final String COUNT_PROPERTY_KEY
static final String GROUP_PROPERTY_KEY
static final String INDEXED_PROPERTY_KEY
static final String INSTANCE_INDEX_PROPERTY_KEY
INDEXED_PROPERTY_KEY
,
Constant Field Valuesstatic final String MEMORY_PROPERTY_KEY
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.
ByteSizeUtils
,
Constant Field Valuesstatic final String DISK_PROPERTY_KEY
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.
ByteSizeUtils
,
Constant Field Valuesstatic final String CPU_PROPERTY_KEY
String deploy(AppDeploymentRequest request)
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)
.request
- the app deployment requestIllegalStateException
- if the app has already been deployedvoid undeploy(String id)
status(String)
.id
- the app deployment id, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)
IllegalStateException
- if the app has not been deployedAppStatus status(String id)
AppStatus
for an app represented by a deployment id.id
- the app deployment id, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)
RuntimeEnvironmentInfo environmentInfo()
Copyright © 2019 Pivotal Software, Inc.. All rights reserved.