Improve this page

Deploying to Google Cloud Platform Permalink to " Deploying to Google Cloud Platform"

Google Cloud Platform

You can deploy JHipster applications to Google Cloud Platform and run on:

You can obtain Google Cloud Platform free trial to deploy your applications. Please check the Always Free tiers for free usages up to the specified usage limits during and past the free trial.

Before you start Permalink to "Before you start"

Install and authenticate with the gcloud SDK on your local environment to access gcloud CLI. For more information, visit this link:

Deploy to Google App Engine Permalink to "Deploy to Google App Engine"

Google App Engine is a fully managed Platform as a Service that can automatically scale up application instances under load, and scale down to zero when not used.

You can use the Google App Engine generator to generate and deploy JHipster application. Google App Engine generator supports monolith and micro-service applications, with Cloud SQL MySQL/PostgreSQL database.

Deploying Monoliths to Google App Engine Permalink to "Deploying Monoliths to Google App Engine"

  1. Generate a new monolith application: jhipster
  2. Run Google App Engine generator: jhipster gae
  3. Optionally create a new Cloud SQL instance if creating a brand new application

This generator will:

  1. Add src/main/appengine/app.yaml that describes the App Engine instance and scaling configuration.
  2. Add the App Engine plugin to Maven / Gradle.

To deploy: Please note that currently the Google App Engine generator only supports deployments to App Engine Standard (Java 11) environment.

  • Use the App Engine plugin to deploy: ./mvnw package appengine:deploy -DskipTests -Pgae,prod,prod-gae or using Gradle ./gradlew appengineDeploy -Pgae -Pprod-gae

Deploying Microservices to Google App Engine Permalink to "Deploying Microservices to Google App Engine"

Google Cloud supports micro-service architecture on GAE by isolating each micro-service as a separate service. We use a dispatch.yaml file to route the requests from the gateway to each micro-service. Therefore, in order to deploy microservices to GAE you will need to deploy the gateway and each microservice as separate services.

Following are the steps that needs to be carried out.

  1. Run the GAE sub-generator on each micro-service. It is important to run this as the first step as the gateway application setup will depend on this.

  2. Run the GAE sub-generator on the gateway application. This will prompt for some additional questions in order to create the dispatch.yaml file.

  3. Deploy each microservice and the gateway application using ./mvnw package appengine:deploy -DskipTests -Pgae,prod,prod-gae for Maven or ./gradlew appengineDeploy -Pgae -Pprod-gae for gradle.

Note 1: If you are using Windows, we recommend using Windows Subsystem for Linux or jhipster-devbox to avoid Windows spedific issues such as, https://github.com/jhipster/generator-jhipster/issues/11249

Note 2: If you are using Cloud SQL, you need to add Cloud SQL Client role to the App Engine service account. Refer, https://cloud.google.com/sql/docs/mysql/connect-app-engine#setting_up

In addition, Google App Engine provides a full suite of features to manage your application:

  • Traffic Splitting - Deploy multiple versions of your application and split traffic to different versions. This is also great for canary new changes.
  • Stackdriver Logging - Automatically capture and store application logs in centralized logging that can be searched, monitored, and exported.
  • Error Reporting - Automatically extract errors and exceptions for the log and notify you of new errors.
  • Cloud Debugger - Allow you to debug your production application without stopping the world. If you needed more log messages to diagnose the issue, add new log messages without redeploying/restarting your application.

You can watch a walk through of features in 2018 JHipster Conf video on the Google App Engine generator with Ray Tsang and Ludovic Champenois.

Deploy to Google Kubernetes Engine Permalink to "Deploy to Google Kubernetes Engine"

Google Kubernetes Engine is a fully managed Kubernetes cluster as a service. Once provisioned, you can deploy your containers and JHipster applications using standard Kubernetes commands.

  1. Enable API: gcloud services enable container.googleapis.com containerregistry.googleapis.com
  2. Install kubectl CLI if not already installed: gcloud components install kubectl
  3. Create a new Google Kubernetes Engine cluster: gcloud container clusters create mycluster --zone us-central1-a --machine-type n1-standard-4

See GCP’s zones and machine-types for other options.

Once the cluster is created, you can use JHipster Kubernetes generator to generate the deployment descriptors.

  1. Generate Kubernetes deployment files: jhipster kubernetes
  2. If you want to use Google Container Registry to publish container images in a private registry:
  3. What should we use for the base Docker repository name set to gcr.io/YOUR_PROJECT_ID

Build the container image.

  1. If you use Google Container Registry, you can build directly to the registry without local Docker daemon: ./mvnw package -Pprod jib:build
  2. Otherwise, build to Docker daemon: ./mvnw package -Pprod jib:dockerBuild

Deploy to Kubernetes cluster:

  1. Apply the Kubernetes configurations: ./kubectl-apply.sh

For full Kubernetes generator features, see Deploying to Kubernetes.

Enable HTTPS Permalink to "Enable HTTPS"

To enable HTTPS for your cluster, see Ray Tsang’s External Load Balancing docs.

You can force the use of HTTPS by adding the following configuration to your SecurityConfiguration.java.

// Spring MVC
http.requiresChannel(channel -> channel
    .requestMatchers(r -> r.getHeader("X-Forwarded-Proto") != null).requiresSecure());

// WebFlux
http.redirectToHttps(redirect -> redirect
    .httpsRedirectWhen(e -> e.getRequest().getHeaders().containsKey("X-Forwarded-Proto")));

See Spring Security’s Servlet and WebFlux documentation for more information.