org.springframework.cloud.skipper.shell.command

Class SkipperCommands

java.lang.Object

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

org.springframework.cloud.skipper.shell.command.SkipperCommands

@ShellComponent
public class SkipperCommands
extends AbstractSkipperCommand

The main skipper commands that deal with packages and 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
SkipperCommands(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	delete(String releaseName)
org.springframework.shell.table.Table	history(String releaseName, String max)
String	install(String packageName, String packageVersion, File file, String properties, String releaseName, String platformName)
org.springframework.shell.table.Table	list(String releaseName)
String	rollback(String releaseName, int releaseVersion)
Object	search(String name, boolean details)
Object	status(String releaseName, Integer releaseVersion)
Object	upgrade(String releaseName, String packageName, String packageVersion, File file, String properties)
String	upload(String path, String repoName)

Methods inherited from class java.lang.Object

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

Constructor Detail

SkipperCommands

@Autowired
public SkipperCommands(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

search

@ShellMethod(key="search",
             value="Search for the packages.")
public Object search(@ShellOption(help="wildcard expression to search for the package name",defaultValue="__NULL__")
                                                                                               String name,
                                                                                               @ShellOption(help="boolean to set for more detailed package metadata")
                                                                                               boolean details)
                                                                                        throws Exception

Throws:

Exception

install

@ShellMethod(key="install",
             value="Install a package.")
public String install(@ShellOption(help="name of the package to install")
                                                                                           String packageName,
                                                                                           @ShellOption(help="version of the package to install, 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 comma separated set of properties to override during install",defaultValue="__NULL__")
                                                                                           String properties,
                                                                                           @ShellOption(help="the release name to use")
                                                                                           String releaseName,
                                                                                           @ShellOption(help="the platform name to use",defaultValue="default")
                                                                                           String platformName)
                                                                                    throws IOException

Throws:

IOException

upgrade

@ShellMethod(key="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 comma separated set of properties to override during upgrade",defaultValue="__NULL__")
                                                                                           String properties)
                                                                                    throws IOException

Throws:

IOException

rollback

@ShellMethod(key="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)

delete

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

upload

@ShellMethod(key="upload",
             value="Upload a package.")
public String upload(@ShellOption(help="the package to be uploaded")
                                                                                        String path,
                                                                                        @ShellOption(help="the local repository name to upload to",defaultValue="__NULL__")
                                                                                        String repoName)

list

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

history

@ShellMethod(key="history",
             value="List the history of versions for a given release.")
public org.springframework.shell.table.Table history(@ShellOption(help="wildcard expression to search by release name") @NotNull
                                                                                                                                                         String releaseName,
                                                                                                                                                         @ShellOption(help="maximum number of revisions to include in the history",defaultValue="__NULL__")
                                                                                                                                                         String max)

status

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