Deploy a Java Springboot microservice application on Google Cloud.

This tutorial is an attempt to run Ganesh Radhakrishnan (@ganrad) Spring Purchase-order application that was designed to run off Azure, in a Google Cloud Environment.

As @ganrad has done, we will equally attempt to leverage GCP features to simplify this deployment.

Our goal here is to:

1. Define a Build Pipeline in Google Cloud Build. Execute the build pipeline to create Springboot Java Microservice Application jar (po-service 1.0) and push it to App Engine. This task focuses on the Continuous Integration aspect of the DevOps process.
2. Leverage on Cloud Sql as a replacement of the mysql service container.
3. Leverage on Secret Manager to manage application secrets.

This Springboot application demonstrates how to build and deploy a Purchase Order microservice (po-service) as an application on GCP App Engine Service on GCP. The deployed microservice supports all CRUD operations on purchase orders.

Prerequisites:

1. Create a project in the Google Cloud Platform Console.
2. Enable billing for your project.
3. Install the Google Cloud SDK.
4. Install Maven
5. Create a GitHub account

We have forked this project from https://github.com/ganrad/k8s-springboot-data-rest.git

Adjustments

1. Pom.xml We need to update the pom.xml file to add spring-cloud-gcp-starter, spring-cloud-gcp-starter-sql-mysql and spring-cloud-gcp-starter-secretmanager

   k8s-springboot-data-rest/pom.xml

   Lines 65 to 76 in 4e5869b

   	<dependency>
   	<groupId>org.springframework.cloud</groupId>
   	<artifactId>spring-cloud-gcp-starter</artifactId>
   	</dependency>
   	<dependency>
   	<groupId>org.springframework.cloud</groupId>
   	<artifactId>spring-cloud-gcp-starter-sql-mysql</artifactId>
   	</dependency>
   	<dependency>
   	<groupId>org.springframework.cloud</groupId>
   	<artifactId>spring-cloud-gcp-starter-secretmanager</artifactId>
   	</dependency>

   We will also add the App engine plugin.

   k8s-springboot-data-rest/pom.xml

   Lines 89 to 97 in 4e5869b

   	<plugin>
   	<groupId>com.google.cloud.tools</groupId>
   	<artifactId>appengine-maven-plugin</artifactId>
   	<version>2.2.0</version>
   	<configuration>
   	<deploy.projectId>gcp-migration-project-278408</deploy.projectId>
   	<deploy.version>1</deploy.version>
   	</configuration>
   	</plugin>

