Spring Cloud Skipper Reference Guide

Authors

Mark Pollack, Ilayaperumal Gopinathan, Janne Valkealahti, Gunnar Hillert, Sabby Anandan

1.0.0.M3

Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.


Table of Contents

I. Preface
1. About the documentation
2. Getting help
II. Spring Cloud Skipper Overview
3. Features
4. Concepts
III. Getting started
5. System Requirements
6. Installing Skipper
6.1. Using an External Database
7. A three second tour
IV. Three minute Tour
8. Local machine
9. Cloud Foundry
10. Kuberenetes
V. Using Skipper
11. Platforms
12. Packages
12.1. Package Format
12.2. Package with multiple applications
12.3. Package Metadata (package.yml)
12.4. Package Templates (template.yml)
12.4.1. HTTP Resources
12.4.2. Docker Resources
12.4.3. Maven Resources
12.5. Package Values (values.yml)
12.6. Package Upload
12.7. Creating Your Own Package
13. Repositories
VI. Skipper Commands
14. Release and Package commands
14.1. Search command
14.2. Install command
14.3. Upgrade command
14.4. Status command
14.5. Rollback command
14.6. List command
14.7. History command
14.8. Delete command
15. Manifest commands
16. Platform commands
17. Repository commands
VII. Architecture
VIII. REST API Guide
18. Overview
18.1. HTTP verbs
18.2. HTTP status codes
18.3. Headers
18.4. Errors
18.5. Hypermedia
19. Resources
19.1. Index
19.1.1. Accessing the index
Request structure
Example request
Example response
Links
19.2. Server Meta Information
19.2.1. Retrieving information about the server
Request structure
Example request
Response structure
Response fields
19.3. Upload
19.3.1. Upload a package
Request structure
Example request
Response structure
Response fields
19.4. Install
19.4.1. Install a package
Request structure
Example request
Response structure
Response fields
19.4.2. Install a package with id
Request structure
Example request
Response structure
Response fields
19.5. Status
19.5.1. Get status of release
Request structure
Example request
Response structure
Response fields
19.5.2. Get status of release for a specific version
Request structure
Example request
Response structure
Response fields
19.6. Manifest
19.6.1. Get the manifest
Request structure
Example request
Response structure
19.6.2. Get the manifest for a specific version
Request structure
Example request
Response structure
19.7. Upgrade
19.7.1. Upgrade a release
Request structure
Example request
Response structure
Response fields
19.8. Rollback
19.8.1. Rollback release
Request structure
Example request
Response structure
Response fields
19.9. Delete
19.9.1. Delete a release
Request structure
Example request
Response structure
Response fields
19.10. History
19.10.1. Show version history
Request structure
Example request
Response structure
Response fields
19.11. List
19.11.1. List
Request structure
Example request
Response structure
Response fields
19.11.2. List by release name
Request structure
Example request
Response structure
Response fields
19.12. Resources Repositories
19.12.1. Retrieving a list of repositories
Request structure
Example request
Response structure
Response fields
19.12.2. Retrieving a single repository
Request structure
Example request
Response structure
Response fields
19.13. App Deployers Datas
19.13.1. Retrieving a list of app deployer datas
Request structure
Example request
Response structure
Response fields
19.14. Deployers
19.14.1. Retrieving a list of app deployers
Request structure
Example request
Response structure
Response fields
19.15. Releases
19.15.1. Retrieving a list of releases
Request structure
Example request
Response structure
Response fields
19.16. Package Metadata
19.16.1. Retrieving a list of package metadata
Request structure
Example request
Response structure
Response fields
19.16.2. Package metadata details
Request structure
Example request
Response structure
Response fields
IX. Appendices
A. Building
A.1. Documentation
A.2. Importing into eclipse
B. Contributing
B.1. Sign the Contributor License Agreement
B.2. Code Conventions and Housekeeping