org.springframework.cloud.skipper.shell.command

Class ReleaseCommands

java.lang.Object

org.springframework.cloud.skipper.shell.command.AbstractSkipperCommand

org.springframework.cloud.skipper.shell.command.ReleaseCommands

@ShellComponent
public class ReleaseCommands
extends AbstractSkipperCommand

The main skipper commands that deal with releases.

Author:

Ilayaperumal Gopinathan, Mark Pollack

Field Summary

Fields inherited from class org.springframework.cloud.skipper.shell.command.AbstractSkipperCommand

skipperClient

Constructor Summary

Constructors

Constructor and Description
ReleaseCommands(SkipperClient skipperClient)

Method Summary

Modifier and Type	Method and Description
static org.springframework.cloud.deployer.spi.app.DeploymentState	aggregateState(List<org.springframework.cloud.deployer.spi.app.DeploymentState> states) Aggregate the set of app states into a single state for a stream.
String	cancel(String releaseName)
String	delete(String releaseName, boolean deletePackage)
Table	history(@NotNull String releaseName)
Table	list(String releaseName)
String	rollback(String releaseName, int releaseVersion, String timeoutExpression)
Object	status(@NotNull String releaseName, Integer releaseVersion)
Object	upgrade(String releaseName, String packageName, String packageVersion, File file, String timeoutExpression, String properties, boolean force, String appNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReleaseCommands

@Autowired
public ReleaseCommands(SkipperClient skipperClient)

Method Detail

aggregateState

public static org.springframework.cloud.deployer.spi.app.DeploymentState aggregateState(List<org.springframework.cloud.deployer.spi.app.DeploymentState> states)

Aggregate the set of app states into a single state for a stream.

Parameters:

states - set of states for apps of a stream

Returns:

the stream state based on app states

upgrade

@ShellMethod(key="release upgrade",
             value="Upgrade a release.")
public Object upgrade(@ShellOption(help="the name of the release to upgrade")
                                                                                                   String releaseName,
                                                                                                   @ShellOption(help="the name of the package to use for the upgrade")
                                                                                                   String packageName,
                                                                                                   @ShellOption(help="the version of the package to use for the upgrade, if not specified latest version will be used",defaultValue="__NULL__")
                                                                                                   String packageVersion,
                                                                                                   @ShellOption(help="specify values in a YAML file",defaultValue="__NULL__")
                                                                                                   File file,
                                                                                                   @ShellOption(help="the expression for upgrade timeout",defaultValue="__NULL__")
                                                                                                   String timeoutExpression,
                                                                                                   @ShellOption(help="the comma separated set of properties to override during upgrade",defaultValue="__NULL__")
                                                                                                   String properties,
                                                                                                   @ShellOption(help="force upgrade")
                                                                                                   boolean force,
                                                                                                   @ShellOption(help="application names to force upgrade. If no specific list is provided, all the apps in the packages are force upgraded",defaultValue="__NULL__")
                                                                                                   String appNames)
                                                                                            throws IOException

Throws:

IOException

rollback

@ShellMethod(key="release rollback",
             value="Rollback the release to a previous or a specific release.")
public String rollback(@ShellOption(help="the name of the release to rollback")
                                                                                                                                            String releaseName,
                                                                                                                                            @ShellOption(help="the specific release version to rollback to. Not specifying the value rolls back to the previous release.",defaultValue="0")
                                                                                                                                            int releaseVersion,
                                                                                                                                            @ShellOption(help="the expression for rollback timeout",defaultValue="__NULL__")
                                                                                                                                            String timeoutExpression)

delete

@ShellMethod(key="release delete",
             value="Delete the release.")
public String delete(@ShellOption(help="the name of the release to delete")
                                                                                                  String releaseName,
                                                                                                  @ShellOption(help="delete the release package",defaultValue="false")
                                                                                                  boolean deletePackage)

cancel

@ShellMethod(key="release cancel",
             value="Request a cancellation of current release operation.")
public String cancel(@ShellOption(help="the name of the release to cancel")
                                                                                                                                   String releaseName)

list

@ShellMethod(key="release list",
             value="List the latest version of releases with status of deployed or failed.")
public Table list(@ShellOption(help="wildcard expression to search by release name",defaultValue="__NULL__")
                                                                                                                                                String releaseName)

history

@ShellMethod(key="release history",
             value="List the history of versions for a given release.")
public Table history(@ShellOption(help="wildcard expression to search by release name") @NotNull
                                                                                                                                 @NotNull String releaseName)

status

@ShellMethod(key="release status",
             value="Status for a last known release version.")
public Object status(@ShellOption(help="release name") @NotNull
                                                                                                                       @NotNull String releaseName,
                                                                                                                       @ShellOption(help="the specific release version.",defaultValue="__NULL__")
                                                                                                                       Integer releaseVersion)