Navigate back to the homepage

Connecting a Spring Boot Application to Yugabyte Cloud and Deploying It on Google Kubernetes Engine (GKE)

Gavin Johnson
September 2nd, 2021 · 5 min read

This post was originally published on Yugabyte’s blog.


Spring Boot is one of the most popular frameworks for building cloud native applications. It makes configuring an application easy and offers tons of starters to get you off the ground quickly. Each Spring Boot application is stand-alone and self-contained, which makes them easy to deploy in a distributed fashion – to containers or, even better, on Kubernetes.

Yugabyte Cloud is a perfect match for Spring Boot applications, especially ones made highly available with Kubernetes. Yugabyte Cloud gives you a PostgreSQL-compatible database that is resilient and scalable, just like the applications you run on k8s. You can scale your YugabyteDB cluster out (or in) with just a few clicks. So you can spend less time worrying about running your database and more time focused on building better software. It’s cloud native SQL for cloud native applications. Sign up for Yugabyte Cloud today.

Walkthrough

In this post, we’ll walk you through connecting a Spring Boot application to Yugabyte Cloud and deploying it on Kubernetes via Google Kubernetes Engine (GKE). You can view our walkthrough on connecting a Spring Boot application to Yugabyte Cloud and deploying it on Kubernetes via Amazon Elastic Kubernetes Service (EKS) here and via minikube here. We’ll be using a slightly updated version of the popular Spring Boot PetClinic sample application that has a profile making it compatible with YugabyteDB. The repository for this is at https://github.com/yugabyte/spring-petclinic.

In this walkthrough, you will:

  • Create a free Yugabyte Cloud account and database cluster
  • Download the Spring Boot PetClinic sample application and connect it to Yugabyte Cloud
  • Containerize the Spring Boot PetClinic sample application
  • Deploy the Spring Boot PetClinic sample application image to GKE

Prerequisites

Note: Anything in brackets [ ] needs to be replaced with information from your deployment.

Create a free Yugabyte Cloud account and database cluster

  1. Go to https://cloud.yugabyte.com/signup and sign up for a Yugabyte Cloud account. After you’ve signed up and verified your email address, go to https://cloud.yugabyte.com/login and sign in.

  2. Click the Create a Free Cluster button.

    alt_text

  3. Select Yugabyte Cloud Free and click the Next button.

    alt_text

  4. Select a cloud provider for your cluster, name your cluster, select a region, and click the Next button.

    alt_text

  5. Copy the default admin credentials by clicking the Copy Credentials link. Then check the “I have copied the admin credentials” checkbox and click the Create Cluster button.

    a. You can also set your own admin credentials by selecting the “Add your own credentials” radio button and entering your own credentials.

    alt_text

  6. Wait for your cluster to be provisioned. Click on “Add IP Allow List” in the top section of the Clusters page.

    alt_text

  7. Click the Create New List and Add to Cluster button.

    alt_text

  8. In the Name text box, enter “all-ips”. In the IP Address(es) or Range text box, enter “0.0.0.0/0”. Click the Save button. This will allow traffic from all IP addresses to your cluster.

    a. Allowing all IPs access to your cluster is for development purposes only. When you deploy an application to Production, you will want to specify only the specific IP addresses or ranges that need access to your cluster.

    alt_text

Your cluster is now created in Yugabyte Cloud and is accessible to all IP addresses. Leave this page open, as you’ll be accessing the Cloud Shell later to create an application database and user.

Download the Spring Boot PetClinic sample application and connect it to Yugabyte Cloud

Note: Instructions for how to connect this application to YugabyteDB are in spring-petclinic/src/main/resources/db/yugabytedb/petclinic_db_setup_yugabytedb.md from the repo you clone below.

  1. On your computer from terminal, clone the Spring Boot PetClinic sample application: git clone https://github.com/yugabyte/spring-petclinic.git.

    1$ git clone https://github.com/yugabyte/spring-petclinic.git
    2Cloning into 'spring-petclinic'...
    3remote: Enumerating objects: 8616, done.
    4remote: Counting objects: 100% (18/18), done.
    5remote: Compressing objects: 100% (18/18), done.
    6remote: Total 8616 (delta 1), reused 13 (delta 0), pack-reused 8598
    7Receiving objects: 100% (8616/8616), 7.29 MiB | 19.03 MiB/s, done.
    8Resolving deltas: 100% (3268/3268), done.
  2. cd spring-petclinic.

  3. Copy the contents of spring-petclinic/src/main/resources/db/yugabytedb/user.sql.

  4. In Yugabyte Cloud, click on “Connect”. Click on Connect to your Application.

    alt_text

  5. Save your host address and port (highlighted in the screenshot below) for later. Click the Back link in the Connect to Cluster navigation breadcrumb.

    alt_text

  6. Click the Launch Cloud Shell button.

  7. Leave the default Database Name, Database User Name, and API Type. Click the Confirm button. This will launch the Cloud Shell.

    alt_text

  8. Enter the admin password you copied previously. After you enter the password, you will have a standard YSQL shell (exactly like a PSQL shell in PostgreSQL) that you can interact with from your browser.

    1Password for user admin:
    2ysqlsh (11.2-YB-2.4.2.0-b0)
    3SSL connection (protocol: TLSv1.2, cipher: ECDHE-RSA-AES256-GCM-SHA384, bits: 256, compression: off)
    4Type "help" for help.
    5
    6yugabyte=#
  9. Go to http://localhost:8080. The PetClinic sample application should be available.

    alt_text

