fredgcosta / cloud-native-starter

Cloud Native Starter for Java/Jakarta EE based Microservices on Kubernetes and Istio

Cloud Native Starter for Java/Jakarta EE based Microservices on Kubernetes and Istio

This project contains sample code that demonstrates how to get started with cloud-native applications and microservice based architectures.

The project focusses on how to build microservices with Java EE and the open source technologies Eclipse MicroProfile, Eclipse OpenJ9, AdoptOpenJDK and Open Liberty.

The microservices can be easily deployed on Kubernetes environments running Istio like Minikube, Minishift (single-node OpenShift cluster inside a VM), or the IBM Cloud Kubernetes Service.

The project showcases the following functionality:

• REST APIs implementations incl. documentation
• REST API invocations
• Traffic management
• Resiliency via fallbacks and circuit breakers
• Authentication and authorization
• Distributed tracing and logging
• Monitoring and metrics
• Persistence for Java microservices via JPA

This diagram shows the key components:

The next screenshot shows the web application. More screenshots are in the images folder.

Demos

This project demonstrates several Java EE and Istio key functionality.

• Containerized Java EE Microservices
• Exposing REST APIs
• Consuming REST APIs
• Traffic Routing
• Resiliency
• Authentication and Authorization
• Metrics
• Health Checks
• Configuration
• Distributed Logging and Monitoring
• Persistence with Java Persistence API (JPA)

Setup

The sample application can be run in four different environments:

1. Minikube (locally): See instructions below.
2. IBM Cloud Kubernetes Service - see instructions
3. Minishift (locally) - see instructions
4. OpenShift on the IBM Cloud - see instructions

The following instructions describe how to install everything locally on Minikube.

Before the microservices can be installed, make sure you've set up Minikube and Istio correctly or follow these instructions to set up Minikube and Istio from scratch. This should not take longer than 30 minutes.

Before deploying the application, get the code:

$ git clone https://github.com/nheidloff/cloud-native-starter.git
$ cd cloud-native-starter
$ ROOT_FOLDER=$(pwd)

The microservices can be installed via scripts. In addition to Minikube and Istio you need the following tools to be available.

Prerequisites:

• docker
• git
• curl
• kubectl

Docker always needs to be installed locally. The tools git, curl and kubectl (and ibmcloud) can be installed locally or you can use a Docker image that comes with these tools.

$ cd ${ROOT_FOLDER}
$ docker run -v $ROOT_FOLDER/:/cloud-native-starter -it --rm ibmcom/ibm-cloud-developer-tools-amd64

Deploy (and redeploy):

$ cd ${ROOT_FOLDER}
$ scripts/check-prerequisites.sh
$ scripts/deploy-articles-java-jee.sh
$ scripts/deploy-web-api-java-jee.sh
$ scripts/deploy-authors-nodejs.sh
$ scripts/deploy-web-app-vuejs.sh
$ scripts/deploy-istio-ingress-v1.sh
$ scripts/show-urls.sh

After running the scripts above, you will get a list of all URLs in the terminal.

Example URL to open the web app: http://192.168.99.100:31380

Example API endpoint: http://192.168.99.100:31380/web-api/v1/getmultiple

Cleanup

Run the following command to delete all cloud-native-starter components from Istio.

$ scripts/delete-all.sh

You can also delete single components:

$ scripts/delete-articles-java-jee.sh
$ scripts/delete-articles-java-jee-quarkus.sh
$ scripts/delete-web-api-java-jee.sh
$ scripts/delete-authors-nodejs.sh
$ scripts/delete-web-app-vuejs.sh
$ scripts/delete-istio-ingress.sh

Authors

• Niklas Heidloff
• Harald Uebele
• Thomas Südbröcker

Documentation

The following slides summarize this repo:

Here is a series of blog entries about this project:

• Project Description and Design Principles
• Presentation at We Are Developers (30 mins): How to develop your first cloud-native Applications with Java
• Slides: How to develop your first cloud-native Applications with Java and four recorded demos
• Setup of a Local Kubernetes and Istio Dev Environment
• Debugging Microservices running in Kubernetes
• Dockerizing Java MicroProfile Applications
• Developing resilient Microservices with Istio and MicroProfile
• Using Quarkus to run Java Apps on Kubernetes
• Managing Microservices Traffic with Istio
• Web Application to demo Traffic Management with Istio
• Implementing and documenting REST APIs with JavaEE
• Invoking REST APIs from Java Microservices
• Prometheus Metrics for MicroProfile Microservices in Istio
• Moving from Minikube to IBM Cloud Kubernetes Service
• Distributed logging with LogDNA and Monitoring with Sysdig
• Implementing Health Checks with MicroProfile and Istio
• Configuring Microservices with MicroProfile and Kubernetes
• Authenticating Web Users with OpenID and JWT
• Authorization in Cloud-Native Applications via OpenID and Istio
• Authorization in Microservices with MicroProfile
• Persistence for Java Microservices in Kubernetes via JPA
• How to build and run a Hello World Java Microservice
• Source to Image Builder for Open Liberty Apps on OpenShift
• Setting up a cloud-native Sample App on Minishift in an Hour
• How to develop Open Liberty Microservices on OpenShift
• Deploying Open Liberty Microservices to OpenShift
• Deploying the Cloud Native Starter microservices on Minishift

Here is more information about Microservices, MicroProfile and Istio:

• MicroProfile, the microservice programming model made for Istio
• Migrating Java Microservices to MicroProfile – Epilogue
• Video: Istio Platform vs Spring and MicroProfile frameworks
• Video: Java EE, Jakarta EE, MicroProfile, Or Maybe All Of Them?
• Video: Istio: Canaries and Kubernetes, Microservices and Service Mesh