NubesGen Documentation

# Using Spring Boot with NubesGen

This documentation is for running Spring Boot applications with NubesGen. There are two other options that might interest you:

NubesGen supports creating Azure App Service instances and Azure Functions instances, depending on the type of Spring Boot application that you wish to deploy.

# Tutorial 1: running a full stack Spring Boot application generated with JHipster

We're going to deploy https://github.com/jhipster/jhipster-sample-app (opens new window), which is the default JHipster (opens new window) application.

It uses a PostgreSQL database, so creating the database and connecting to it will also be managed by NubesGen.

We'll use NubesGen's GitOps support to automatically build and deploy the application.

Prerequisites:

Tip: You can go to https://aka.ms/nubesgen-azure-shell (opens new window) to have those prerequisites installed, and run the script from a Web browser.

Steps:

  1. Fork the project on your GitHub account.
  2. Clone the fork on your computer. Change <your-github-account> to the name of your GitHub account:
    git clone https://github.com/<your-github-account>/jhipster-sample-app.git
  3. In the cloned project (cd java-sample-app), set up GitOps with NubesGen by running the NubesGen CLI (more information here):
     ./nubesgen-cli-linux gitops
  4. Use the command-line with NubesGen (more information here) to generate a NubesGen configuration:
    curl "https://nubesgen.com/demo.tgz?runtime=spring&application=app_service.standard&database=postgresql&gitops=true" | tar -xzvf -
  5. Create a new branch called env-dev, and push your code:
    git checkout -b env-dev
git add .
git commit -m 'Configure GitOps with NubesGen'
git push --set-upstream origin env-dev
  6. Go to your GitHub project, and check that the GitHub Action is running.
  7. You can go to the Azure Portal (opens new window) to check the created resources.
  8. The application should be deployed on your App Service instance. Its URL should be in the form https://app-demo-XXXX-XXXX-XXXX-XXXX-dev-001.azurewebsites.net/, and you can also find it in the GitHub Action workflow (Job: "display-information", step "Display Azure infrastructure information"), or in the Azure portal.
  9. Once you have finished, you should clean up your resources:
    1. Delete the resource group that was created by NubesGen to host your resources, which is named rg-XXXX-XXXX-XXXX-XXXX-001.
    2. Delete the storage account used to store your Terraform state, in the rg-terraform-001 resource group.

# Tutorial 2: running a Spring Intializr project with NubesGen

This tutorial is similar to the Java on NubesGen tutorial, as this simple Spring Boot application is also a Java application.

Prerequisites:

Tip: You can go to https://aka.ms/nubesgen-azure-shell (opens new window) to have those prerequisites installed, and run the script from a Web browser.

Steps:

  1. Create a sample Java Web application using https://start.spring.io/ (opens new window).
    curl https://start.spring.io/starter.tgz?type=maven-project&language=java&bootVersion=3.1.3&baseDir=java-sample-app&groupId=com.example&artifactId=java-sample-app&name=java-sample-app&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.java-sample-app&packaging=jar&javaVersion=17&dependencies=web | tar -xzvf -
  2. Create a project on GitHub called java-sample-app, and push the generated project to that repository. Change <your-github-account> by the name of your GitHub account:
    cd java-sample-app
git init
git add .
git commit -m "first commit"
git remote add origin https://github.com/<your-github-account>/java-sample-app.git
git branch -M main
git push -u origin main
  3. In the cloned project (cd java-sample-app), set up GitOps with NubesGen by running the NubesGen CLI (more information here):
     ./nubesgen-cli-linux gitops
  4. Use the command-line with NubesGen (more information here) to generate a NubesGen configuration:
    curl "https://nubesgen.com/demo.tgz?runtime=spring&application=app_service.standard&gitops=true" | tar -xzvf -
  5. Create a new branch called env-dev, and push your code:
    git checkout -b env-dev
git add .
git commit -m 'Configure GitOps with NubesGen'
git push --set-upstream origin env-dev
  6. Go to your GitHub project, and check that the GitHub Action is running.
  7. You can go to the Azure Portal (opens new window) to check the created resources.
  8. The application should be deployed on your App Service instance. Its URL should be in the form https://app-demo-XXXX-XXXX-XXXX-XXXX-dev-001.azurewebsites.net/, and you can also find it in the GitHub Action workflow (Job: "display-information", step "Display Azure infrastructure information"), or in the Azure portal. As it is an empty application, you should get 404 page called Whitelabel Error Page.
  9. Once you have finished, you should clean up your resources:
    1. Delete the resource group that was created by NubesGen to host your resources, which is named rg-demo-XXXX-XXXX-XXXX-XXXX-001.
    2. Delete the storage account used to store your Terraform state, in the rg-terraform-001 resource group.

# Which Azure resources will be created

If you deploy your Spring Boot application to an Azure App Service instance, NubesGen will generate:

If you deploy your Spring Boot application to an Azure Function, NubesGen will generate:

# Maven vs Gradle

NubesGen supports both Maven and Gradle, so you can use the build system you prefer.

# Configuration options

In the generated terraform/modules/app-service/main.tf file, NubesGen will configure some environment variables for your application. Those are standard Spring Boot properties, so your Spring Boot application should be automatically configured (for example: your database connection should be working out-of-the-box).

  • SPRING_DATASOURCE_URL: the JDBC URL to your database
  • SPRING_DATASOURCE_USERNAME: the database user name
  • SPRING_DATASOURCE_PASSWORD: the database password
  • SPRING_REDIS_HOST: the Redis host name
  • SPRING_REDIS_PASSWORD: the Redis password
  • SPRING_REDIS_PORT: the Redis port (by default 6380)
  • SPRING_REDIS_SSL: if Redis uses SSL (by default true)
  • AZURE_STORAGE_ACCOUNT_NAME: the storage account name
  • AZURE_STORAGE_ACCOUNT_KEY: the storage account key
  • AZURE_STORAGE_BLOB_ENDPOINT: the blob storage endpoint
  • SPRING_DATA_MONGODB_DATABASE: the MongoDB database name
  • SPRING_DATA_MONGODB_URI: the MongoDB database URL

← Using Quarkus with NubesGen →