The PetClinic sample application is now connected to your Yugabyte Cloud cluster and running locally.

Containerize the Spring Boot PetClinic sample application

  1. Start Docker on your computer and containerize your Spring Boot PetClinic sample application: ./mvnw spring-boot:build-image.

  2. Tag your image: docker tag [image_id] spring-petclinic – you can find your image id by running docker image ls.

  3. Run your image as a container in Docker to make sure it’s working correctly: docker run -d --name=spring-petclinic -p 8080:8080 -e JAVA_OPTS="-Dspring.profiles.active=yugabytedb -Dspring.datasource.url=jdbc:postgresql://[host]:[port]/petclinic?load-balance=true -Dspring.datasource.initialization-mode=never" spring-petclinic.

    a. Go to http://localhost:8080. The PetClinic sample application should be available.

The PetClinic sample application is now connected to your Yugabyte Cloud cluster and running locally on Docker.

Deploy the Spring Boot PetClinic sample application image to Google Kubernetes Engine (GKE)

  1. Go to https://console.cloud.google.com/ and sign up for/sign in to Google Cloud Platform (GCP).

  2. Type “artifact registry” in the search bar and click on “Artifact Registry”.

    alt_text

  3. Click on the Enable button for the Artifact Registry API.

    alt_text

  4. Click Create Repository.

    alt_text

  5. Give your repository a Name, make sure Docker is selected for Format, and choose a Region. Click the Create button.

    alt_text

  1. Click into your new repository and copy its URL.

    alt_text

  2. On your computer from terminal, configure Docker to use gcloud for authentication: gcloud auth configure-docker [region]-docker.pkg.dev.

    1$ gcloud auth configure-docker us-west1-docker.pkg.dev
    2Adding credentials for: us-west1-docker.pkg.dev
    3After update, the following will be written to your Docker config file
    4located at [/Users/gavinjohnson/.docker/config.json]:
    5{
    6"credHelpers": {
    7"us-west1-docker.pkg.dev": "gcloud"
    8}
    9}
    10Do you want to continue (Y/n)? y
    11Docker configuration file updated.
  3. Tag your PetClinic image with your Artifact Registry repo: docker tag spring-petclinic:latest [repo_url]/spring-petclinic:latest.

  4. Push your PetClinic image to your repo in Artifact Registry: docker push [repo_url]/spring-petclinic:latest.

    1$ docker push us-west1-docker.pkg.dev/gavins-sandbox-320519/spring-petclinic/spring-petclinic:latest
    2The push refers to repository [us-west1-docker.pkg.dev/gavins-sandbox-320519/spring-petclinic/spring-petclinic]
    31dc94a70dbaa: Pushed
    40d29ec96785e: Pushed
    5888ed16fa8d4: Pushed
    6...

    If you go to your repo in Artifact Registry, you should see the image you just pushed.

    alt_text

  5. Type “gke” in the search bar and click on “Kubernetes Engine”.

    alt_text

  6. Click on the Enable button for the Kubernetes Engine API.

    alt_text

  7. Click Create.

    alt_text

  8. Click the Configure button under Autopilot.

    alt_text

  9. Enter a Name, select a Region, and click the Create button.

    alt_text

  10. After your cluster has been created, click on Workloads in the left-navigation panel.

    alt_text

  11. Click on Deploy.

    alt_text

  12. Select Existing Container Image and click Select in the Image Path.

    alt_text

  13. Click on Artifact Registry, expand the folders out, select the image under spring-petclinic, and click the Select button.

    alt_text

  14. Click the Add Environment Variable button and enter: a. Key: JAVA_OPTS b. Value: -Dspring.profiles.active=yugabytedb -Dspring.datasource.url=jdbc:postgresql://[host]:[port]/petclinic?load-balance=true -Dspring.datasource.initialization-mode=never

    alt_text

  15. Click the Continue button.

  16. Enter a Name for your application and click the Deploy button (everything else should be auto-filled).

    alt_text

  17. After your workload is deployed, click Expose on the Deployment Details.

    alt_text

  18. Set Port to 80, Target Port to 8080 and Service Type to Load Balancer. Click the Expose button.

    alt_text

  19. After the load balancer is created, the Service Details page displays.

    alt_text

  20. If you click on the External Endpoints link (http://34.105.123.45/), the PetClinic sample application should be available.

    alt_text

The PetClinic sample application is now connected to your Yugabyte Cloud cluster and running on Kubernetes on GKE.

What’s Next?

Give Yugabyte Cloud a try by signing up for a free tier account in a couple of minutes. Got questions? Feel free to ask them in our YugabyteDB community Slack channel.

More articles from thtmnisamnstr

YugabyteDB Open Source Community Spotlight – July 2021

We spotlight members of the community to recognize their contributions to making the Yugabyte community a great place. This month, we're honoring Radek Gruchalski, Managing Director and Software Engineer at Klarrio GmbH. Check out our post to learn more.

July 29th, 2021 · 5 min read

Distributed SQL Fundamentals: Horizontal Scaling

Scaling your SQL database can be difficult. Most traditional, legacy SQL databases are monolithic – they are constrained to a single server, VM, or container ...

July 1st, 2021 · 1 min read
© 2020–2021 thtmnisamnstr
Link to $https://twitter.com/gavinjtechLink to $https://dev.to/thtmnisamnstrLink to $https://github.com/thtmnisamnstrLink to $https://www.linkedin.com/in/gavin-johnson/Link to $https://www.instagram.com/thtmnisamnstr