update docs and prepare to deploy snapshots

This commit is contained in:
Spencer Gibb
2015-05-20 15:44:18 -06:00
parent 81c2592996
commit d6fa5d22c6
5 changed files with 249 additions and 37 deletions

View File

@@ -4,20 +4,38 @@ include::intro.adoc[]
== This is a Developer Preview
== Features
We plan on releasing a milestone shortly.
* TODO: list features
== Consul overview
Features of Consul
* Distributed configuration
* Service registration and discovery
* Messaging
* Distributed locking and sessions
* Supports multiple data centers
* has a slick ui
See the https://consul.io/intro/index.html[intro] for more information.
== Spring Cloud Consul Features
* Spring Cloud `DiscoveryClient` implementation
** supports Ribbon and Zuul
* Consul based `PropertySource` loaded during the 'bootstrap' phase.
* Spring Cloud Bus implementation based on Consul https://www.consul.io/docs/agent/http/event.html[events]
== Running the sample
1. [Install consul](https://consul.io/downloads.html)
1. https://consul.io/downloads.html[Install consul]
2. Run `./run_consul.sh` found in the root of this project
3. verify consul is running by visiting [http://localhost:8500](http://localhost:8500)
3. verify consul is running by visiting http://localhost:8500
4. run `mvn --settings .settings.xml package` this will bring in the required spring cloud maven repositories and build
5. run `java -jar spring-cloud-consul-sample/target/spring-cloud-consul-sample-1.0.0.BUILD-SNAPSHOT.jar`
6. visit [http://localhost:8080](http://localhost:8080), verify that `{"serviceId":"<yourhost>:8080","host":"<yourhost>","port":8080}` results
6. visit http://localhost:8080, verify that `{"serviceId":"<yourhost>:8080","host":"<yourhost>","port":8080}` results
7. run `java -jar spring-cloud-consul-sample/target/spring-cloud-consul-sample-1.0.0.BUILD-SNAPSHOT.jar --server.port=8081`
8. visit [http://localhost:8080](http://localhost:8080) again, verify that `{"serviceId":"<yourhost>:8081","host":"<yourhost>","port":8081}` eventually shows up in the results in a round robbin fashion (may take a minute or so).
8. visit http://localhost:8080 again, verify that `{"serviceId":"<yourhost>:8081","host":"<yourhost>","port":8081}` eventually shows up in the results in a round robbin fashion (may take a minute or so).
== Building