org.springframework.cloud.skipper.server.deployer

Interface ReleaseManager

All Known Implementing Classes:

DefaultReleaseManager

public interface ReleaseManager

Manages the lifecycle of a releases. The current implementation is a simple sequence of AppDeployer commands, but more sophisticated implementations based on Spring Cloud State Machine are possible.

Author:

Mark Pollack, Ilayaperumal Gopinathan

Method Summary

Modifier and Type	Method and Description
ReleaseAnalysisReport	createReport(org.springframework.cloud.skipper.domain.Release existingRelease, org.springframework.cloud.skipper.domain.Release replacingRelease, boolean initial, boolean isForceUpdate, List<String> appNamesToUpgrade) Create a report of what apps should be updated and deleted upon upgrade.
org.springframework.cloud.skipper.domain.Release	delete(org.springframework.cloud.skipper.domain.Release release) Delete the release
reactor.core.publisher.Mono<Map<String,Map<String,org.springframework.cloud.deployer.spi.app.DeploymentState>>>	deploymentState(List<org.springframework.cloud.skipper.domain.Release> releases)
org.springframework.cloud.skipper.domain.LogInfo	getLog(org.springframework.cloud.skipper.domain.Release release) Get the logs of the applications inside the release.
org.springframework.cloud.skipper.domain.LogInfo	getLog(org.springframework.cloud.skipper.domain.Release release, String appName) Get the logs of a specific application inside the release.
Collection<String>	getSupportedKinds() Return a supported application kinds.
org.springframework.cloud.skipper.domain.Release	install(org.springframework.cloud.skipper.domain.Release release) Install the requested release.
org.springframework.cloud.skipper.domain.Release	scale(org.springframework.cloud.skipper.domain.Release release, org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest) Scale a release and return an original release.
org.springframework.cloud.skipper.domain.Release	status(org.springframework.cloud.skipper.domain.Release release) Get the status of the release, by querying the database.
reactor.core.publisher.Mono<org.springframework.cloud.skipper.domain.Release>	statusReactive(org.springframework.cloud.skipper.domain.Release release) Get the status of the release, by querying the database.

Method Detail

getSupportedKinds

Collection<String> getSupportedKinds()

Return a supported application kinds.

Returns:

supported application kinds

install

org.springframework.cloud.skipper.domain.Release install(org.springframework.cloud.skipper.domain.Release release)

Install the requested release.

Parameters:

release - the requested release

Returns:

the release object after requesting installation

createReport

ReleaseAnalysisReport createReport(org.springframework.cloud.skipper.domain.Release existingRelease,
                                   org.springframework.cloud.skipper.domain.Release replacingRelease,
                                   boolean initial,
                                   boolean isForceUpdate,
                                   List<String> appNamesToUpgrade)

Create a report of what apps should be updated and deleted upon upgrade. The return value is expected to be passed into the update method.

Parameters:

existingRelease - the existing release that is deployed

replacingRelease - the release that is to be deployed in place of the existing release

initial - the flag indicating this is initial report creation

isForceUpdate - the flag indicating the upgrade is by force

appNamesToUpgrade - the application names to force upgrade

Returns:

a report describing the actions to take to update

delete

org.springframework.cloud.skipper.domain.Release delete(org.springframework.cloud.skipper.domain.Release release)

Delete the release

Parameters:

release - the release to delete

Returns:

the updated release object after deltion

status

org.springframework.cloud.skipper.domain.Release status(org.springframework.cloud.skipper.domain.Release release)

Get the status of the release, by querying the database. The ReleaseStateUpdateService is scheduled ot update the state in the database periodically.

Parameters:

release - the release to update state for

Returns:

the updated release

statusReactive

reactor.core.publisher.Mono<org.springframework.cloud.skipper.domain.Release> statusReactive(org.springframework.cloud.skipper.domain.Release release)

Get the status of the release, by querying the database. The ReleaseStateUpdateService is scheduled ot update the state in the database periodically.

Parameters:

release - the release to update state for

Returns:

the updated release

deploymentState

reactor.core.publisher.Mono<Map<String,Map<String,org.springframework.cloud.deployer.spi.app.DeploymentState>>> deploymentState(List<org.springframework.cloud.skipper.domain.Release> releases)

getLog

org.springframework.cloud.skipper.domain.LogInfo getLog(org.springframework.cloud.skipper.domain.Release release)

Get the logs of the applications inside the release.

Parameters:

release - the release

Returns:

the log content

getLog

org.springframework.cloud.skipper.domain.LogInfo getLog(org.springframework.cloud.skipper.domain.Release release,
                                                        String appName)

Get the logs of a specific application inside the release.

Parameters:

release - the release

appName - the application name

Returns:

the log content

scale

org.springframework.cloud.skipper.domain.Release scale(org.springframework.cloud.skipper.domain.Release release,
                                                       org.springframework.cloud.skipper.domain.ScaleRequest scaleRequest)

Scale a release and return an original release.

Parameters:

release -

scaleRequest -

Returns:

the original release