https://github.com/piomin/sample-spring-cloud-consul
Spring Boot applications/microservices demo using Consul discovery & config
https://github.com/piomin/sample-spring-cloud-consul
consul consul-kv-store microservices spring-boot spring-cloud spring-cloud-consul spring-cloud-gateway
Last synced: 22 days ago
JSON representation
Spring Boot applications/microservices demo using Consul discovery & config
- Host: GitHub
- URL: https://github.com/piomin/sample-spring-cloud-consul
- Owner: piomin
- Created: 2018-01-02T22:35:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-21T10:31:41.000Z (about 1 month ago)
- Last Synced: 2025-03-30T07:11:12.211Z (29 days ago)
- Topics: consul, consul-kv-store, microservices, spring-boot, spring-cloud, spring-cloud-consul, spring-cloud-gateway
- Language: Java
- Homepage: https://piotrminkowski.com/
- Size: 139 KB
- Stars: 62
- Watchers: 3
- Forks: 48
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Microservices With Spring Cloud Consul Demo Project [](https://twitter.com/piotr_minkowski)
[](https://circleci.com/gh/piomin/sample-spring-cloud-consul)
[](https://sonarcloud.io/dashboard?id=piomin_sample-spring-cloud-consul)
[](https://sonarcloud.io/dashboard?id=piomin_sample-spring-cloud-consul)
[](https://sonarcloud.io/dashboard?id=piomin_sample-spring-cloud-consul)
[](https://sonarcloud.io/dashboard?id=piomin_sample-spring-cloud-consul)
In this project I'm demonstrating you how to use Hashicorp's **Consul** as a discovery and configuration server with [Spring Cloud Consul](https://spring.io/projects/spring-cloud-consul) and other Spring Cloud projects for building microservice-based architecture.
## Getting Started
1. To build and run sample applications you need to have Maven, JDK11+ and Docker. However, the simplest way to start with it is through any IDE like Intellij or Eclipse.
2. First, you have to run Consul on Docker container
```
$ docker run -d --name consul-1 -p 8500:8500 -e CONSUL_BIND_INTERFACE=eth0 consul
```
3. Then you can compile your application with Maven `mvn clean install` command and using `java -jar ...` command. Or you can just build it and run using your IDE. Each application is listeting on dynamically generated port.
## Architecture
Our sample microservices-based system consists of the following modules:
- **gateway-service** - a module that uses Spring Cloud Gateway for running Spring Boot application that acts as a proxy/gateway in our architecture.
- **account-service** - a module containing the first of our sample microservices that allows to perform CRUD operation on in-memory repository of accounts
- **customer-service** - a module containing the second of our sample microservices that allows to perform CRUD operation on in-memory repository of customers. It communicates with account-service.
- **product-service** - a module containing the third of our sample microservices that allows to perform CRUD operation on in-memory repository of products.
- **order-service** - a module containing the fourth of our sample microservices that allows to perform CRUD operation on in-memory repository of orders. It communicates with all other microservices.
The following picture illustrates the architecture described above.
When running sample applications we can test more advanced scenario. We may leverage **Zone Affinity** mechanism to prefer communication inside a single zone. We can also start a cluster of Consul modes started locally on Docker containers. Here's the picture illustrating such an architecture:
## Description
Detailed description can be found here: [Microservices with Spring Boot, Spring Cloud Gateway and Consul Cluster](https://piotrminkowski.com/2019/11/06/microservices-with-spring-boot-spring-cloud-gateway-and-consul-cluster/)