Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Deploying a Spring Boot App with MySQL on OpenShift

March 27, 2018
Chandra Shekhar Pandey
Related topics:
KubernetesJavaSpring Boot
Related products:
Red Hat OpenShift Container Platform

Share:

    This article shows how to take an existing Spring Boot standalone project that uses MySQL and deploy it on Red Hat OpenShift,  In the process, we'll create docker images which can be deployed to most container/cloud platforms. I'll discuss creating a Dockerfile, pushing the container image to an OpenShift registry, and finally creating running pods with the Spring Boot app deployed.

    To develop and test using OpenShift on my local machine, I used Red Hat Container Development Kit (CDK), which provides a single-node OpenShift cluster running in a Red Hat Enterprise Linux VM, based on minishift. You can run CDK on top of Windows, macOS, or Red Hat Enterprise Linux.   For testing, I used Red Hat Enterprise Linux Workstation release 7.3. It should work on macOS too.

    To create the Spring Boot app I used this article as a guide. I'm using an existing openshift/mysql-56-centos7 docker image to deploy MySQL to  OpenShift.

    You can download the code used in this article from my personal github repo.   In this article, I'll be building container images locally, so you'll need to be able to build the project locally with Maven.  This example exposes a rest service using: com.sample.app.MainController.java.

    In the repository, you'll find a Dockerfile in src/main/docker-files/. The dockerfile_springboot_mysql file creates a docker image, having the Spring Boot application based on java8 docker image as a base . While this is ok for testing, for production deployment you'd want to use images that are based on Red Hat Enterprise Linux.

    Building the application:

    1. Use mvn clean install to build the project.

    2. Copy the generated jar in the target folder to src/main/docker-files. When creating the docker image, the application jar can be found at the same location.

    3. Set the database username, password, and URL in src/main/resources/application.properties.  Note: For OpenShift,  it is recommended to pass these parameters into the container as environment variables.

    Now start the CDK VM to get your local OpenShift cluster running.

    1. Start the CDK VM using minishift start:

    $ minishift start

    2.  Set your local environment for docker and the oc CLI:

    $ eval $(minishift oc-env) 
    $ eval $(minishift docker-env)

    Note: the above eval commands will not work on Windows.  See the CDK documentation for more information.

    3. Login to OpenShift and Docker using the developer account:

    $ oc login
    $ docker login -u developer -p $(oc whoami -t) $(minishift openshift registry)

     

    Now we'll build the container images.

    1. Change the directory location to src/main/docker-files within the project.  Then, execute the following commands to build the container images.   Note:  The period (.) is required at the end of the docker build command to indicate the current directory:

    $ docker build -t springboot_mysql -f ./dockerfile_springboot_mysql .

    Use the following command to view the container images that were created:

    $ docker images

    2.  Add the tag springboot_mysql to the image, and push it to the OpenShift registry:

    $ docker tag springboot_mysql $(minishift openshift registry)/myproject/springboot_mysql
    $ docker push $(minishift openshift registry)/myproject/springboot_mysql

    3. Next, pull the OpenShift MySQL image, and create it as an OpenShift application which will initialize and run it. Refer to the documentation for more information:

    docker pull openshift/mysql-56-centos7
    oc new-app -e MYSQL_USER=root -e MYSQL_PASSWORD=root -e MYSQL_DATABASE=test openshift/mysql-56-centos7

    4. Wait for the pod running MySQL to be ready. You can check the status with oc get pods:

    $ oc get pods
    NAME READY STATUS RESTARTS AGE 
    mysql-56-centos7-1-nvth9 1/1 Running 0 3m

    5. Next, ssh to the mysql pod and create a MySQL root user with full privileges:

    $ oc rsh mysql-56-centos7-1-nvth9
    sh-4.2$ mysql -u root
    CREATE USER 'root'@'%' IDENTIFIED BY 'root';
    Query OK, 0 rows affected (0.00 sec)
    
    GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION;
    Query OK, 0 rows affected (0.00 sec)
    
    FLUSH PRIVILEGES;
    Query OK, 0 rows affected (0.00 sec)
    
    exit

    6. Finally, initialize the Spring Boot app using imagestream springboot_mysql:

    $ oc get svc
    NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
    mysql-56-centos7 172.30.145.88 none 3306/TCP 8m
    
    $ oc new-app -e spring_datasource_url=jdbc:mysql://172.30.145.88:3306/test springboot_mysql
    $ oc get pods
    NAME READY STATUS RESTARTS AGE
    mysql-56-centos7-1-nvth9 1/1 Running 0 12m
    springbootmysql-1-5ngv4 1/1 Running 0 9m

    7. Check the pod logs:

    oc logs -f springbootmysql-1-5ngv4

    8. Next, expose the service as route:

    $ oc get svc
    NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
    mysql-56-centos7 172.30.242.225 none 3306/TCP 14m
    springbootmysql 172.30.207.116 none 8080/TCP 1m
    
    $ oc expose svc springbootmysql
    route "springbootmysql" exposed
    
    $ oc get route
    NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
    springbootmysql springbootmysql-myproject.192.168.42.182.nip.io springbootmysql 8080-tcp None

    9. Test the application using curl. You should see a list of all entries in the database table:

    $ curl -v http://springbootmysql-myproject.192.168.42.182.nip.io/demo/all

    10. Next, use curl to create an entry in the db:

    $ curl http://springbootmysql-myproject.192.168.42.182.nip.io/demo/add?name=SpringBootMysqlTest
    Saved

    11. View the updated list of entries in the database:

    $ curl http://springbootmysql-myproject.192.168.42.182.nip.io/demo/all
    
    [{"name":"UBUNTU 17.10 LTS","lastaudit":1502409600000,"id":1},{"name":"RHEL 7","lastaudit":1500595200000,"id":2},{"name":"Solaris 11","lastaudit":1502582400000,"id":3},{"name":"SpringBootTest","lastaudit":1519603200000,"id":4},{"name":"SpringBootMysqlTest","lastaudit":1519603200000,"id":5}

    That's it!

    I hope this article is helpful to you for migrating an existing spring-boot application to OpenShift. Just a note, in production environments, one should use Red Hat Supportable Images. This document is intended for development purposes only. It should assist you in creating spring-boot applications that run in containers; and in how to set up MySQL connectivity for spring-boot in OpenShift.

    Last updated: January 29, 2019

    Recent Posts

    • AI meets containers: My first step into Podman AI Lab

    • Live migrating VMs with OpenShift Virtualization

    • Storage considerations for OpenShift Virtualization

    • Upgrade from OpenShift Service Mesh 2.6 to 3.0 with Kiali

    • EE Builder with Ansible Automation Platform on OpenShift

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit
    © 2025 Red Hat

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue