25 minutesPrerequisites:
Deploy microservices in Open Liberty Docker containers to Kubernetes and manage them with the Kubernetes CLI, kubectl.
Kubernetes is an open source container orchestrator that automates many tasks involved in deploying, managing, and scaling containerized applications.
Over the years, Kubernetes has become a major tool in containerized environments as containers are being further leveraged for all steps of a continuous delivery pipeline.
Managing individual containers can be challenging. A few containers used for development by a small team might not pose a problem, but managing hundreds of containers can give even a large team of experienced developers a headache. Kubernetes is a primary tool for deployment in containerized environments. It handles scheduling, deployment, as well as mass deletion and creation of containers. It provides update rollout abilities on a large scale that would otherwise prove extremely tedious to do. Imagine that you updated a Docker image, which now needs to propagate to a dozen containers. While you could destroy and then re-create these containers, you can also run a short one-line command to have Kubernetes make all those updates for you. Of course, this is just a simple example. Kubernetes has a lot more to offer.
Deploying an application to Kubernetes means deploying an application to a Kubernetes cluster.
A typical Kubernetes cluster is a collection of physical or virtual machines called nodes that run containerized applications. A cluster is made up of one master node that manages the cluster, and many worker nodes that run the actual application instances inside Kubernetes objects called pods.
A pod is a basic building block in a Kubernetes cluster. It represents a single running process that encapsulates a container or in some scenarios many closely coupled containers. Pods can be replicated to scale applications and handle more traffic. From the perspective of a cluster, a set of replicated pods is still one application instance, although it might be made up of dozens of instances of itself. A single pod or a group of replicated pods are managed by Kubernetes objects called controllers. A controller handles replication, self-healing, rollout of updates, and general management of pods. One example of a controller that you will use in this guide is a deployment.
A pod or a group of replicated pods are abstracted through Kubernetes objects called services that define a set of rules by which the pods can be accessed. In a basic scenario, a Kubernetes service exposes a node port that can be used together with the cluster IP address to access the pods encapsulated by the service.
To learn about the various Kubernetes resources that you can configure, see the official Kubernetes documentation.
You will learn how to deploy two microservices in Open Liberty containers to a local Kubernetes cluster. You will then manage your deployed microservices using the kubectl command line interface for Kubernetes. The kubectl CLI is your primary tool for communicating with and managing your Kubernetes cluster.
The two microservices you will deploy are called system and inventory. The system microservice returns the JVM system properties of the running container and it returns the pod’s name in the HTTP header making replicas easy to distinguish from each other. The inventory microservice adds the properties from the system microservice to the inventory. This demonstrates how communication can be established between pods inside a cluster.
You will use a local single-node Kubernetes cluster.
Before you begin, you need a containerization software for building containers. Kubernetes supports various container runtimes. You will use Docker in this guide. For Docker installation instructions, refer to the official Docker documentation.
WINDOWS
MAC
LINUX
Use Docker Desktop, where a local Kubernetes environment is pre-installed and enabled. If you do not see the Kubernetes tab, then upgrade to the latest version of Docker Desktop.
Complete the setup for your operating system:
Set up Docker for Windows.
After you complete the Docker setup instructions for your operating system, ensure that Kubernetes (not Swarm) is selected as the orchestrator in Docker Preferences.
Use Docker Desktop, where a local Kubernetes environment is pre-installed and enabled. If you do not see the Kubernetes tab, then upgrade to the latest version of Docker Desktop.
Complete the setup for your operating system:
Set up Docker for Mac.
After you complete the Docker setup instructions for your operating system, ensure that Kubernetes (not Swarm) is selected as the orchestrator in Docker Preferences.
You will use Minikube as a single-node Kubernetes cluster that runs locally in a virtual machine. For Minikube installation instructions, see the Minikube documentation. Be sure to read the Requirements section, as different operating systems require different prerequisites to run Minikube.
The fastest way to work through this guide is to clone the Git repository and use the projects that are provided inside:
git clone https://github.com/openliberty/guide-kubernetes-intro.git
cd guide-kubernetes-introThe start directory contains the starting project that you will build upon.
The finish directory contains the finished project that you will build.
Start your Kubernetes cluster.
WINDOWS
MAC
LINUX
Start your Docker Desktop environment.
Run the following command from a command line:
minikube startNext, validate that you have a healthy Kubernetes environment by running the following command from the command line.
kubectl get nodesThis command should return a Ready status for the master node.
WINDOWS
MAC
LINUX
You do not need to do any other step.
Run the following command to configure the Docker CLI to use Minikube’s Docker daemon. After you run this command, you will be able to interact with Minikube’s Docker daemon and build new images directly to it from your host machine:
eval $(minikube docker-env)The first step of deploying to Kubernetes is to build your microservices and containerize them with Docker.
The starting Java project, which you can find in the start directory, is a multi-module Maven project that’s made up of the system and inventory microservices. Each microservice resides in its own directory, start/system and start/inventory. Each of these directories also contains a Dockerfile, which is necessary for building Docker images. If you’re unfamiliar with Dockerfiles, check out the Containerizing Microservices guide, which covers Dockerfiles in depth.
Navigate to the start directory and run the following command to build the applications:
mvn clean packageNext, run the docker build commands to build container images for your application:
docker build -t system:1.0-SNAPSHOT system/.
docker build -t inventory:1.0-SNAPSHOT inventory/.The -t flag in the docker build command allows the Docker image to be labeled (tagged) in the name[:tag] format. The tag for an image describes the specific image version. If the optional [:tag] tag is not specified, the latest tag is created by default.
During the build, you’ll see various Docker messages describing what images are being downloaded and built. When the build finishes, run the following command to list all local Docker images:
docker imagesVerify that the system:1.0-SNAPSHOT and inventory:1.0-SNAPSHOT images are listed among them, for example:
WINDOWS
MAC
LINUX
REPOSITORY TAG
inventory 1.0-SNAPSHOT
system 1.0-SNAPSHOT
open-liberty latest
k8s.gcr.io/kube-proxy-amd64 v1.10.3
k8s.gcr.io/kube-scheduler-amd64 v1.10.3
k8s.gcr.io/kube-controller-manager-amd64 v1.10.3
k8s.gcr.io/kube-apiserver-amd64 v1.10.3
k8s.gcr.io/etcd-amd64 3.1.12
k8s.gcr.io/k8s-dns-dnsmasq-nanny-amd64 1.14.8
k8s.gcr.io/k8s-dns-sidecar-amd64 1.14.8
k8s.gcr.io/k8s-dns-kube-dns-amd64 1.14.8
k8s.gcr.io/pause-amd64 3.1REPOSITORY TAG
inventory 1.0-SNAPSHOT
system 1.0-SNAPSHOT
open-liberty latest
k8s.gcr.io/kube-proxy-amd64 v1.10.0
k8s.gcr.io/kube-controller-manager-amd64 v1.10.0
k8s.gcr.io/kube-apiserver-amd64 v1.10.0
k8s.gcr.io/kube-scheduler-amd64 v1.10.0
quay.io/kubernetes-ingress-controller/nginx-ingress-controller 0.12.0
k8s.gcr.io/etcd-amd64 3.1.12
k8s.gcr.io/kube-addon-manager v8.6
k8s.gcr.io/k8s-dns-dnsmasq-nanny-amd64 1.14.8
k8s.gcr.io/k8s-dns-sidecar-amd64 1.14.8
k8s.gcr.io/k8s-dns-kube-dns-amd64 1.14.8
k8s.gcr.io/pause-amd64 3.1
k8s.gcr.io/kubernetes-dashboard-amd64 v1.8.1
k8s.gcr.io/kube-addon-manager v6.5
gcr.io/k8s-minikube/storage-provisioner v1.8.0
gcr.io/k8s-minikube/storage-provisioner v1.8.1
k8s.gcr.io/defaultbackend 1.4
k8s.gcr.io/k8s-dns-sidecar-amd64 1.14.4
k8s.gcr.io/k8s-dns-kube-dns-amd64 1.14.4
k8s.gcr.io/k8s-dns-dnsmasq-nanny-amd64 1.14.4
k8s.gcr.io/etcd-amd64 3.0.17
k8s.gcr.io/pause-amd64 3.0If you don’t see the system:1.0-SNAPSHOT and inventory:1.0-SNAPSHOT images, then check the Maven build log for any potential errors. In addition, if you are using Minikube, make sure your Docker CLI is configured to use Minikube’s Docker daemon and not your host’s as described in the previous section.
Now that your Docker images are built, deploy them using a Kubernetes resource definition.
A Kubernetes resource definition is a yaml file that contains a description of all your deployments, services, or any other resources that you want to deploy. All resources can also be deleted from the cluster by using the same yaml file that you used to deploy them.
Create the Kubernetes configuration file.
kubernetes.yamlkubernetes.yaml
1apiVersion: apps/v1
2kind: Deployment
3metadata:
4 name: system-deployment
5 labels:
6 app: system
7spec:
8 selector:
9 matchLabels:
10 app: system
11 template:
12 metadata:
13 labels:
14 app: system
15 spec:
16 containers:
17 - name: system-container
18 image: system:1.0-SNAPSHOT
19 ports:
20 - containerPort: 9080
21---
22apiVersion: apps/v1
23kind: Deployment
24metadata:
25 name: inventory-deployment
26 labels:
27 app: inventory
28spec:
29 selector:
30 matchLabels:
31 app: inventory
32 template:
33 metadata:
34 labels:
35 app: inventory
36 spec:
37 containers:
38 - name: inventory-container
39 image: inventory:1.0-SNAPSHOT
40 ports:
41 - containerPort: 9080
42---
43apiVersion: v1
44kind: Service
45metadata:
46 name: system-service
47spec:
48 type: NodePort
49 selector:
50 app: system
51 ports:
52 - protocol: TCP
53 port: 9080
54 targetPort: 9080
55 nodePort: 31000
56---
57apiVersion: v1
58kind: Service
59metadata:
60 name: inventory-service
61spec:
62 type: NodePort
63 selector:
64 app: inventory
65 ports:
66 - protocol: TCP
67 port: 9080
68 targetPort: 9080
69 nodePort: 32000This file defines four Kubernetes resources. It defines two deployments and two services. A Kubernetes deployment is a resource responsible for controlling the creation and management of pods. A service exposes your deployment so that you can make requests to your containers. Three key items to look at when creating the deployments are the label, image, and containerPort fields. The label is a way for a Kubernetes service to reference specific deployments. The image is the name and tag of the docker image that you want to use for this container. Finally, the containerPort is the port that your container exposes for purposes of accessing your application. For the services, the key point to understand is that they expose your deployments. The binding between deployments and services is specified by the use of labels — in this case the app label. You will also notice the service has a type of NodePort. This means you can access these services from outside of your cluster via a specific port. In this case, the ports will be 31000 and 32000, but it can also be randomized if the nodePort field is not used.
Run the following commands to deploy the resources as defined in kubernetes.yaml:
kubectl apply -f kubernetes.yamlWhen the apps are deployed, run the following command to check the status of your pods:
kubectl get podsYou’ll see an output similar to the following if all the pods are healthy and running:
NAME READY STATUS RESTARTS AGE
system-deployment-6bd97d9bf6-4ccds 1/1 Running 0 15s
inventory-deployment-645767664f-nbtd9 1/1 Running 0 15sYou can also inspect individual pods in more detail by running the following command:
kubectl describe podsYou can also issue the kubectl get and kubectl describe commands on other Kubernetes resources, so feel free to inspect all other resources.
Next you will make requests to your services.
WINDOWS
MAC
LINUX
The default host name for Docker Desktop is localhost.
The default host name for minikube is 192.168.99.100. Otherwise it can be found using the minikube ip command.
Then curl or visit the following URLs to access your microservices, substituting the appropriate host name:
http://[hostname]:31000/system/properties
http://[hostname]:32000/inventory/systems/system-service
The first URL returns system properties and the name of the pod in an HTTP header called X-Pod-Name. To view the header, you may use the -I option in the curl when making a request to http://[hostname]:31000/system/properties. The second URL adds properties from system-service to the inventory. Kubernetes Service. Visiting http://[hostname]:32000/inventory/systems/[kube-service] in general adds to the inventory depending on whether kube-service is a valid Kubernetes Service that can be accessed.
To use load balancing, you need to scale your deployments. When you scale a deployment, you replicate its pods, creating more running instances of your applications. Scaling is one of the primary advantages of Kubernetes because replicating your application allows it to accommodate more traffic, and then descale your deployments to free up resources when the traffic decreases.
As an example, scale the system Deployment to three pods by running the following command:
kubectl scale deployment/system-deployment --replicas=3Use the following command to verify that two new pods have been created.
kubectl get podsNAME READY STATUS RESTARTS AGE
system-deployment-6bd97d9bf6-4ccds 1/1 Running 0 1m
system-deployment-6bd97d9bf6-jf9rs 1/1 Running 0 25s
system-deployment-6bd97d9bf6-x4zth 1/1 Running 0 25s
inventory-deployment-645767664f-nbtd9 1/1 Running 0 1mWait for your two new pods to be in the ready state, then curl -I or visit the http://[hostname]:31000/system/properties URL. You’ll notice that the X-Pod-Name header will have a different value when you call it multiple times. This is because there are now three pods running all serving the system application. Similarly, to descale your deployments you can use the same scale command with fewer replicas.
When you’re building your application, you may find that you want to quickly test a change. To do that, you can rebuild your docker images then delete and re-create your Kubernetes resources. Note that there will only be one system pod after you redeploy since you’re deleting all of the existing pods.
mvn clean package
kubectl delete -f kubernetes.yaml
kubectl apply -f kubernetes.yamlThis is not how you would want to update your applications when running in production, but in a development environment this is fine. If you want to deploy an updated image to a production cluster, you can update the container in your deployment with a new image. Then, Kubernetes will automate the creation of a new container and decommissioning of the old one once the new container is ready.
pom.xml
1<?xml version="1.0" encoding="UTF-8"?>
2<project xmlns="http://maven.apache.org/POM/4.0.0"
3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5
6 <modelVersion>4.0.0</modelVersion>
7
8 <parent>
9 <groupId>net.wasdev.wlp.maven.parent</groupId>
10 <artifactId>liberty-maven-app-parent</artifactId>
11 <version>RELEASE</version>
12 </parent>
13
14 <groupId>io.openliberty.guides</groupId>
15 <artifactId>guide-kubernetes-intro</artifactId>
16 <version>1.0-SNAPSHOT</version>
17 <packaging>pom</packaging>
18
19 <properties>
20 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
21 <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
22 <maven.compiler.source>1.8</maven.compiler.source>
23 <maven.compiler.target>1.8</maven.compiler.target>
24 <!-- Plugins -->
25 <version.maven-war-plugin>2.6</version.maven-war-plugin>
26 <version.exec-maven-plugin>1.6.0</version.exec-maven-plugin>
27 <version.maven-surefire-plugin>3.0.0-M1</version.maven-surefire-plugin>
28 <version.maven-failsafe-plugin>3.0.0-M1</version.maven-failsafe-plugin>
29 <!-- OpenLiberty runtime -->
30 <version.openliberty-runtime>RELEASE</version.openliberty-runtime>
31 <http.port>9080</http.port>
32 <https.port>9443</https.port>
33 <!-- Default test properties -->
34 <!-- tag::localhost[] -->
35 <cluster.ip>localhost</cluster.ip>
36 <!-- end::localhost[] -->
37 <!-- tag::system-service[] -->
38 <system.kube.service>system-service</system.kube.service>
39 <!-- end::system-service[] -->
40 <!-- tag::system-node-port[] -->
41 <system.node.port>31000</system.node.port>
42 <!-- end::system-node-port[] -->
43 <!-- tag::inventory-node-port[] -->
44 <inventory.node.port>32000</inventory.node.port>
45 <!-- end::inventory-node-port[] -->
46 </properties>
47
48 <dependencyManagement>
49 <dependencies>
50 <dependency>
51 <groupId>io.openliberty.features</groupId>
52 <artifactId>features-bom</artifactId>
53 <version>RELEASE</version>
54 <type>pom</type>
55 <scope>import</scope>
56 </dependency>
57 <dependency>
58 <groupId>org.eclipse.microprofile.rest.client</groupId>
59 <artifactId>microprofile-rest-client-api</artifactId>
60 <version>1.0.1</version>
61 <scope>provided</scope>
62 </dependency>
63 <dependency>
64 <groupId>junit</groupId>
65 <artifactId>junit</artifactId>
66 <version>4.12</version>
67 <scope>test</scope>
68 </dependency>
69 <dependency>
70 <groupId>org.glassfish</groupId>
71 <artifactId>javax.json</artifactId>
72 <version>1.0.4</version>
73 <scope>test</scope>
74 </dependency>
75 <dependency>
76 <groupId>org.apache.cxf</groupId>
77 <artifactId>cxf-rt-rs-extension-providers</artifactId>
78 <version>3.2.6</version>
79 <scope>test</scope>
80 </dependency>
81 <dependency>
82 <groupId>org.apache.cxf</groupId>
83 <artifactId>cxf-rt-rs-client</artifactId>
84 <version>3.2.6</version>
85 <scope>test</scope>
86 </dependency>
87 <dependency>
88 <groupId>org.apache.commons</groupId>
89 <artifactId>commons-lang3</artifactId>
90 <version>3.0</version>
91 <scope>compile</scope>
92 </dependency>
93 <!-- Support for JDK 9 and above -->
94 <dependency>
95 <groupId>javax.xml.bind</groupId>
96 <artifactId>jaxb-api</artifactId>
97 <version>2.3.1</version>
98 </dependency>
99 </dependencies>
100 </dependencyManagement>
101
102 <profiles>
103 <profile>
104 <id>windowsExtension</id>
105 <activation>
106 <os><family>Windows</family></os>
107 </activation>
108 <properties>
109 <kubectl.extension>.cmd</kubectl.extension>
110 </properties>
111 </profile>
112 <profile>
113 <id>nonWindowsExtension</id>
114 <activation>
115 <os><family>!Windows</family></os>
116 </activation>
117 <properties>
118 <kubectl.extension></kubectl.extension>
119 </properties>
120 </profile>
121 </profiles>
122
123 <build>
124 <pluginManagement>
125 <plugins>
126 <plugin>
127 <groupId>org.apache.maven.plugins</groupId>
128 <artifactId>maven-war-plugin</artifactId>
129 <version>${version.maven-war-plugin}</version>
130 <configuration>
131 <failOnMissingWebXml>false</failOnMissingWebXml>
132 <packagingExcludes>pom.xml</packagingExcludes>
133 </configuration>
134 </plugin>
135 <plugin>
136 <groupId>net.wasdev.wlp.maven.plugins</groupId>
137 <artifactId>liberty-maven-plugin</artifactId>
138 <configuration>
139 <assemblyArtifact>
140 <groupId>io.openliberty</groupId>
141 <artifactId>openliberty-runtime</artifactId>
142 <version>RELEASE</version>
143 <type>zip</type>
144 </assemblyArtifact>
145 </configuration>
146 </plugin>
147 <!-- Plugin to run unit tests -->
148 <plugin>
149 <groupId>org.apache.maven.plugins</groupId>
150 <artifactId>maven-surefire-plugin</artifactId>
151 <version>${version.maven-surefire-plugin}</version>
152 <executions>
153 <execution>
154 <phase>test</phase>
155 <id>default-test</id>
156 <configuration>
157 <excludes>
158 <exclude>**/it/**</exclude>
159 </excludes>
160 <reportsDirectory>
161 ${project.build.directory}/test-reports/unit
162 </reportsDirectory>
163 </configuration>
164 </execution>
165 </executions>
166 </plugin>
167 <!-- Plugin to run functional tests -->
168 <plugin>
169 <groupId>org.apache.maven.plugins</groupId>
170 <artifactId>maven-failsafe-plugin</artifactId>
171 <version>${version.maven-failsafe-plugin}</version>
172 <executions>
173 <execution>
174 <phase>integration-test</phase>
175 <id>integration-test</id>
176 <goals>
177 <goal>integration-test</goal>
178 </goals>
179 <configuration>
180 <includes>
181 <include>**/it/**</include>
182 </includes>
183 <systemPropertyVariables>
184 <cluster.ip>${cluster.ip}</cluster.ip>
185 <system.ingress.path>
186 ${system.ingress.path}
187 </system.ingress.path>
188 <system.node.port>
189 ${system.node.port}
190 </system.node.port>
191 <system.kube.service>
192 ${system.kube.service}
193 </system.kube.service>
194 <inventory.ingress.path>
195 ${inventory.ingress.path}
196 </inventory.ingress.path>
197 <inventory.node.port>${inventory.node.port}</inventory.node.port>
198 </systemPropertyVariables>
199 </configuration>
200 </execution>
201 <execution>
202 <id>verify-results</id>
203 <goals>
204 <goal>verify</goal>
205 </goals>
206 </execution>
207 </executions>
208 <configuration>
209 <summaryFile>
210 ${project.build.directory}/test-reports/it/failsafe-summary.xml
211 </summaryFile>
212 <reportsDirectory>
213 ${project.build.directory}/test-reports/it
214 </reportsDirectory>
215 </configuration>
216 </plugin>
217 </plugins>
218 </pluginManagement>
219 </build>
220
221 <modules>
222 <module>system</module>
223 <module>inventory</module>
224 </modules>
225
226</project>A few tests are included for you to test the basic functionality of the microservices. If a test failure occurs, then you might have introduced a bug into the code. To run the tests, wait for all pods to be in the ready state before proceeding further. The default properties defined in the pom.xml are:
| Property | Description |
|---|---|
| IP or host name for your cluster, |
| Name of the Kubernetes Service wrapping the |
| The NodePort of the Kubernetes Service |
| The NodePort of the Kubernetes Service |
Navigate back to the start directory.
WINDOWS
MAC
LINUX
Run the integration tests against a cluster running with a host name of localhost:
mvn verifyRun the integration tests with the IP address for Minikube:
mvn verify -Dcluster.ip=`minikube ip`The dockerfile.skip parameter is set to true in order to skip building a new Docker image.
If the tests pass, you’ll see an output similar to the following for each service respectively:
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running it.io.openliberty.guides.system.SystemEndpointTest
Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.567 s - in it.io.openliberty.guides.system.SystemEndpointTest
Results:
Tests run: 2, Failures: 0, Errors: 0, Skipped: 0-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running it.io.openliberty.guides.inventory.InventoryEndpointTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.893 s - in it.io.openliberty.guides.inventory.InventoryEndpointTest
Results:
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0When you no longer need your deployed microservices, you can delete all Kubernetes resources by running the kubectl delete command:
kubectl delete -f kubernetes.yamlWINDOWS
MAC
LINUX
Nothing more needs to be done for Docker Desktop.
Perform the following steps to return your environment to a clean state.
Point the Docker daemon back to your local machine:
eval $(minikube docker-env -u)Stop your Minikube cluster:
minikube stopDelete your cluster:
minikube deleteYou have just deployed two microservices running in Open Liberty to Kubernetes. You then scaled a microservice and ran integration tests against miroservices that are running in a Kubernetes cluster.
Deploying microservices to Kubernetes by Open Liberty is licensed under CC BY-ND 4.0
Prerequisites:
Thank you for your feedback!
Raise an issue to share feedback
Create a pull request to contribute to this guide
Ask a question on Stack Overflow