2. application.properties We update to include Cloud Sql configs

   k8s-springboot-data-rest/src/main/resources/application.properties

   Lines 3 to 12 in ad0a94a

   	spring.cloud.appId=gcp-migration-project
   	spring.cloud.gcp.sql.instance-connection-name=${sm://projects/281551201984/secrets/spring_cloud_gcp_sql_instance_connection_name}
   	spring.cloud.gcp.sql.database-name=${sm://projects/281551201984/secrets/spring_cloud_gcp_sql_database_name}
   	spring.datasource.username=${sm://projects/281551201984/secrets/spring_datasource_username}
   	spring.datasource.password=${sm://projects/281551201984/secrets/spring_datasource_password}
   	spring.jpa.show-sql=true
   	spring.datasource.initialization-mode=always
   	spring.datasource.hikari.maximum-pool-size=1
   	management.contextPath=/_ah
   	spring.profiles.active=mysql

3. src/main/java/ocp/s2i/springboot/rest/config/PropertiesConfiguration.java We'll comment out the @Configuration properties

   k8s-springboot-data-rest/src/main/java/ocp/s2i/springboot/rest/config/PropertiesConfiguration.java

   Lines 12 to 15 in ad0a94a

   	//@Configuration
   	//@PropertySource("file:/etc/vol-secrets/username.properties")
   	//@PropertySource("file:/etc/vol-secrets/password.properties")
   	//@PropertySource("file:/etc/config/mysqldb.properties")

Additional Files

1. src/main/appengine/app.yaml This is a deployment config file for App engine.

       env: flex
       runtime: java
       runtime_config:
         jdk: openjdk8
       
       resources:
         cpu: 1
         memory_gb: 1
         disk_size_gb: 10
         volumes:
           - name: ramdisk1
             volume_type: tmpfs
             size_gb: 0.5
       automatic_scaling:
         min_num_instances: 1
         max_num_instances: 3
       
       handlers:
         - url: /.*
           script: this field is required, but ignored
   

2. cloudbuild.yaml This is a cloud build config file for executing the build pipeline.

   steps:
        - name: maven:3-jdk-8
          entrypoint: mvn
          args: ["test"]
        - name: maven:3-jdk-8
          entrypoint: mvn
          args: ["package", "-Dmaven.test.skip=true","appengine:deploy"]
     #  - name: gcr.io/cloud-builders/docker
     #    args: ["build", "-t", "gcr.io/$PROJECT_ID/k8s-springboot-data-rest", "--build-arg=JAR_FILE=target/po-rest-service-1.0.jar", "."]
     #images: ["gcr.io/$PROJECT_ID/k8s-springboot-data-rest"]
   

###How To

1. Initialize the Cloud SDK, create an App Engine application, and authorize the Cloud SDK to use GCP APIs in your local environment:

   gcloud init  
   gcloud app create  
   gcloud auth application-default login
   

Set up Cloud SQL

1. Enable the Cloud SQL API.

2. Create a Cloud SQL (MySQL) instance and set the root user password following these instructions.

   gcloud sql instances create test-instance --tier=db-n1-standard-1 --region=us-central1
   

3. Set the password for the root@% MySQL user

   gcloud sql users set-password root --host=% --instance test-instance --password [PASSWORD]
   

   Make sure you replace [PASSWORD] with your own password

4. Setup orders database.

   gcloud sql databases create orders --instance=test-instance
   

5. Get the connectionName of the instance in the format project-id:zone-id:instance-id:

   gcloud sql instances describe test-instance | grep connectionName
   

   Now you can test out your Cloud Sql Database and see if you are able to use this database.

6. Update your application-mysql.properties file by replacing the instance-connection-name, database-name, username and password.

   Note: The values you will find when you first open this file have been designed for a secret manager connection which I will discuss about shortly

Set up Secret Manager

1. Enable the Secret Manager API

   You will also need to grant the application access

   • Go to IAM & Admin page
   • Click the Project selector drop-down list at the top of the page.
   • On the Select from dialog that appears, select the organization for which you want to enable Secret Manager.
   • On the IAM page, next to the app engine service account, click Edit.
   • On the Edit permissions panel that appears, add the necessary roles.
   • Click Add another role. Select Secret Manager Admin.
   • Click Save

2. Create new secrets for our datasource configuration file.

   echo -n “gcp-migration-project-278408:us-central1:test-instance” | gcloud secrets create spring_cloud_gcp_sql_instance_connection_name — replication-policy=”automatic” — data-file=-  
   
   echo -n “orders” | gcloud secrets create spring_cloud_gcp_sql_database_name — replication-policy=”automatic” — data-file=-  
   
   echo -n “root” | gcloud secrets create spring_datasource_username — replication-policy=”automatic” — data-file=-  
   
   echo -n “test123” | gcloud secrets create spring_datasource_password — replication-policy=”automatic” — data-file=-
   

   Note: Remember to use your own credentials here for spring_cloud_gcp_sql_instance_connection_name and spring_datasource_password

   Confirm your secrets have been created by running gcloud secrets list which should return a list of secrets.

   

3. Replace the values in the application-mysql.properties file with the secrets url. For this step, you will need the fully-qualified name of the secret as defined on GCP.

   gcloud secrets describe spring_cloud_gcp_sql_instance_connection_name | grep name
   
   gcloud secrets describe spring_cloud_gcp_sql_database_name | grep name
   
   gcloud secrets describe spring_datasource_username | grep name
   
   gcloud secrets describe spring_datasource_password | grep name
   

   You will now use this names to create a secret manager url. The url will use the format ${sm://FULLY-QUALIFIED-NAME} where FULLY-QUALIFIED-NAME is as retrieved above.

4. Update src/main/resources/application-mysql.properties:

   #CLOUD-SQL-CONFIGURATIONS  
   spring.cloud.appId=gcp-migration-project-278408  
   spring.cloud.gcp.sql.instance-connection-name=${sm://projects/.../secrets/spring_cloud_gcp_sql_instance_connection_name}  
   spring.cloud.gcp.sql.database-name=${sm://projects/.../secrets/spring_cloud_gcp_sql_database_name}  
   ##SQL DB USERNAME/PASSWORD  
   spring.datasource.username=${sm://projects/.../secrets/spring_datasource_username}  
   spring.datasource.password=${sm://projects/.../secrets/spring_datasource_password}
   

Set up GitHub repository with source files

1. Create a GitHub account if you don’t have one already.

2. Enable the Cloud Build API in the target Cloud project.

3. Install the Google Cloud Build App on Github. You can follow this instructions here.

   I can recommend forking this repository, to make your integration easier, or you can create your own fresh repo and push your source files to initialize your repo. Either way, make sure you select your new repo as the repository you are connecting to, otherwise this build will not work.

   

4. In the Google Cloud Console, open the Cloud Build Build triggers page.

   Make sure to delete all triggers created, that may be related to this project before moving to the next step. We are doing this to make sure that no other builds are running other than the single build we have configured.

5. Select your Google Cloud project and click Open.

6. Click Create Trigger.

7. Fill out the options

   • Required. In the Name field, enter a name
   • Optional. In the Description field, enter a brief description of how the trigger will work
   • Under Event, select Push to a branch
   • In the Source drop-down list, select kioie/k8s-springboot-data-rest repository

   Note: If this repository does not appear, click the Connect New Repository button and connect your repo on GitHub, then return to step5.

   • Under Branch, enter ^master$
   • Under Build Configuration select Cloud Build configuration file (YAML or JSON)
     For the Cloud Build configuration file location enter cloudbuild.yaml
     Note: Do not add an extra /
   • Click Create

Under your active triggers, you should now be able to see your newly created trigger.

Set up App Engine

1. The pom.xml file already contains configuration for projectId and version. Change this to reflect the current project ID.

   <deploy.projectId>gcp-migration-project-278408</deploy.projectId>

2. Enable App Engine Admin API

3. Enable App Engine Flexible API

4. Give more permission to the cloud build service account

   Grant cloudbuild service account, admin access to Secret Manager, App Engine and Cloud Sql.

   • Go to IAM & Admin page

   • Click the Project selector drop-down list at the top of the page and select the current project organization.

   • On the IAM page, next to the cloud build service account, (not to be confused with the cloud build service agent )click Edit (or the pencil button).

   • On the Edit permissions panel that appears, add the necessary roles.

   • Click Add another role and add these three roles:
     — App Engine Admin
     — Cloud SQL Admin
     — Secret Manager Admin

   • Click Save.

   The final permission list should look something like this

   

   The final step that triggers a cloud build will require pushing your updated code-base to GitHub.

Push to GitHub and trigger a build

1. Add your remote GitHub fork repo as your upstream repo

   git remote add upstream [https://github.com/<YOUR_ACCOUNT_NAME>/k8s-springboot-data-rest](https://github.com/YOUR_ACCOUNT_NAME/k8s-springboot-data-rest)  
   git remote -vv
   

2. Commit your changes

   git add .  
   git commit
   

3. Push upstream

   git push upstream master
   

4. This should automatically trigger your build on GCP cloud build. You can check the status of your build using the below command

   gcloud builds list
   

   

   A successful build!

5. You can fetch the url of the app with the command

   gcloud app browse
   

6. Now test out your endpoints

   curl [https://gcp-migration-project-278408.uc.r.appspot.com/orders](https://gcp-migration-project-278408.uc.r.appspot.com/orders)  
   
   curl [https://gcp-migration-project-278408.uc.r.appspot.com/orders/1](https://gcp-migration-project-278408.uc.r.appspot.com/orders/1)  
   
   curl [https://gcp-migration-project-278408.uc.r.appspot.com/orders/2](https://gcp-migration-project-278408.uc.r.appspot.com/orders/2)