microservice - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #llm #rust #deep-learning #docker #macos #awesome #cli #ios #mcp #openai

microservice

(★ 765)

Sample of a Microservice setup for my book. Based on Spring Cloud / Netflix / Java / Docker / Docker Compose / Docker Machine / Vagrant

File Explorer

Download Latest Version (.zip)

- - build.yml
- .env
- docker-compose.yml
- LIESMICH.md
- README.md
- - Dockerfile
- - Dockerfile
- - Dockerfile
- - Dockerfile
- - Dockerfile
- - Dockerfile
- - Dockerfile
- LIESMICH.md
- README.md
- Vagrantfile
- - Dockerfile
  - pom.xml
- - Dockerfile
  - pom.xml
- - Dockerfile
  - pom.xml
- - Dockerfile
  - pom.xml
- - Dockerfile
  - pom.xml
- - Dockerfile
  - pom.xml
- mvnw
- mvnw.cmd
- pom.xml
- createdemo.sh
- destroydemo.sh
- README.md
.gitignore
HOW-TO-RUN.md
LICENSE
LIESMICH.md
README.md
WIE-LAUFEN.md

# Installation Guide

1. Get the code

git clone https://github.com/ewolff/microservice

Downloads the entire project code from GitHub to your computer.

cd microservice

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f docker/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Maven (Java)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java projects.
Maven The build tool used for the mvn command.

cd microservice-demo/microservice-demo-catalog

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

✅ A BUILD SUCCESS message means it worked. The output is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Microservice Sample
==============

<details>
<summary>Translations:</summary>

- [German / Deutsch](LIESMICH.md)

</details>

This is a sample for my
Microservices Book ([English](http://microservices-book.com/) / [German](http://microservices-buch.de/)).

This project creates a VM with the complete micro service demo system
in Docker containers inside a Vagrant VM. The services are implemented
in Java using Spring and Spring Cloud.

It uses three microservices:
- Order to process orders.
- Customer to handle customer data.
- Catalog to handle the items in the catalog.

Technologies
------------

- Eureka for Lookup
- Ribbon for Load Balancing. See the classes CatalogClient and
  CustomerClient in com.ewolff.microservice.order.clients in the
  microservice-demo-order project.
- Hystrix is used for resilience. See CatalogClient in
  com.ewolff.microservice.order.clients in the microservice-demo-order
  project . Note that the CustomerClient won't use Hystrix. This way
  you can see how a crash of the Customer microservices makes the
  Order microservice useless.
- Hystrix has a dashboard. Turbine can be used to combine the data
from multiple sources. However, this does not work at the moment.
- Zuul is used to route HTTP requests from the outside to the
  different services.
- Spring Cloud Config isn't used. It is disabled with
  spring.cloud.config.enabled=false in the bootstrap files.

How To Run
----------

The demo can be run with [Vagrant](docker-vagrant/README.md) or [Docker Machine and Docker
Compose](docker/README.md).

[How to run](HOW-TO-RUN.md) includes more details.

<details>
<summary>Translations:</summary>

- [German / Deutsch](WIE-LAUFEN.md)

</details>

Remarks on the Code
-------------------

The servers for the infrastructure are pretty simple thanks to Spring Cloud:

- microservice-demo-eureka is the Eureka server for service discovery.
- microservice-demo-zuul is the Zuul server. It distributes the requests to the three microservices.
- microservice-demo-turbine can be used to consolidate the Hystrix metrics and has a Hystrix dashboard.

The microservices are: 
- microservice-demo-catalog is the application to take care of items.
- microserivce-demo-customer is responsible for customers.
- microservice-demo-order does order processing. It uses microservice-demo-catalog and microservice-demo-customer. Ribbon is used for load balancing and Hystrix for resilience.

The microservices have a Java main application in src/test/java to run them stand alone. microservice-demo-order uses a stub for the other services then. Also, there are tests that use customer driven contracts. That is why it is ensured that the services provide the correct interface. These CDC tests are used in microservice-demo-order to verify the stubs. In microserivce-demo-customer and microserivce-demo-catalog they are used to verify the implemented REST services.