{"id":282,"date":"2023-05-01T07:31:07","date_gmt":"2023-05-01T07:31:07","guid":{"rendered":"https:\/\/keyshell.net\/blog\/?p=282"},"modified":"2023-05-01T07:31:07","modified_gmt":"2023-05-01T07:31:07","slug":"deploying-a-spring-boot-microservice-using-helm-charts","status":"publish","type":"post","link":"https:\/\/keyshell.net\/blog\/2023\/05\/01\/deploying-a-spring-boot-microservice-using-helm-charts\/","title":{"rendered":"Deploying a Spring Boot microservice using Helm charts"},"content":{"rendered":"

In this blog,we explain the steps to deploy a Spring Boot microservice using Helm Charts.First we will build a docker image using a Docker file.This docker image is pushed to a repository.Then we will use Helm Charts to deploy our application to a Kubernetes cluster.An Nginx Ingress Controller is configured to expose our application to the outside world and manage traffic flow in a more flexible and scalable way.<\/p>\n

Java Spring Boot is an open-source tool that makes it easier to use Java-based frameworks to create microservices and web apps.<\/p>\n

Managing kubernetes cluster consists of checking cluster, pods, nodes, application deployment, replicas, load-balancer etc is a hectic task.So inorder to manage a Kubernetes cluster more efficiently and easily, one can use a package manager like Helm. Helm provides several advantages for managing Kubernetes applications,including:<\/p>\n

    \n
  1. Simplified Deployment:<\/strong> With Helm, you can easily package and deploy complex applications with a single command, reducing the need for manual configuration and deployment steps.<\/span><\/li>\n
  2. Version Control:<\/strong> Helm allows you to manage and track the version history of your Kubernetes applications, making it easier to roll back to previous versions in case of issues or bugs.<\/li>\n
  3. Modular Architecture:<\/strong> Helm uses a modular architecture that allows you to break down your applications into smaller, reusable components that can be easily deployed and managed.<\/li>\n<\/ol>\n

    Overall, Helm provides a powerful and flexible solution for managing Kubernetes applications, making it easier to deploy, manage, and scale complex applications on Kubernetes clusters.<\/span><\/p>\n

    Prerequisites:<\/i><\/b>
    \n<\/i><\/b>Docker Instance : To build the spring boot docker image and push to repository<\/span><\/i><\/p>\n

    Docker Hub Account\/Any other Repository service for Docker Images<\/span><\/i><\/p>\n

    Basic Git Commands<\/span><\/i><\/p>\n

    Kubernetes Cluster: We used AWS\u2019s EKS cluster.Bastion Host configured to manage K8\u2019s.<\/span><\/i><\/p>\n

    First,let’s login to Docker Instance and build a docker image for our sample spring boot application.Clone the Sample Spring Boot Application : <\/span>https:\/\/github.com\/Keyshelltechs\/sample_spring_boot<\/span><\/a><\/p>\n

    DockerFile<\/span><\/i><\/p>\n

    FROM<\/span> maven:3.8.5-openjdk-18-slim <\/span>AS<\/span> build<\/span>\r\n\r\nWORKDIR<\/span> \/usr\/src\/app<\/span>\r\n\r\nCOPY<\/span> . \/usr\/src\/app<\/span>\r\n\r\nRUN<\/span> mvn package<\/span>\r\n\r\nFROM<\/span> openjdk:18-jdk-slim<\/span>\r\n\r\nEXPOSE<\/span> 8080<\/span>\r\n\r\nARG<\/span> JAR_FILE=spring-boot-ecs.jar<\/span>\r\n\r\nWORKDIR<\/span> \/opt\/app<\/span>\r\n\r\nCOPY<\/span> --from=build \/usr\/src\/app\/target\/${JAR_FILE} \/opt\/app\/<\/span>\r\n\r\nENTRYPOINT<\/span> [<\/span>\"java\"<\/span>,<\/span>\"-jar\"<\/span>,<\/span>\"spring-boot-ecs.jar\"<\/span>]<\/span><\/code> In this Dockerfile we use Multi-Stage build for creating a jar file in the first build and copying that jar file in the second build.<\/span><\/pre>\n
    Let\u2019s login to our Docker Hub Account.<\/span><\/p>\n
    $ docker login<\/em><\/p><\/blockquote>\n
    Now let\u2019s build the docker image using the docker command:<\/span><\/p>\n
    $ <\/span>docker<\/span> build<\/span> -t<\/span> keyshelltechs\/sample_spring_boot:latest<\/span> .<\/span><\/em><\/p><\/blockquote>\n
    Here \u2018keyshelltechs\u2019 is my dockerhub\u2019s username and \u2018sample_spring_boot\u2019 is the repository name and \u2018latest\u2019 is the tag.<\/span><\/p>\n
    Now let\u2019s push this image to our Docker Hub repository using this command:<\/span><\/p>\n
    $ <\/span>docker<\/span> push<\/span> keyshelltechs\/sample_spring_boot:latest<\/span><\/em><\/p><\/blockquote>\n
    Now let\u2019s install Helm in our Bastion Host.I\u2019m using Amazon Linux 2 for my Bastion Host.<\/span><\/p>\n
    $ <\/span>curl<\/span> https:\/\/raw.githubusercontent.com\/helm\/helm\/master\/scripts\/get-helm-3<\/span> > <\/span>get_helm.sh<\/span><\/em><\/p>\n
    $ <\/span>chmod<\/span> 700<\/span> get_helm.sh<\/span><\/em><\/p>\n
    $ <\/span>.\/get_helm.sh<\/span><\/em><\/p><\/blockquote>\n
    You can refer to this link for helm installation : <\/span>https:\/\/docs.aws.amazon.com\/eks\/latest\/userguide\/helm.html<\/span><\/a><\/p>\n
    To check helm version : <\/span>$ helm version<\/b><\/p>\n
     <\/p>\n
    After the helm is installed,let\u2019s install <\/span>Ingress Controller <\/b>using Helm charts.<\/span><\/p>\n
    For that, first we have to add the Helm Repository :<\/span><\/p>\n
    $ <\/span>helm<\/span> repo<\/span> add<\/span> nginx-stable<\/span> https:\/\/helm.nginx.com\/stable<\/span><\/em><\/p><\/blockquote>\n
    Now update the repository for ensuring that you have access to the latest versions of Helm charts and managing the repositories from which you install charts.\u00a0<\/span><\/p>\n
    $ <\/span>helm<\/span> repo<\/span> update<\/span><\/em><\/p><\/blockquote>\n
    Now let\u2019s install the chart from the repository:<\/span><\/p>\n
    $ <\/span>helm<\/span> install<\/span> my-release<\/span> nginx-stable\/nginx-ingress<\/span><\/em><\/p><\/blockquote>\n
    You can refer to this link for Ingress Controller installation :<\/span><\/p>\n
    https:\/\/docs.nginx.com\/nginx-ingress-controller\/installation\/installation-with-helm<\/span><\/a><\/p>\n
    Now let\u2019s check whether this ingress controller is working or not.<\/span>
    \n<\/span>For that, let’s check our K8\u2019s pods and services.<\/span><\/p>\n
    $ <\/span>kubectl<\/span> get<\/span> pods<\/span>
    \n<\/span>$ <\/span>kubectl<\/span> get<\/span> svc<\/span><\/em><\/p><\/blockquote>\n
    We can get the <\/span>External IP<\/b> of our ingress controller from <\/span>$ <\/span>kubectl<\/span> get<\/span> svc<\/span><\/em><\/p>\n
     <\/p>\n
    Now,let\u2019s create the helm chart for our spring boot application.<\/span><\/p>\n
    $ <\/span>helm<\/span> create<\/span> springboot<\/span><\/em><\/p><\/blockquote>\n
    Here \u201cspringboot\u201d is custom name given by us.This will create basic Helm Chart skeleton with the name springboot.<\/span><\/p>\n
    Run the following command to see the tree structure of our Springboot Helm Chart:<\/span><\/p>\n
    $ <\/span>tree<\/span> springboot<\/span><\/em><\/p><\/blockquote>\n
    \"\"<\/p>\n
    Of these files,we have to edit <\/span>Chart.yaml<\/b>,<\/span>values.yaml<\/b> & <\/span>deployment.yaml<\/b><\/p>\n
    Chart.yaml<\/b><\/span><\/p>\n
    apiVersion: v2<\/span>\r\n\r\nname: springboot<\/span>\r\n\r\ndescription: A Helm chart for Kubernetes<\/span>\r\n\r\ntype: application<\/span>\r\n\r\nversion: 0.1.0<\/span>\r\n\r\nappVersion: \"latest\"<\/span><\/code><\/pre>\n
    Here keep in mind that <\/span>\u201cappVersion\u201d <\/b>should be the tag which you are using for the Docker image.<\/span><\/p>\n
    values.yaml<\/b><\/span><\/p>\n
    In a Helm chart, values.yaml is a file that allows users to customize the deployment of the chart. It contains a set of key-value pairs that define the configuration settings for the chart. These values can be used to override the default configuration settings defined in the chart’s templates.<\/span><\/p>\n
    replicaCount<\/span>: <\/span>3<\/span>\r\n\r\nimage<\/span>:<\/span>\r\n\r\n\u00a0<\/span>repository<\/span>: <\/span>keyshelltechs\/sample_spring_boot<\/span>\r\n\r\n\u00a0<\/span>pullPolicy<\/span>: <\/span>Always<\/span>\r\n\r\nimagePullSecrets<\/span>: []<\/span>\r\n\r\nnameOverride<\/span>: <\/span>\"\"<\/span>\r\n\r\nfullnameOverride<\/span>: <\/span>\"springboot\"<\/span>\r\n\r\nserviceAccount<\/span>:\u00a0<\/span>\r\n\r\n\u00a0<\/span>create<\/span>: <\/span>true<\/span>\u00a0<\/span>\r\n\r\n\u00a0<\/span>name<\/span>: <\/span>\"springboot\"<\/span>\r\n\r\npodAnnotations<\/span>: {}<\/span>\r\n\r\npodSecurityContext<\/span>: {}<\/span>\r\n\r\nsecurityContext<\/span>: {}<\/span>\r\n\r\nservice<\/span>:<\/span>\r\n\r\n\u00a0<\/span>type<\/span>: <\/span>ClusterIP<\/span>\r\n\r\n\u00a0<\/span>port<\/span>: <\/span>80<\/span>\r\n\r\n\u00a0<\/span>targetPort<\/span>: <\/span>8080<\/span>\r\n\r\ningress<\/span>:<\/span>\r\n\r\n\u00a0<\/span>enabled<\/span>: <\/span>true<\/span>\r\n\r\n\u00a0<\/span>annotations<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>kubernetes.io\/ingress.class<\/span>: <\/span>nginx<\/span>\r\n\r\n\u00a0\u00a0\u00a0<\/span>kubernetes.io\/tls-acme<\/span>: <\/span>\"true\"<\/span>\r\n\r\n\u00a0<\/span>hosts<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0- <\/span>host<\/span>: <\/span>External_IP_of_ingress_controller<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>paths<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0- <\/span>path<\/span>: <\/span>\/<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>pathType<\/span>: <\/span>Prefix<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>backend<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>serviceName<\/span>: <\/span>springboot-starterkit-svc<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>servicePort<\/span>: <\/span>80<\/span>\r\n\r\n\u00a0<\/span>tls<\/span>: []<\/span>\r\n\r\nresources<\/span>: {}<\/span>\r\n\r\nautoscaling<\/span>:<\/span>\r\n\r\n\u00a0<\/span>enabled<\/span>: <\/span>false<\/span>\r\n\r\n\u00a0<\/span>minReplicas<\/span>: <\/span>1<\/span>\r\n\r\n\u00a0<\/span>maxReplicas<\/span>: <\/span>100<\/span>\r\n\r\n\u00a0<\/span>targetCPUUtilizationPercentage<\/span>: <\/span>80<\/span>\r\n\r\nnodeSelector<\/span>: {}<\/span>\r\n\r\ntolerations<\/span>: []<\/span>\r\n\r\naffinity<\/span>: {}<\/span><\/code><\/pre>\n
    Image\u2019s repository value as\u00a0 <\/span>keyshelltechs\/sample_spring_boot <\/b>(without tag) which is the name of the image we have pushed earlier.Tag for this image is mentioned in <\/span>Chart.yaml<\/b> file.<\/span><\/p>\n
    Ingress is enabled here and we should replace <\/span>External_IP_of_ingress_controller <\/b>with <\/span>External IP<\/b> of our ingress controller which we have obtained in the earlier step.<\/span><\/p>\n
    deployment.yaml<\/b><\/span><\/p>\n
    In a Helm chart, deployment.yaml is a file that defines the Kubernetes Deployment resource used to manage the deployment of an application.<\/span><\/p>\n
    The deployment.yaml file defines the desired state of the Kubernetes Deployment resource. It specifies the containers and other resources that make up the application.This file can be customized using the values provided in the values.yaml file to enable parameterized deployment.<\/span><\/p>\n
    \u00a0\u00a0\u00a0\u00a0\u00a0<\/span>containers<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0- <\/span>name<\/span>: {{ <\/span>.Chart.Name<\/span> }}<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>securityContext<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0{{- <\/span>toYaml .Values.securityContext | nindent 12<\/span> }}<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>image<\/span>: <\/span>\"{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}\"<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>imagePullPolicy<\/span>: {{ <\/span>.Values.image.pullPolicy<\/span> }}<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>ports<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0- <\/span>name<\/span>: <\/span>http<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>containerPort<\/span>: {{ <\/span>.Values.service.targetPort<\/span> }}<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>protocol<\/span>: <\/span>TCP<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>livenessProbe<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>httpGet<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>path<\/span>: <\/span>\/<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>port<\/span>: <\/span>http<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>readinessProbe<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>httpGet<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>path<\/span>: <\/span>\/<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>port<\/span>: <\/span>http<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span>resources<\/span>:<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0{{- <\/span>toYaml .Values.resources | nindent 12<\/span> }}<\/span><\/code><\/pre>\n
    In this file we have only edited the <\/span>container: <\/b>portion.<\/span><\/p>\n
     <\/p>\n
    Now let\u2019s run the install command.<\/span><\/p>\n
    Make sure you are in the parent directory of our <\/span>\u2018springboot\u2019<\/b> folder to run this command.<\/span><\/p>\n
    $ <\/span>helm<\/span> install<\/span> your-release-name<\/span> springboot<\/span><\/em><\/p><\/blockquote>\n
    Here you can give your custom release name instead of <\/span>\u2018your-release-name\u2019<\/b> and <\/span>\u2018springboot\u2019 <\/b>is our folder which was created during the earlier step.<\/span><\/p>\n
    If everything goes right we can see release notes of the helm deployment.<\/span><\/p>\n
    \"\"<\/p>\n
    Also check all our pods are running by :<\/span><\/p>\n
    $ <\/span>kubectl<\/span> get<\/span> pods<\/span><\/em><\/p><\/blockquote>\n
    We can access our site through this URL.<\/span><\/p>\n
    \"\"<\/p>\n
    You can also refer our repo by :<\/span><\/p>\n
    $ helm repo add keyshell http:\/\/keyshelltechs.github.io\/sample_helm_charts\/charts<\/em>
    \n<\/span><\/p><\/blockquote>\n
    (github link : <\/span>https:\/\/github.com\/Keyshelltechs\/sample_helm_charts<\/span><\/a>)<\/span><\/p>\n
     <\/p>\n
    To fetch the chart use:<\/span><\/p>\n
    $ helm <\/span>fetch<\/span> keyshell\/springboot<\/span><\/em><\/p>\n
     <\/p><\/blockquote>\n
    Thanks for reading. Happy Helming.<\/span><\/p>\n
    If you have any queries contact us at \ud83d\udcf2 +91-81295 71359 or email us at support@keyshell.net<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
    In this blog,we explain the steps to deploy a Spring Boot microservice using Helm Charts.First we will build a docker image using a Docker file.This docker image is pushed to a repository.Then we will use Helm Charts to deploy our application to a Kubernetes cluster.An Nginx Ingress Controller is configured to expose our application to […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"pagelayer_contact_templates":[],"_pagelayer_content":"","footnotes":""},"categories":[1],"tags":[],"class_list":["post-282","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/posts\/282","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/comments?post=282"}],"version-history":[{"count":33,"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/posts\/282\/revisions"}],"predecessor-version":[{"id":319,"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/posts\/282\/revisions\/319"}],"wp:attachment":[{"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/media?parent=282"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/categories?post=282"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/keyshell.net\/blog\/wp-json\/wp\/v2\/tags?post=282"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}