How to Develop Open Liberty Microservices on OpenShift

Open Liberty is a flexible Java application server. It comes with Eclipse MicroProfile, which is a set of tools and APIs to build microservices. With these technologies, I have created a simple hello world microservice that can be used as a template for your own microservices. In this article, I describe how to deploy it to OpenShift.


The sample microservice is available as open source.


Microservice Implementation


The microservice contains the following functionality:


Image with OpenJ9, OpenJDK, Open Liberty, and MicroProfile: Dockerfile


Maven project: pom.xml


Open Liberty server configuration: server.xml


Health endpoint: HealthEndpoint.java


Kubernetes YAML files: deployment.yaml and service.yaml


Sample REST GET endpoint: AuthorsApplication.java, GetAuthor.java, and Author.java


If you want to use this code for your own microservice, remove the three Java files for the REST GET endpoint and rename the service in the pom.xml file and the YAML files.


Deployment Options


The microservice can be run in different environments:



Minikube


IBM Cloud Kubernetes Service


Minishift


Red Hat OpenShift on the IBM Cloud


Deployment to Red Hat OpenShift on the IBM Cloud


The following instructions should work for OpenShift, no matter where you run it. However I've only tested it on the IBM Cloud.


IBM provides a managed Red Hat OpenShift offering on the IBM Cloud (beta). You can get a free IBM Cloud Liteaccount.


After you've created a new cluster, open the OpenShift console. From the dropdown menu in the upper right of the page, click 'Copy Login Command'. Paste the copied command in your local terminal, for example, 'oc login https://c1-e.us-east.containers.cloud.ibm.com:23967 -token=xxxxxx'.


Get the code:


$ git clone https://github.com/nheidloff/cloud-native-starter.git

$ cd cloud-native-starter

$ ROOT_FOLDER=$(pwd)

Push the code and build the image:


$ cd ${ROOT_FOLDER}/authors-java-jee

$ oc login ...

$ oc new-project cloud-native-starter

$ oc new-build --name authors --binary --strategy docker

$ oc start-build authors --from-dir=.

$ oc get istag

Wait until the image has been built. Then deploy the microservice:


$ cd ${ROOT_FOLDER}/authors-java-jee/deployment

$ sed "s+<namespace>+cloud-native-starter+g" deployment-template.yaml > deployment-template.yaml.1

$ sed "s+<ip:port>+docker-registry.default.svc:5000+g" deployment-template.yaml.1 > deployment-template.yaml.2

$ sed "s+<tag>+latest+g" deployment-template.yaml.2 > deployment-os.yaml

$ oc apply -f deployment-os.yaml

$ oc apply -f service.yaml

$ oc expose svc/authors

$ open http://$(oc get route authors -o jsonpath={.spec.host})/openapi/ui/

$ curl -X GET "http://$(oc get route authors -o jsonpath={.spec.host})/api/v1/getauthor?name=Niklas%20Heidloff" -H "accept: application/json"

Rather than using 'oc apply' (which is essentially 'kubectl apply'), you can also use 'oc new-app'. In this case you don't have to create yaml files which makes it easier. At the same time you loose some flexibility and capabilities that kubectl with yaml files provides.


$ oc new-app authors

After this you'll be able to open the API explorer and invoke the endpoint:




After the deployment the application will show up in the OpenShift Web Console:




Note that there are several other options to deploy applications to OpenShift/OKD. Check out my previous article Deploying Open Liberty Microservices to OpenShift.


This sample is part of the GitHub repo cloud-native-starter. Check it out to learn how to develop cloud-native applications with Java EE/Jakarta EE, Eclipse MicroProfile, Kubernetes, and Istio and how to deploy these applications to Kubernetes, Minikube, OpenShift, and Minishift.


Comments

Post a Comment

Please Share Your Views

Popular posts from this blog

SSO — WSO2 API Manager and Keycloak Identity Manager

Image
In this article, we are going to see how to implement Single Sign-On (SSO) for WSO2 API Manager using Keycloak as a Federated Identity Provider. Also, we'll choose a deep-dive showing how debugging works with the WSO2 API Manager code to see what happens inside when it's configured with a third-party identity provider (i.e Keycloak in this example). High-Level Architecture This is what we are going to do in this tutorial. High-level architecture Software Needed Following softwares will be needed: WSO2 API Manager (2.6.0) Keycloak (6.0.1) Note : We aren’t getting to use WSO2 Identity Server as a middleman for this tutorial. The article is predicated on pure WSO2 API Manager 2.6.0 (all in one). Before We Start The tutorial will be divided into two parts. In the first part, I will explain how to install and configure Keycloak. In the second part, we will see how to install and configure the WSO2 API Manager. Before we start, let's modify the  /etc/hosts  file ...
Read more

Garbage Collectors - Serial vs. Parallel vs. CMS vs. G1 (and what’s new in Java 8)

Image
The 4 Java Garbage Collectors – How the Wrong Choice Dramatically Impacts Performance When Garbage collection is one of those things that are generally known to impact performance, but beyond that – in terms of how it actually works – it’s pretty much a mystery to most of us. So, I thought I’d take a whack at covering the basics of GC, especially since this is an area that has seen some major changes and improvements with Java 8, especially with the removal of the PermGen and some new and exciting optimizations (more on this towards the end). When we speak about garbage collection, the vast majority of us know the concept and employ it in our everyday programming. Even so, there’s much about it we don’t understand, and that’s when things get painful. One of the biggest misconceptions about the JVM is that it has one garbage collector, where in fact it provides  four different ones , each with its own unique advantages and disadvantages. The choice of which one to use isn’t automati...
Read more

Recommendation System Using Word2Vec with Python

Image
Overview Recommendation engines are ubiquitous nowadays and data scientists are expected to know how to build one Word2vec is an ultra-popular word embeddings used for performing a variety of  NLP  tasks We will use word2vec to build our own recommendation system. Curious how NLP and recommendation engines combine? Let’s find out!   Introduction Be honest – how many times have you used the ‘Recommended for you’ section on Amazon? Ever since I found out a few years back that machine learning powers this section – I have been hooked. I keep an eye on that section each time I log into Amazon. There’s a reason companies like Netflix, Google, Amazon, Flipkart, etc. spend millions perfecting their recommendation engine. It is a powerful acquisition channel and enhances the customer’s experience. Let me use a recent example to showcase their power. I went to a popular online marketplace looking for a recliner. There were hundreds of them. From Traditional two-position recliners ...
Read more