Installation

The following example YAML file configures two local deployer accounts, named localDev and localDevDebug:spring-doc.cn

The key-value pairs that follow the name of the account are javaCmd, workingDirectoriesRoot, deleteFilesOnExit, envVarsToInherit, shutdownTimeout, javaOpts, and useSpringApplicationJson. More information can be found in the JavaDocs for LocalDeployerProperties.spring-doc.cn

You can modify the following sample YML snippet to fit your needs:spring-doc.cn

You can also run the Skipper server locally and deploy to Cloud Foundry. In this case, it is more convenient to specify the configuration in a skipper.yml file and start the server with the --spring.config.additional-location=skipper.yml option.spring-doc.cn

If you use cf push to deploy Skipper, a Cloud Foundry manifest is more appropriate to use. You can modify the following sample manifest.yml to fit your needs:spring-doc.cn

You can find information on the deployment properties that you can configure in CloudFoundryDeploymentProperties.spring-doc.cn

When starting the Skipper shell on your local machine, it tries to connect to the Server at the default location of localhost:7577/api. Use the shell’s --spring.cloud.skipper.client.serverUri command line option to specify the location of the server. You can alternatively use the config interactive shell command to set the server location, as follows:spring-doc.cn

As of Skipper 2.0, the Spring Cloud Connector library is no longer used to create the DataSource. The library java-cfenv is now used which allows you to set Spring Boot properties to configure the connection pool.spring-doc.cn

By default, every application in Cloud Foundry starts with 1G disk quota and this can be adjusted to a default maximum of 2G. The default maximum can also be overridden up to 10G by using Pivotal Cloud Foundry’s (PCF) Ops Manager GUI.spring-doc.cn

This configuration is relevant for Spring Cloud Skipper because every deployment is composed of applications (typically Spring Boot uber-jar’s), and those applications are resolved from a remote maven repository. After resolution, the application artifacts are downloaded to the local Maven Repository for caching and reuse. With this happening in the background, the default disk quota (1G) can fill up rapidly, especially when we experiment with streams that are made up of unique applications. In order to overcome this disk limitation and depending on your scaling requirements, you may want to change the default maximum from 2G to 10G. Let’s review the steps to change the default maximum disk quota allocation.spring-doc.cn

From PCF’s Ops Manager, select the “Pivotal Elastic Runtime” tile and navigate to the “Application Developer Controls” tab. Change the “Maximum Disk Quota per App (MB)” setting from 2048 (2G) to 10240 (10G). Save the disk quota update and click “Apply Changes” to complete the configuration override.spring-doc.cn

Even when configuring Skipper to use 10G of space, there is the possibility of exhausting the available space on the local disk. To prevent this, jar artifacts downloaded from external sources, i.e., apps registered as http or maven resources, are automatically deleted whenever the application is deployed, whether or not the deployment request succeeds. This behavior is optimal for production environments in which container runtime stability is more critical than I/O latency incurred during deployment. In development environments deployment happens more frequently. Additionally, the jar artifact (or a lighter metadata jar) contains metadata describing application configuration properties which is used by various operations related to application configuration, more frequently performed during pre-production activities. To provide a more responsive interactive developer experience at the expense of more disk usage in pre-production environments, you can set the CloudFoundry deployer property autoDeleteMavenArtifacts to false.spring-doc.cn

If you deploy the Skipper by using the default port health check type, you must explicitly monitor the disk space on the server in order to avoid running out space. If you deploy the server by using the http health check type (see the next example), the server is restarted if there is low disk space. This is due to Spring Boot’s Disk Space Health Indicator. You can configure the settings of the Disk Space Health Indicator by using the properties that have the management.health.diskspace prefix.spring-doc.cn

For version 1.7, we are investigating the use of Volume Services for the server to store .jar artifacts before pushing them to Cloud Foundry.spring-doc.cn

The following example shows how to deploy the http health check type to an endpoint called /management/health:spring-doc.cn

The following example YAML file configures two accounts, named k8s-dev and k8sqa, on a Kubernetes cluster.spring-doc.cn

The accounts correspond to different namespaces. We are investigating how to support connecting to different Kubernetes clusters.spring-doc.cn

You can find more information on the deployment properties that you can configure in KubernetesDeployerPropertiesspring-doc.cn

When no other database is configured and the H2 driver has been added to the server classpath then Spring Cloud Skipper uses an embedded instance of the H2 database as the default.spring-doc.cn

To use H2 add the com.h2database:h2:2.1.214 JDBC driver to the classpath and do not configure any other database.spring-doc.cn

To add a custom driver for the database (for example, Oracle), you should rebuild the Skipper Server and add the dependency to the Maven pom.xml file. You need to modify the maven pom.xml of spring-cloud-skipper module. There are GA release tags in GitHub repository, so you can switch to desired GA tags to add the drivers on the production-ready codebase.spring-doc.cn

To add a custom JDBC driver dependency for the Spring Cloud Skipper server:spring-doc.cn

By default, the Spring Cloud Skipper server is unsecured and runs on an unencrypted HTTP connection. You can secure your REST endpoints by enabling HTTPS and requiring clients to authenticate using OAuth 2.0spring-doc.cn

For testing purposes or during development, it might be convenient to create self-signed certificates. To get started, run the following command to create a certificate:spring-doc.cn

Then add the following to your skipper.yml file:spring-doc.cn

That is all you need for the Skipper Server. Once you start the server, you should be able to access it at https://localhost:8443/. As this is a self-signed certificate, you should hit a warning in your browser. You need to ignore that.spring-doc.cn

By default, self-signed certificates are an issue for the shell. Additional steps are necessary to make the shell work with self-signed certificates. Two options are available:spring-doc.cn

Spring Cloud Skipper supports the following roles:spring-doc.cn

The rules regarding which REST endpoints require which roles are specified in the application.yml of the spring-cloud-skipper-server-core module.spring-doc.cn

Nonetheless, you can override those, if desired. The configuration takes the form of a YAML list (as some rules may have precedence over others). Consequently, you need to copy/paste the whole list and tailor it to your needs (as there is no way to merge lists). Always refer to your version of application.yml, as the snippet reproduced below may be outdated. The default rules are as follows:spring-doc.cn

The format of each line is as follows:spring-doc.cn

HTTP_METHOD URL_PATTERN '⇒' SECURITY_ATTRIBUTEspring-doc.cn

wherespring-doc.cn

Be mindful that the above is indeed a YAML list, not a map (thus the use of '-' dashes at the start of each line) that lives under the spring.cloud.skipper.security.authorization.rules key.spring-doc.cn

If your OAuth2 provider supports the Password Grant Type, you can start the Skipper shell with the following command:spring-doc.cn

From within the Skipper shell, you can also provide credentials by using the following command:spring-doc.cn

Once successfully targeted, you should see the following output:spring-doc.cn

This section provides examples of some common security arrangements for Skipper:spring-doc.cn