Polish spring-cloud-launcher README (#45)

Use relative links, add mention of dataflow, fix example that mentions dataflow but had other applications in the code.
This commit is contained in:
Tommy Ludwig
2016-11-29 04:44:43 +09:00
committed by Spencer Gibb
parent 02c13fec63
commit 229a1d9de1

View File

@@ -6,7 +6,7 @@
### Installing
Install Spring CLI first: https://github.com/spring-cloud/spring-cloud-cli/blob/master/docs/src/main/asciidoc/install.adoc
[Install Spring CLI first](../docs/src/main/asciidoc/install.adoc)
### Running
@@ -14,14 +14,14 @@ Install Spring CLI first: https://github.com/spring-cloud/spring-cloud-cli/blob/
$ spring cloud
```
Currently starts configserver, eureka, h2 (db server), hystrixdashboard and kafka. [Here](https://github.com/spring-cloud/spring-cloud-cli/blob/devtools/spring-cloud-launcher/spring-cloud-launcher-deployer/src/main/resources/cloud.yml) is the full configuration.
Currently starts configserver, dataflow, eureka, h2 (db server), hystrixdashboard and kafka. [Here](spring-cloud-launcher-deployer/src/main/resources/cloud.yml) is the full configuration.
### Configuring
Spring Cloud Launcher use normal Spring Boot configuration mechanisms. The config name is `cloud`, so configuration can go in `cloud.yml` or `cloud.properties`.
Spring Cloud Launcher uses normal Spring Boot configuration mechanisms. The config name is `cloud`, so configuration can go in `cloud.yml` or `cloud.properties`.
For example, to run configserver and eureka, create a `cloud.yml` that looks like:
```
```yaml
spring:
cloud:
launcher:
@@ -38,15 +38,15 @@ spring:
The `name` attribute is required. If `waitUntilStarted` is true, Launcher will block until the application has reached the `deployed` state. Before commands are deployed, the list is sorted using Spring's `OrderComparator`. In the above case, `configserver` is deployed before any other app is deployed. Currently only `maven:` coordinates and standard Spring Resources (`file:`, etc...) are supported.
You can also select from the [predefined deployables](https://github.com/spring-cloud/spring-cloud-cli/blob/devtools/spring-cloud-launcher/spring-cloud-launcher-deployer/src/main/resources/cloud.yml). For example to run Spring Cloud Data Flow execute:
You can also select from the [predefined deployables](spring-cloud-launcher-deployer/src/main/resources/cloud.yml). For example to run Spring Cloud Data Flow execute:
```
spring cloud eureka,configserver
spring cloud dataflow
```
### Config Server git uri
To run configserver with a git repo set the following in `./configserver.yml`:
```
```yaml
spring:
profiles.active: git
cloud.config.server.git.uri: http://mygitserver/myrepo.git