diff --git a/README.adoc b/README.adoc index 20e9ccc..3589333 100644 --- a/README.adoc +++ b/README.adoc @@ -2,10 +2,15 @@ image::https://travis-ci.org/spring-cloud/spring-cloud-cli.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-cli] -Spring Boot CLI provides http://projects.spring.io/spring-boot[Spring Boot] command line features for -https://github.com/spring-cloud[Spring Cloud]. You can write Groovy scripts to run Spring Cloud component applications -(e.g. `@EnableEurekaServer`). You can also easily do things like encryption and decryption to support Spring Cloud -Config clients with secret configuration values. +Spring Boot CLI provides http://projects.spring.io/spring-boot[Spring +Boot] command line features for https://github.com/spring-cloud[Spring +Cloud]. You can write Groovy scripts to run Spring Cloud component +applications (e.g. `@EnableEurekaServer`). You can also easily do +things like encryption and decryption to support Spring Cloud Config +clients with secret configuration values. With the Launcher CLI you +can also launch services like Eureka, Zipkin, Config Server +conveniently all at once from the command line (very useful at +development time). == Installation @@ -25,11 +30,12 @@ $ sdk install springboot 1.3.5.RELEASE $ sdk use springboot 1.3.5.RELEASE ``` -and install the Spring Cloud plugin: +and install the Spring Cloud plugins (they are independeny so you can install one or the other or both): ``` $ mvn install -$ spring install org.springframework.cloud:spring-cloud-cli:1.1.2.RELEASE +$ spring install org.springframework.cloud:spring-cloud-cli:1.2.0.BUILD-SNAPSHOT +$ spring install org.springframework.cloud:spring-cloud-launcher-cli:1.2.0.BUILD-SNAPSHOT ``` IMPORTANT: **Prerequisites:** to use the encryption and decryption features diff --git a/docs/src/main/asciidoc/install.adoc b/docs/src/main/asciidoc/install.adoc index 2f6a5d7..e3946fa 100644 --- a/docs/src/main/asciidoc/install.adoc +++ b/docs/src/main/asciidoc/install.adoc @@ -13,11 +13,12 @@ $ sdk install springboot 1.3.5.RELEASE $ sdk use springboot 1.3.5.RELEASE ``` -and install the Spring Cloud plugin: +and install the Spring Cloud plugins (they are independeny so you can install one or the other or both): ``` $ mvn install -$ spring install org.springframework.cloud:spring-cloud-cli:1.1.2.RELEASE +$ spring install org.springframework.cloud:spring-cloud-cli:1.2.0.BUILD-SNAPSHOT +$ spring install org.springframework.cloud:spring-cloud-launcher-cli:1.2.0.BUILD-SNAPSHOT ``` IMPORTANT: **Prerequisites:** to use the encryption and decryption features diff --git a/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc index 63791f9..3a7e4ac 100644 --- a/docs/src/main/asciidoc/intro.adoc +++ b/docs/src/main/asciidoc/intro.adoc @@ -1,5 +1,10 @@ -Spring Boot CLI provides http://projects.spring.io/spring-boot[Spring Boot] command line features for -https://github.com/spring-cloud[Spring Cloud]. You can write Groovy scripts to run Spring Cloud component applications -(e.g. `@EnableEurekaServer`). You can also easily do things like encryption and decryption to support Spring Cloud -Config clients with secret configuration values. +Spring Boot CLI provides http://projects.spring.io/spring-boot[Spring +Boot] command line features for https://github.com/spring-cloud[Spring +Cloud]. You can write Groovy scripts to run Spring Cloud component +applications (e.g. `@EnableEurekaServer`). You can also easily do +things like encryption and decryption to support Spring Cloud Config +clients with secret configuration values. With the Launcher CLI you +can also launch services like Eureka, Zipkin, Config Server +conveniently all at once from the command line (very useful at +development time). diff --git a/docs/src/main/asciidoc/spring-cloud-cli.adoc b/docs/src/main/asciidoc/spring-cloud-cli.adoc index c1880e8..d7f4f10 100644 --- a/docs/src/main/asciidoc/spring-cloud-cli.adoc +++ b/docs/src/main/asciidoc/spring-cloud-cli.adoc @@ -11,6 +11,46 @@ include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/maste include::install.adoc[] +== Running Spring Cloud Services in Development + +The Launcher CLI can be used to run common services like Eureka, +Config Server etc. from the command line. To list the available +services you can do `spring cloud --list`, and to launch a default set +of services just `spring cloud`. To choose the services to deploy, +just list them on the command line, e.g. + +---- +$ spring cloud eureka configserver h2 kafka zipkin +---- + +Summary of supported deployables: + +[options="header"] +|=== +|Service | Name | Address | Description + +|eureka | Eureka Server | http://localhost:8761 +| Eureka server for service registration and discovery. All the other services show up in its catalog by default. + +|configserver | Config Server | http://localhost:8888 +|Spring Cloud Config Server running in the "native" profile and serving configuration from the local directory ./launcher + +|h2 | H2 Database | http://localhost:9095 (console), jdbc:h2:tcp://localhost:9096/{data} +| Relation database service. Use a file path for `{data}` (e.g. `./target/test`) when you connect. Remember that you can add `;MODE=MYSQL` or `;MODE=POSTGRESQL` to connect with compatibility to other server types. + +|kafka | Kafka Broker | http://localhost:9091 (actuator endpoints), localhost:9092 +| + +|hystrixdashboard | Hystrix Dashboard | http://localhost:7979 +|Any Spring Cloud app that declares Hystrix circuit breakers publishes metrics on `/hystrix.stream`. Type that address into the dashboard to visualize all the metrics, + +|dataflow | Dataflow Server | http://localhost:9393 +| Spring Cloud Dataflow server with UI at /admin-ui. Connect the Dataflow shell to target at root path. + +|zipkin | Zipkin Server | http://localhost:9411 +| Zipkin Server with UI for visualizing traces. Stores span data in memory and accepts them via HTTP POST of JSON data. +|=== + == Writing Groovy Scripts and Running Applications Spring Cloud CLI has support for most of the Spring Cloud declarative