The command search shows all the packages available to be installed by the Skipper server.
skipper:>search ╔═════════════════╤═══════╤════════════════════════════════════════════════════════════════════════════════╗ ║ Name │Version│ Description ║ ╠═════════════════╪═══════╪════════════════════════════════════════════════════════════════════════════════╣ ║helloworld │1.0.0 │The app has two endpoints, /about and /greeting in English. Maven resource. ║ ║helloworld │1.0.1 │The app has two endpoints, /about and /greeting in Portuguese. Maven resource. ║ ║helloworld-docker│1.0.1 │The app has two endpoints, /about and /greeting in Portuguese. Docker resource.║ ║helloworld-docker│1.0.0 │The app has two endpoints, /about and /greeting in English. Docker resource. ║ ╚═════════════════╧═══════╧════════════════════════════════════════════════════════════════════════════════╝
The search command can use --name option to search for the package name containing the given option value.
skipper:>search --name helloworld- ╔═════════════════╤═══════╤════════════════════════════════════════════════════════════════════════════════╗ ║ Name │Version│ Description ║ ╠═════════════════╪═══════╪════════════════════════════════════════════════════════════════════════════════╣ ║helloworld-docker│1.0.0 │The app has two endpoints, /about and /greeting in English. Docker resource. ║ ║helloworld-docker│1.0.1 │The app has two endpoints, /about and /greeting in Portuguese. Docker resource.║ ╚═════════════════╧═══════╧════════════════════════════════════════════════════════════════════════════════╝
To search for more details of the packages, the option --details can be used.
skipper:>search --name helloworld- --details ╔════════════════╤═════════════════════════════════════════════════════════════════════════════╗ ║ Name │ Value ║ ╠════════════════╪═════════════════════════════════════════════════════════════════════════════╣ ║apiVersion │v1 ║ ║origin │A sample repository for using Skipper ║ ║repositoryId │1 ║ ║kind │skipper ║ ║name │helloworld-docker ║ ║version │1.0.0 ║ ║packageSourceUrl│https://github.com/markpollack/skipper-sample-repository ║ ║packageHomeUrl │https://github.com/markpollack/skipper-sample-repository ║ ║tags │web, demo, docker, helloworld ║ ║maintainer │https://github.com/markpollack ║ ║description │The app has two endpoints, /about and /greeting in English. Docker resource.║ ║sha256 │ ║ ║iconUrl │ ║ ╚════════════════╧═════════════════════════════════════════════════════════════════════════════╝ ╔════════════════╤════════════════════════════════════════════════════════════════════════════════╗ ║ Name │ Value ║ ╠════════════════╪════════════════════════════════════════════════════════════════════════════════╣ ║apiVersion │v1 ║ ║origin │A sample repository for using Skipper ║ ║repositoryId │1 ║ ║kind │skipper ║ ║name │helloworld-docker ║ ║version │1.0.1 ║ ║packageSourceUrl│https://github.com/markpollack/skipper-sample-repository ║ ║packageHomeUrl │https://github.com/markpollack/skipper-sample-repository ║ ║tags │web, demo, docker, helloworld ║ ║maintainer │https://github.com/markpollack ║ ║description │The app has two endpoints, /about and /greeting in Portuguese. Docker resource.║ ║sha256 │ ║ ║iconUrl │ ║ ╚════════════════╧════════════════════════════════════════════════════════════════════════════════╝
This command installs a package.
skipper:>install --release-name helloworldlocal --package-name helloworld --package-version 1.0.0 --properties spec.applicationProperties.server.port=8099 Released helloworldlocal. Now at version v1.
If no package-version is specified, then the latest package version by the given package-name will be considered.
If no platform-name is specified, the platform name default will be used.
The properties can either be provided via comma separated YAML String using the --properties option or, via a YAML
file using the --file option.
This command upgrades a package.
skipper:>upgrade --release-name helloworldlocal --package-name helloworld --package-version 1.0.0 --properties spec.applicationProperties.server.port=9090 helloworldpcf has been upgraded. Now at version v2.
If no package-version is specified, then the latest package version by the given package-name will be considered.
The properties can either be provided via comma separated YAML String using the --properties option or, via a YAML
file using the --file option.
![[Note]](images/note.png) | Note |
|---|---|
An upgrade can be done by overriding the package version or by keeping the existing package version but by
overriding the properties. When overriding the package version, it needs to accompany with the corresponding
properties as the existing properties won’t be carried over.
In a future release we will introduce a |
When performing an update on a package that contains nested packages, use the name of the package as a prefix in the property string or as the first level in the YAML document.
For example, the ticktock package that contains a time and a log application, a command to upgrade the log application would be
skipper:>upgrade --release-name ticktockskipper --package-name ticktock --file /home/mpollack/log-level-change.yml
where log-level-change.yml is
log: version: 1.1.1.RELEASE spec: applicationProperties: server.port: 9999 endpoints.sensitive: false log.level: ERROR
Since it is quite a common use-case to change only the version of the application, the packages can list the version as a top level property in the values.yml file. For example, in the test package ticktock (located here), values.yml is
version: 1.1.0.RELEASE spec: applicationProperties: log.level: DEBUG deploymentProperties: memory: 1024m
You can then use the --properties option in the upgrade command as shown below
skipper:>upgrade --release-name ticktockskipper --package-name ticktock --properties log.version=1.1.1.RELEASE
This command shows the status of a specific release and version.
skipper:>status --release-name helloworldlocal ╔═══════════════╤═══════════════════════════════════════════════════════════════════════════════════╗ ║Last Deployed │Mon Oct 30 17:53:50 IST 2017 ║ ║Status │DEPLOYED ║ ║Platform Status│All applications have been successfully deployed. ║ ║ │[helloworldlocal.helloworld-v2], State = [helloworldlocal.helloworld-v2-0=deployed]║ ╚═══════════════╧═══════════════════════════════════════════════════════════════════════════════════╝
If no --release-version specifed, then the latest release version will be used.
skipper:>status --release-name helloworldlocal --release-version 1 ╔═══════════════╤════════════════════════════════════════════════════════════════════════╗ ║Last Deployed │Mon Oct 30 17:52:57 IST 2017 ║ ║Status │DELETED ║ ║Platform Status│The applications are known to the system, but is not currently deployed.║ ║ │[helloworldlocal.helloworld-v1], State = [unknown] ║ ╚═══════════════╧════════════════════════════════════════════════════════════════════════╝
This command rollsback the release to a specific version.
skipper:>rollback --release-name helloworldlocal --release-version 1
helloworldlocal has been rolled back. Now at version v3.If no --release-version specified, then the rollback version is the previous stable release (either in DELETED or
DEPLOYED status).
This command lists the latest deployed or failed release.
skipper:>list ╔═══════════════╤═══════╤═════════════════════════╤════════╤═══════════╤══════════════╤════════════╤══════════════════════════════════════════════════════════════════════════════╗ ║ Name │Version│ Last updated │ Status │ Package │ Package │ Platform │ Platform Status ║ ║ │ │ │ │ Name │ Version │ Name │ ║ ╠═══════════════╪═══════╪═════════════════════════╪════════╪═══════════╪══════════════╪════════════╪══════════════════════════════════════════════════════════════════════════════╣ ║helloworldlocal│3 │Mon Oct 30 17:57:41 IST │DEPLOYED│helloworld │1.0.0 │default │[helloworldlocal.helloworld-v3], State = ║ ║ │ │2017 │ │ │ │ │[helloworldlocal.helloworld-v3-0=deployed] ║ ╚═══════════════╧═══════╧═════════════════════════╧════════╧═══════════╧══════════════╧════════════╧══════════════════════════════════════════════════════════════════════════════╝
This command shows the history of a specific release.
skipper:>history --release-name helloworldlocal ╔═══════╤════════════════════════════╤════════╤════════════╤═══════════════╤════════════════╗ ║Version│ Last updated │ Status │Package Name│Package Version│ Description ║ ╠═══════╪════════════════════════════╪════════╪════════════╪═══════════════╪════════════════╣ ║3 │Mon Oct 30 17:57:41 IST 2017│DEPLOYED│helloworld │1.0.0 │Upgrade complete║ ║2 │Mon Oct 30 17:53:50 IST 2017│DELETED │helloworld │1.0.0 │Delete complete ║ ║1 │Mon Oct 30 17:52:57 IST 2017│DELETED │helloworld │1.0.0 │Delete complete ║ ╚═══════╧════════════════════════════╧════════╧════════════╧═══════════════╧════════════════╝
The number of revisions in the history result can be limited using --max option. For instance,
skipper:>history --release-name helloworldlocal --max 2 ╔═══════╤════════════════════════════╤════════╤════════════╤═══════════════╤════════════════╗ ║Version│ Last updated │ Status │Package Name│Package Version│ Description ║ ╠═══════╪════════════════════════════╪════════╪════════════╪═══════════════╪════════════════╣ ║3 │Mon Oct 30 17:57:41 IST 2017│DEPLOYED│helloworld │1.0.0 │Upgrade complete║ ║2 │Mon Oct 30 17:53:50 IST 2017│DELETED │helloworld │1.0.0 │Delete complete ║ ╚═══════╧════════════════════════════╧════════╧════════════╧═══════════════╧════════════════╝