65 lines
2.4 KiB
Plaintext
65 lines
2.4 KiB
Plaintext
////
|
|
DO NOT EDIT THIS FILE. IT WAS GENERATED.
|
|
Manual changes to this file will be lost when it is generated again.
|
|
Edit the files in the src/main/asciidoc/ directory instead.
|
|
////
|
|
|
|
|
|
image::https://github.com/spring-cloud/spring-cloud-consul/workflows/Build/badge.svg?style=svg["Actions Status", link="https://github.com/spring-cloud/spring-cloud-consul/actions"]
|
|
image::https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/main/graph/badge.svg["Codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-consul/branch/main"]
|
|
|
|
|
|
[[quick-start]]
|
|
= Quick Start
|
|
|
|
|
|
[[consul-overview]]
|
|
= Consul overview
|
|
|
|
Features of Consul
|
|
|
|
* Distributed configuration
|
|
* Service registration and discovery
|
|
* Distributed events
|
|
* Distributed locking and sessions
|
|
* Supports multiple data centers
|
|
* Built in, user-friendly user interface
|
|
|
|
See the https://consul.io/intro/index.html[intro] for more information.
|
|
|
|
[[spring-cloud-consul-features]]
|
|
= Spring Cloud Consul Features
|
|
|
|
* Spring Cloud `DiscoveryClient` implementation
|
|
** supports Spring Cloud Gateway
|
|
** supports Spring Cloud LoadBalancer
|
|
* 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]]
|
|
= Running the sample
|
|
|
|
1. Run `docker-compose up`
|
|
2. Verify consul is running by visiting http://localhost:8500
|
|
3. Run `mvn package` this will bring in the required spring cloud maven repositories and build
|
|
4. Run `java -jar spring-cloud-consul-sample/target/spring-cloud-consul-sample-${VERSION}.jar`
|
|
5. visit http://localhost:8080, verify that `{"serviceId":"<yourhost>:8080","host":"<yourhost>","port":8080}` results
|
|
6. run `java -jar spring-cloud-consul-sample/target/spring-cloud-consul-sample-${VERSION}.jar --server.port=8081`
|
|
7. 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]]
|
|
= Building
|
|
|
|
[[building]]
|
|
= Building
|
|
|
|
Unresolved directive in https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/pages/building.adoc - include::partial$building.adoc[]
|
|
|
|
[[contributing]]
|
|
= Contributing
|
|
|
|
[[contributing]]
|
|
= Contributing
|
|
|
|
Unresolved directive in https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/pages/contributing.adoc - include::partial$contributing.adoc[]
|