diff --git a/spring-cloud-cli/1.3.2.RELEASE/images/spring-cloud-launcher-eureka-dashboard.png b/spring-cloud-cli/1.3.2.RELEASE/images/spring-cloud-launcher-eureka-dashboard.png new file mode 100644 index 00000000..dbd12c59 Binary files /dev/null and b/spring-cloud-cli/1.3.2.RELEASE/images/spring-cloud-launcher-eureka-dashboard.png differ diff --git a/spring-cloud-cli/1.3.2.RELEASE/images/spring-cloud-launcher-log.png b/spring-cloud-cli/1.3.2.RELEASE/images/spring-cloud-launcher-log.png new file mode 100644 index 00000000..916ce243 Binary files /dev/null and b/spring-cloud-cli/1.3.2.RELEASE/images/spring-cloud-launcher-log.png differ diff --git a/spring-cloud-cli/1.3.2.RELEASE/index.html b/spring-cloud-cli/1.3.2.RELEASE/index.html new file mode 100644 index 00000000..dc82404b --- /dev/null +++ b/spring-cloud-cli/1.3.2.RELEASE/index.html @@ -0,0 +1,757 @@ + + + + + + + +Spring Boot Cloud CLI + + + + + +
+
+
+
+

Spring Boot CLI provides Spring +Boot command line features for 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 launch services like Eureka, Zipkin, Config Server +conveniently all at once from the command line (very useful at +development time).

+
+
+ + + + + +
+
Note
+		 +Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at github. +
+
+
+
+
+

Installation

+
+
+

To install, make +sure you have +Spring Boot CLI +(1.5.2 or better):

+
+
+
+
$ spring version
+Spring CLI v1.5.3.RELEASE
+
+
+
+

E.g. for SDKMan users

+
+
+
+
$ sdk install springboot 1.5.3.RELEASE
+$ sdk use springboot 1.5.3.RELEASE
+
+
+
+

and install the Spring Cloud plugin

+
+
+
+
$ mvn install
+$ spring install org.springframework.cloud:spring-cloud-cli:1.3.3.BUILD-SNAPSHOT
+
+
+
+ + + + + +
+
Important
+		 +Prerequisites: to use the encryption and decryption features +you need the full-strength JCE installed in your JVM (it’s not there by default). +You can download the "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files" +from Oracle, and follow instructions for installation (essentially replace the 2 policy files +in the JRE lib/security directory with the ones that you downloaded). +
+
+
+
+
+

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:

+
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ServiceNameAddressDescription

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.

+
+

Each of these apps can be configured using a local YAML file with the same name (in the current +working directory or a subdirectory called "config" or in ~/.spring-cloud). E.g. in configserver.yml you might want to +do something like this to locate a local git repository for the backend:

+
+
+
configserver.yml
+
+
spring:
+  profiles:
+    active: git
+  cloud:
+    config:
+      server:
+        git:
+          uri: file://${user.home}/dev/demo/config-repo
+
+
+
+

Adding Additional Applications

+
+

Additional applications can be added to ./config/cloud.yml (not +./config.yml because that would replace the defaults), e.g. with

+
+
+
config/cloud.yml
+
+
spring:
+  cloud:
+    launcher:
+      deployables:
+        source:
+          coordinates: maven://com.example:source:0.0.1-SNAPSHOT
+          port: 7000
+        sink:
+          coordinates: maven://com.example:sink:0.0.1-SNAPSHOT
+          port: 7001
+
+
+
+

when you list the apps:

+
+
+
+
$ spring cloud --list
+source sink configserver dataflow eureka h2 hystrixdashboard kafka zipkin
+
+
+
+

(notice the additional apps at the start of the list).

+
+
+
+

Using RabbitMQ as a Message Broker

+
+

If you prefer to use RabbitMQ as the broker for the Bus messages in +the services you run on the command line (and your own apps), then use +the "rabbit" profile. Example:

+
+
+
+
$ spring cloud configserver eureka --profile=rabbit
+
+
+
+

What this does is enable a Spring profile in the deployer app (the +one that reads the cloud.yml). If you look in the cloud.yml you +will find that this profile sets a deployment property for all the +apps that get launched, which changes the thin launcher profile to +"rabbit" in each of the deployed apps. A thin launcher profile +can change the classpath of the app when it runs, and in this way we +can switch off Kafka and switch on RabbitMQ.

+
+
+
+

Switching the Deployed Apps to One per Process

+
+

The default bahaviour of the deployer app is to launch all the baby +apps in the same process as itself (and hence they all share stdout, +which is convenient). If you want to switch to one local process per +app, you can use the deployer switch on the command line. Example:

+
+
+
+
$ spring cloud --deployer=local
+
+
+
+

The two deployer profiles that ship with Spring Cloud CLI are "local" +and "thin" (the default), and they are both implemented as thin +launcher profiles. In principle you could run with any implementation +of the Spring Cloud AppDeployer by providing a different thin +profile for the deployer.

+
+
+

See the Thin +Luancher project for more information about profiles.

+
+
+
+
+
+

Writing Groovy Scripts and Running Applications

+
+
+

Spring Cloud CLI has support for most of the Spring Cloud declarative +features, such as the @Enable* class of annotations. For example, +here is a fully functional Eureka server

+
+
+
app.groovy
+
+
@EnableEurekaServer
+class Eureka {}
+
+
+
+

which you can run from the command line like this

+
+
+
+
$ spring run app.groovy
+
+
+
+

To include additional dependencies, often it suffices just to add the +appropriate feature-enabling annotation, e.g. @EnableConfigServer, +@EnableOAuth2Sso or @EnableEurekaClient. To manually include a +dependency you can use a @Grab with the special "Spring Boot" short +style artifact co-ordinates, i.e. with just the artifact ID (no need +for group or version information), e.g. to set up a client app to +listen on AMQP for management events from the Spring CLoud Bus:

+
+
+
app.groovy
+
+
@Grab('spring-cloud-starter-bus-amqp')
+@RestController
+class Service {
+  @RequestMapping('/')
+  def home() { [message: 'Hello'] }
+}
+
+
+
+
+
+

Encryption and Decryption

+
+
+

The Spring Cloud CLI comes with an "encrypt" and a "decrypt" +command. Both accept arguments in the same form with a key specified +as a mandatory "--key", e.g.

+
+
+
+
$ spring encrypt mysecret --key foo
+682bc583f4641835fa2db009355293665d2647dade3375c0ee201de2a49f7bda
+$ spring decrypt --key foo 682bc583f4641835fa2db009355293665d2647dade3375c0ee201de2a49f7bda
+mysecret
+
+
+
+

To use a key in a file (e.g. an RSA public key for encyption) prepend +the key value with "@" and provide the file path, e.g.

+
+
+
+
$ spring encrypt mysecret --key @${HOME}/.ssh/id_rsa.pub
+AQAjPgt3eFZQXwt8tsHAVv/QHiY5sI2dRcR+...
+
+
+
+
+
+ + \ No newline at end of file