JHipster Microservices Example

A microservice architecture created with JHipster. Uses Spring Cloud, Spring Boot, Angular, and MongoDB for a simple blog/store applications.

Please read Develop and Deploy Microservices with JHipster to see how this example was created.

Prerequisites: Java 8, Node.js 6.11, Yarn, and Docker.

NOTE: If you're not on Mac or Windows, you may need to install Docker Compose as well.

Okta has Authentication and User Management APIs that reduce development time with instant-on, scalable user infrastructure. Okta's intuitive API and expert support make it easy for developers to authenticate, manage and secure users and roles in any application.

• Getting Started
• Links
• Help
• License

Getting Started

To install this example application, run the following commands:

git clone https://github.com/oktadeveloper/jhipster-microservices-example.git
cd jhipster-microservices-example

1. Start the registry by running ./mvnw -Pprod in the registry directory.

2. Install dependencies in the blog directory, build the UI, and run the Spring Boot app.

   yarn
   ./mvnw 
   

3. Start MongoDB using Docker Compose in the store directory.

   docker-compose -f src/main/docker/mongodb.yml up
   

4. Install dependencies in the store directory, build the UI, and run the Spring Boot app.

   yarn
   ./mvnw 
   

You should be able to see the blog app at http://localhost:8080 and edit products (from the store app)

Run with Docker Compose

You can use Docker Compose to start everything if you don't want to start applications manually with Maven.

1. Make sure Docker is running.

2. Build Docker images for the blog and store applications by running the following command in both directories.

   ./mvnw package -Pprod docker:build
   

3. Open a terminal, navigate to the docker directory of this project, and run the following command. If you have a lot of RAM on your machine, you might want to adjust Docker's default setting (2 GB).

   docker-compose up -d
   

   TIP: Remove -d from the end of the command above if you want to see logs from all containers in the current window.

4. Use Kitematic to view the ports and logs for the services deployed.

To create activity in JHipster Console's charts, you run the Gatling tests in the blog and store projects.

./mvnw gatling:execute

To remove all Docker containers, run the following commands or do it manually using Kitematic.

docker stop $(docker ps -a -q)
docker rm $(docker ps -a -q)

To find what's running on a port on macOS, use sudo lsof -i :9092 # checks port 9092.

Run with Kubernetes and Minikube

1. Install kubectl, VirtualBox, and Minikube.

2. Start Minikube using minikube start.

3. To be able to work with the docker daemon, make sure Docker is running, then run the following command in your terminal:

   eval $(minikube docker-env)
   

4. Create Docker images of the blog and store applications:

   ./mvnw package -Pprod docker:build
   

5. Navigate to the kubernetes directory in your terminal and re-generate the files so they match your Docker repository name.

   jhipster kubernetes
   

   Follow the instructions for tagging and pushing the Docker images.

   docker image tag blog {yourRepoName}/blog
   docker push {yourRepoName}/blog
   docker image tag store {yourRepoName}/store
   docker push {yourRepoName}/store
   

6. Use kubectl to deploy to Minikube.

   kubectl apply -f registry
   kubectl apply -f blog
   kubectl apply -f store
   

   The deployment process can take several minutes to complete. Run minikube dashboard to see the deployed containers. You can also run kubectl get po -o wide --watch to see the status of each pod.

7. Run minikube service blog to view the blog application. You should be able to login and add blogs, entries, and products.

To remove all deployed containers, run the following command:

kubectl delete deployment --all

To stop Minikube, run minikube stop.

NOTE: If you run minikube delete and have trouble running minikube start afterward, run rm -rf ~/.minikube. See this issue for more information.

Google Cloud

1. Create a Google Cloud project at console.cloud.google.com.

2. Navigate to https://console.cloud.google.com/kubernetes/list to initialize the Container Engine for your project.

3. Install Google Cloud SDK and set project using:

   gcloud config set project <project-name>
   

4. Create a cluster:

   gcloud container clusters create <cluster-name> --machine-type=n1-standard-2 --scopes cloud-platform --zone us-west1-a
   

   To see a list of possible zones, run gcloud compute zones list.

5. Push the blog and store docker images to Docker Hub. You will need to create an account and run docker login to push your images. The images can be run from any directory.

   docker image tag blog mraible/blog
   docker push mraible/blog
   docker image tag store mraible/store
   docker push mraible/store
   

6. Run kubectl commands to deploy.

   kubectl apply -f registry
   kubectl apply -f blog
   kubectl apply -f store
   

7. Use port-forwarding to see the registry app locally.

   kubectl port-forward jhipster-registry-0 8761:8761
   

8. Run kubectl svc blog to view the blog application on Google Cloud.

9. Scale microservice apps as needed with kubectl:

   kubectl scale --replicas=3 deployment/store
   

To see a screencast of this process, watch this YouTube video.

AWS

If you know how to deploy this architecture to AWS, I'd love to hear about it! I tried in anger, but ultimately failed.

Links

This example uses JHipster, and awesome project that allows you to generate a microservices architecture with Spring Boot. See Develop a Microservices Architecture with OAuth 2.0 and JHipster for an example that uses OAuth and Okta.

Help

Please post any questions as comments on the [email protected] if would like to create a support ticket.

License

Apache 2.0, see LICENSE.