Tutorial on Microservices Architecture with JHipster :: Microservices

This part aims the generation and the deployment of an application following a microservices architecture with JHipster.

This tutorial is valid for JHipster 7.9.3 (jhipster --version). Please, check the command lines for building and running into the generated README.md documents if the commands fail.

Architecture

The architecture is composed of :

the JHipster Service Registry (Service discovery uses Haezlcast)
The JHipster API Gateway
one microservice productorder (using a mysql database)
one microservice invoice (using a postgresql database)
one microservice notification (using mongodb database)

The SPA frontend accesses to the microservices thru the API Gateway.

Warning: The port numbers should be 8080 for gateway, 8081 for productorder, 8082 for invoice and 8083 for notification.

Generation of the `gateway` (without entities)

mkdir -p ~/github/mastering-microservices/gateway
cd  ~/github/mastering-microservices/gateway
jhipster

Answer to the questions:

? Which *type* of application would you like to create? Gateway application
? Do you want to enable *microfrontends*? No
? What is the base name of your application? gateway
? As you are running in a microservice architecture, on which port would like 
your server to run? It should be unique to avoid port conflicts. 8080
? What is your default Java package name? mosig.cloud.store.gateway
? Which service discovery server do you want to use? JHipster Registry (uses 
Eureka, provides Spring Cloud Config support and monitoring dashboards)
? Which *type* of authentication would you like to use? JWT authentication 
(stateless, with a token)
? Which *type* of database would you like to use? SQL (H2, PostgreSQL, MySQL, 
MariaDB, Oracle, MSSQL)
? Which *production* database would you like to use? PostgreSQL
? Which *development* database would you like to use? H2 with disk-based 
persistence
? Which cache do you want to use? (Spring cache abstraction) Ehcache (local 
cache, for a single node)
? Do you want to use Hibernate 2nd level cache? Yes
? Would you like to use Maven or Gradle for building the backend? Gradle
? Which other technologies would you like to use? 
? Which *Framework* would you like to use for the client? Angular
? Do you want to generate the admin UI? Yes
? Would you like to use a Bootswatch theme (https://bootswatch.com/)? Default 
JHipster
? Would you like to enable internationalization support? Yes
? Please choose the native language of the application French
? Please choose additional languages to install English
     info Disabling hibernate cache for cache provider no
? Besides JUnit and Jest, which testing frameworks would you like to use? 
Cypress, Gatling, Cucumber
? Would you like to install other generators from the JHipster Marketplace? No
? Would you like to generate code coverage for Cypress tests? [Experimental] Yes
? Would you like to audit Cypress tests? Yes

You can choose React or Vue instead of Angular if you feel more confortable with them.

Generation of the microservice `productorder` (without entities)

mkdir -p ~/github/mastering-microservices/productorder
cd  ~/github/mastering-microservices/productorder
jhipster

Answer to the questions:

? Which *type* of application would you like to create? Microservice application
? Do you want to enable *microfrontends*? No
? What is the base name of your application? productorder
? Do you want to make it reactive with Spring WebFlux? No
? As you are running in a microservice architecture, on which port would like your server 
to run? It should be unique to avoid port conflicts. 8081
? What is your default Java package name? mosig.cloud.store.productorder
? Which service discovery server do you want to use? JHipster Registry (uses Eureka, 
provides Spring Cloud Config support and monitoring dashboards)
? Which *type* of authentication would you like to use? JWT authentication (stateless, with
 a token)
? Which *type* of database would you like to use? SQL (H2, PostgreSQL, MySQL, MariaDB, 
Oracle, MSSQL)
? Which *production* database would you like to use? PostgreSQL
? Which *development* database would you like to use? H2 with disk-based persistence
? Which cache do you want to use? (Spring cache abstraction) Hazelcast (distributed cache, 
for multiple nodes, supports rate-limiting for gateway applications)
? Do you want to use Hibernate 2nd level cache? Yes
? Would you like to use Maven or Gradle for building the backend? Gradle
? Which other technologies would you like to use? 
? Would you like to enable internationalization support? Yes
? Please choose the native language of the application French
? Please choose additional languages to install English
? Besides JUnit and Jest, which testing frameworks would you like to use? Cypress, Gatling, Cucumber
? Would you like to install other generators from the JHipster Marketplace? No

Generation of the (microservice `invoice` (without entities)

mkdir -p ~/github/mastering-microservices/invoice
cd  ~/github/mastering-microservices/invoice
jhipster

Answer to the questions:

? Which *type* of application would you like to create? Microservice application
? Do you want to enable *microfrontends*? No
? What is the base name of your application? invoice
? Do you want to make it reactive with Spring WebFlux? No
? As you are running in a microservice architecture, on which port would like your server 
to run? It should be unique to avoid port conflicts. 8082
? What is your default Java package name? mosig.cloud.store.invoice
? Which service discovery server do you want to use? JHipster Registry (uses Eureka, 
provides Spring Cloud Config support and monitoring dashboards)
? Which *type* of authentication would you like to use? JWT authentication (stateless, with
 a token)
? Which *type* of database would you like to use? SQL (H2, PostgreSQL, MySQL, MariaDB, 
Oracle, MSSQL)
? Which *production* database would you like to use? MySQL
? Which *development* database would you like to use? H2 with disk-based persistence
? Which cache do you want to use? (Spring cache abstraction) Hazelcast (distributed cache, 
for multiple nodes, supports rate-limiting for gateway applications)
? Do you want to use Hibernate 2nd level cache? Yes
? Would you like to use Maven or Gradle for building the backend? Gradle
? Which other technologies would you like to use? 
? Would you like to enable internationalization support? Yes
? Please choose the native language of the application French
? Please choose additional languages to install English
? Besides JUnit and Jest, which testing frameworks would you like to use? Cypress, Gatling, Cucumber
? Would you like to install other generators from the JHipster Marketplace? No

Generation of the microservice `notification` (without entities)

mkdir -p ~/github/mastering-microservices/notification
cd  ~/github/mastering-microservices/notification
jhipster

Answer to the questions:

? Which *type* of application would you like to create? Microservice application
? Do you want to enable *microfrontends*? No
? What is the base name of your application? notification
? Do you want to make it reactive with Spring WebFlux? No
? As you are running in a microservice architecture, on which port would like your server 
to run? It should be unique to avoid port conflicts. 8083
? What is your default Java package name? mosig.cloud.store.notification
? Which service discovery server do you want to use? JHipster Registry (uses Eureka, 
provides Spring Cloud Config support and monitoring dashboards)
? Which *type* of authentication would you like to use? JWT authentication (stateless, with
 a token)
? Which *type* of database would you like to use? MongoDB
? Which cache do you want to use? (Spring cache abstraction) Hazelcast (distributed cache, 
for multiple nodes, supports rate-limiting for gateway applications)
? Would you like to use Maven or Gradle for building the backend? Gradle
? Which other technologies would you like to use? 
? Would you like to enable internationalization support? Yes
? Please choose the native language of the application French
? Please choose additional languages to install English
? Besides JUnit and Jest, which testing frameworks would you like to use? Cypress, Gatling,
 Cucumber
? Would you like to install other generators from the JHipster Marketplace? No

Launch the service registry

cd ~/github/mastering-microservices/gateway
docker-compose -f src/main/docker/jhipster-registry.yml up

Launch the gateway (`dev` profile)

cd ~/github/mastering-microservices/gateway
./gradlew

If gradlew fails on java.lang.IllegalArgumentException: Unsupported class file major version 6x, you must edit this gradle/wrapper/gradle-wrapper.properties for fixing a newer version of the gradle binary (gradle-*-bin.zip)

Browse the application

When the gateway is ready (Message Application 'gateway' is running! Access URLs: in the console), you can browser the web application.

open http://localhost:8080

More information ...

Browse the service registry console

open http://localhost:8761

More information ...

Launch the microservice `productorder` (`dev` profile)

cd  ~/github/mastering-microservices/productorder
./gradlew

If gradlew fails on java.lang.IllegalArgumentException: Unsupported class file major version 6x, you must edit this gradle/wrapper/gradle-wrapper.properties for fixing a newer version of the gradle binary (gradle-*-bin.zip)

Remark : H2 is the database system for dev porfile. A port conflit de port (3306) between the mysql container used by the gateway and the mysql container used by the gateway used by microservice.

When the microservice 'productorder' is ready (Message Application 'productorder' is running! Access URLs: in the console), have a look on the OpenAPI descriptor

wget http://localhost:8081/v3/api-docs -O openapi.json
jq "." openapi.json

Launch the microservice `invoice` (`dev` profile)

cd  ~/github/mastering-microservices/invoice
./gradlew

If gradlew fails on java.lang.IllegalArgumentException: Unsupported class file major version 6x, you must edit this gradle/wrapper/gradle-wrapper.properties for fixing a newer version of the gradle binary (gradle-*-bin.zip)

When the microservice 'invoice' is ready (Message Application 'invoice' is running! Access URLs: in the console), have a look on the OpenAPI descriptor

wget  -O openapi.json
jq "." openapi.json

Launch the microservice `notification` (`dev` profile)

Launch the mongodb container

cd  ~/github/mastering-microservices/notification
docker-compose -f src/main/docker/mongodb.yml up -d
docker-compose -f src/main/docker/mongodb.yml logs -f

Wait for the readyness of mongodb

Launch the application in dev profile

cd  ~/github/mastering-microservices/notification
./gradlew

If gradlew fails on java.lang.IllegalArgumentException: Unsupported class file major version 6x, you must edit this gradle/wrapper/gradle-wrapper.properties for fixing a newer version of the gradle binary (gradle-*-bin.zip)

When the microservice 'notification' is ready (Message Application 'notification' is running! Access URLs: in the console), have a look on the OpenAPI descriptor

wget http://localhost:8083/v3/api-docs -O openapi.json
jq "." openapi.json

Browse the application

open http://localhost:8080

What can you see ? What's happen if one microservice is stopped (failure simulation ...)?

Browse the service registry

open http://localhost:8761

What can you see ? What's happen if one microservice is stopped (failure simulation ...)?

Refactoring of the application schema

You should refactor the schema of the application online-store in three microservices and generate their source code.

The entities are scattered between

the microservice productorder productorder-jdl.jh
the microservice invoice invoice-jdl.jh

New entities are added into the microservice notification notification-jdl.jh

All the entities are described into gateway-jdl-all.jh for generating the frontend served by the API gateway.

The relationship OneToMany ProductOrder{invoice} to Invoice{order} is replaced by the property invoiceId into the entity ProductOrder.

Generation of the frontend

cd  ~/github/mastering-microservices/gateway
jhipster import-jdl ../tutorial_en/microservices/gateway-jdl-all.jh
git status

Generation of the code of the microservice `productorder`

cd  ~/github/mastering-microservices/productorder
jhipster import-jdl ../tutorial_en/microservices/productorder-jdl.jh
git status

Generation of the code of the microservice `invoice`

cd  ~/github/mastering-microservices/invoice
jhipster import-jdl ../tutorial_en/microservices/invoice-jdl.jh
git status

Generation of the code of the microservice `notification`

cd  ~/github/mastering-microservices/notification
jhipster import-jdl ../tutorial_en/microservices/notification-jdl.jh
git status

Launch the service registry

cd ~/github/mastering-microservices/gateway
docker-compose -f src/main/docker/jhipster-registry.yml up -d
docker-compose -f src/main/docker/jhipster-registry.yml logs -f

Launch the gateway

Lancez l'application en profil dev.

cd ~/github/mastering-microservices/gateway
./gradlew

Launch the microservice `productorder` (`dev` profil)

Lancez l'application en profil dev.

cd  ~/github/mastering-microservices/productorder
./gradlew

Launch the microservice `invoice` (`dev` profil)

Lancez l'application en profil dev.

cd  ~/github/mastering-microservices/invoice
./gradlew

Launch the microservice `notification` (`dev` profil)

(Re)lauch the mongodb container.

cd  ~/github/mastering-microservices/notification
docker-compose -f src/main/docker/mongodb.yml up -d
docker-compose -f src/main/docker/mongodb.yml logs -f

cd  ~/github/mastering-microservices/notification
./gradlew

Build the Docker images

cd  ~/github/mastering-microservices/gateway
cat README.md
nvm use stable
npm run java:docker
docker images | grep gateway

cd  ~/github/mastering-microservices/productorder
cat README.md
nvm use stable
npm run java:docker
docker images | grep productorder

cd  ~/github/mastering-microservices/invoice
cat README.md
nvm use stable
npm run java:docker
docker images | grep invoice

cd  ~/github/mastering-microservices/notification
cat README.md
nvm use stable
npm run java:docker
docker images | grep notification

Use npm run java:docker:arm64 for Mac Silicon. However, you should rebuild the microservices' images for intel x86 architecture before pushing them the GCP registry in order to run on GCP's k8n cluster.

Generation the `docker-compose` files

mkdir -p  ~/github/mastering-microservices/docker-compose
cd  ~/github/mastering-microservices/docker-compose
jhipster docker-compose

Answer to the questions:

? Which *type* of application would you like to deploy? Microservice application
? Which *type* of gateway would you like to use? JHipster gateway based on Spring Cloud Gateway
? Enter the root directory where your gateway(s) and microservices are located ../
4 applications found at /Users/donsez/github/mastering-microservices/

? Which applications do you want to include in your configuration? gateway, invoice, notification, productorder
? Which applications do you want to use with clustered databases (only available with MongoDB and Couchbase)? notification
? Do you want to setup monitoring for your applications ? Yes, for metrics only with Prometheus
JHipster registry detected as the service discovery and configuration provider used by your apps
? Enter the admin password used to secure the JHipster Registry admin

Launch the containers

docker-compose up -d
docker-compose ps

                   Name                                 Command               State           Ports         
------------------------------------------------------------------------------------------------------------
docker-compose_alertmanager_1                /bin/alertmanager --config ...   Up      0.0.0.0:9093->9093/tcp
docker-compose_gateway-postgresql_1          docker-entrypoint.sh postgres    Up      5432/tcp              
docker-compose_gateway_1                     bash -c /entrypoint.sh           Up      0.0.0.0:8080->8080/tcp
docker-compose_grafana_1                     /run.sh                          Up      0.0.0.0:3000->3000/tcp
docker-compose_invoice-mysql_1               docker-entrypoint.sh mysql ...   Up      3306/tcp, 33060/tcp   
docker-compose_invoice_1                     bash -c /entrypoint.sh           Up      5701/udp, 8082/tcp    
docker-compose_jhipster-registry_1           bash -c /entrypoint.sh           Up      0.0.0.0:8761->8761/tcp
docker-compose_notification-mongodb-node_1   docker-entrypoint.sh mongo ...   Up      27017/tcp             
docker-compose_notification-mongodb_1        docker-entrypoint.sh mongo ...   Up      27017/tcp             
docker-compose_notification_1                bash -c /entrypoint.sh           Up      5701/udp, 8083/tcp    
docker-compose_productorder-postgresql_1     docker-entrypoint.sh postgres    Up      5432/tcp              
docker-compose_productorder_1                bash -c /entrypoint.sh           Up      5701/udp, 8081/tcp    
docker-compose_prometheus_1                  /bin/prometheus --config.f ...   Up      0.0.0.0:9090->9090/tcp
notification-mongodb-config                  docker-entrypoint.sh mongo ...   Up      27017/tcp

docker-compose logs -f

Add an extra instance for invoice-app

docker-compose scale invoice-app=2

Monitor the microservices

Observability is an important requirement in microservices architecture.

More detail on monitoring with JHipster-generated microservices.

Since ELK stack is really heavy, prefer Prometheus and Grafana for monitoring your architecture.

Prometheus and Grafana

Follow the instructions.

Grafana and Prometheus are launched into the composition thanks to your answer to the query ? Do you want to setup monitoring for your applications ? Yes, for metrics only with Prometheus

Open the console

open http://localhost:3000

Default password for admin user is admin` . Grafana will ask you to change it !

Zipkin

This section is optional.

Zipkin is a distributed tracing system. It helps gather timing data needed to troubleshoot latency problems in service architectures.

Follow the instructions.

ELK (Elasticsearch, Logstash, Kibana) Stack (if your host had plenty GB of RAM)

This section is optional.

cd ~/github/mastering-microservices
git clone https://github.com/jhipster/jhipster-console.git
cd jhipster-console
docker-compose up -d
docker-compose ps
docker-compose logs -f

Open the console

open http://localhost:5601

You should modify the property logging.logstash.enabled=true in the file application-prod.yml of the gateway and the microservices.

Regenerate and restart the containers.

Open the console

open http://localhost:5601

Remark: Generate all the microservices

This section is optional.

You can directly generate all the microservices with their entities

Remember to change the client frontend framework !

mkdir -p ~/github/mastering-microservices/microservices
cd  ~/github/mastering-microservices/microservices
wget https://raw.githubusercontent.com/jhipster/jdl-samples/main/microservice-ecommerce-store-4-apps.jdl

Edit microservice-ecommerce-store-4-apps.jdl in order to change database systems (postgresql instead of mysql for the invoice microservice) and add properties to the Product entity.

jhipster import-jdl microservice-ecommerce-store-4-apps.jdl

FilesExpand file tree

microservices.md

Latest commit

History

microservices.md

File metadata and controls

Tutorial on Microservices Architecture with JHipster :: Microservices

Architecture

Generation of the gateway (without entities)

Generation of the microservice productorder (without entities)

Generation of the (microservice invoice (without entities)

Generation of the microservice notification (without entities)

Launch the service registry

Launch the gateway (dev profile)

Browse the application

Browse the service registry console

Launch the microservice productorder (dev profile)

Launch the microservice invoice (dev profile)

Launch the microservice notification (dev profile)

Browse the application

Browse the service registry

Refactoring of the application schema

Generation of the frontend

Generation of the code of the microservice productorder

Generation of the code of the microservice invoice

Generation of the code of the microservice notification

Launch the service registry

Launch the gateway

Launch the microservice productorder (dev profil)

Launch the microservice invoice (dev profil)

Launch the microservice notification (dev profil)

Build the Docker images

Generation the docker-compose files

Monitor the microservices

Prometheus and Grafana

Zipkin

ELK (Elasticsearch, Logstash, Kibana) Stack (if your host had plenty GB of RAM)

Remark: Generate all the microservices

Generation of the `gateway` (without entities)

Generation of the microservice `productorder` (without entities)

Generation of the (microservice `invoice` (without entities)

Generation of the microservice `notification` (without entities)

Launch the gateway (`dev` profile)

Launch the microservice `productorder` (`dev` profile)

Launch the microservice `invoice` (`dev` profile)

Launch the microservice `notification` (`dev` profile)

Generation of the code of the microservice `productorder`

Generation of the code of the microservice `invoice`

Generation of the code of the microservice `notification`

Launch the microservice `productorder` (`dev` profil)

Launch the microservice `invoice` (`dev` profil)

Launch the microservice `notification` (`dev` profil)

Generation the `docker-compose` files