Skip to main content

Adding/ Editing Health checks to deployments in OpenShift

What are health checks in OpenShift

Health checks are required to ensure that application is resilient so application can be restarted without manual action. Such health checks can be configured using probes in openshift. Kubernetes provides two type of probes, readiness probe and liveness probe.

Liveness probe

Liveness probe checks that application is running and handles those situations when there is any issue with application.

Readiness probe

Readiness probe check whether application is ready to handle the traffic.

Another benefit of having these health checks is that you can restart or deploy application with zero downtime when you are having minimum 2 pods running for your application. In this case it will not bring all the pods down.

Supported health check types

You can configure the health check of below type for both of the above probes.

  • HTTP Health Check
  • It will call a web URL and if it returns the HTTP status code between 200 and 399 then it will consider as success otherwise failure.
  • Container Exec
  • Using this option we can execute command inside container and if it return 0 as exit code only then it will be considered as success.
  • TCP Socket
  • Here, it tries to open the socket to container. If it can establish connection then it will consider as success otherwise failure.

Configuring health checks

These health checks can be configured in multiple ways, like using Openshift console UI or using the templates.

Using Openshift console UI

To add or edit the health check you need to login to openshift console and go to your deployment config using the option "Application/Deployments/<deployment_name>".
health checks

In below screen you can provide the readiness probe details.
readiness probe

In below screen you can provide the liveness probe details.
liveness probe

Finally save the changes and then you can see those health check on your deployments under configuration tab.

Using templates

You can directly add or edit the blocks for readiness and liveness probes in templates. Then you can execute those templates to reflect your changes to deployment configurations.
These changes you need to add in your deploymentConfig template in containers section.
Readiness probe
{
   "kind": "DeploymentConfig"
   "spec": {
      "template": {
         "spec": {
            "containers": [
               {
                  "readinessProbe": {
                     "tcpSocket": {
                        "port": 8080
                     },
                     "timeoutSeconds": 1,
                     "periodSeconds": 10,
                     "successThreshold": 1,
                     "failureThreshold": 3
                  },
}

Liveness probe
{
   "kind": "DeploymentConfig"
   "spec": {
      "template": {
         "spec": {
            "containers": [
               {
                  "livenessProbe": {
                     "tcpSocket": {
                        "port": 8080
                     },
                     "timeoutSeconds": 1,
                     "periodSeconds": 10,
                     "successThreshold": 1,
                     "failureThreshold": 3
                  },
}

Comments

Popular Posts

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "property.name" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Asynchronous REST service implementation in Spring boot

In this tutorial we will see how to create an asynchronous REST service endpoint using Spring boot application. Asynchronous service works in a way that it will not block the client request and do the processing in separate thread. When work is complete the response returned to the client so our service will be able to handle more client requests at the same time, compare to synchronous processing model. Let's understand how it is working in synchronous mode. In such server/client application at server side it has a pool of threads which are serving the request. If a request received by a thread then it will be blocked until it send the response back to client. In this case if processing doesn't take much time it will be able to process it quickly and accept other client requests but there could be one situation when all threads are busy and not able to accept the new client requests. To overcome of such problems, asynchronous processing model introduced for REST service

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa. To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only. Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&