Java Maven deployment

Overview

Clever Cloud offers you to run your Java Maven projects. You can deploy this kind of project without changing your code, but running it on Clever Cloud needs specific environment variables or configuration files, to add parameters like your targeted container for instance.

Note : like other runtimes, Java application needs to listen on 0.0.0.0:8080

Maven is essentially a project management and comprehension tool and as such provides a way to help with managing:

• Builds
• Documentation
• Reporting
• Dependencies
• SCMs
• Releases
• Distribution

Create an application on Clever Cloud

via the web console

Refer to our getting started for more details on application creation via the console.

via the Clever Tools CLI

1. Make sure you have clever-tools installed locally or follow our CLI getting started guide.
2. In your code folder, do clever create --type <type> <app-name> --region <zone> --org <org> where :
   1. type is the type of technology you rely on
   2. app-name the name you want for your application,
   3. zone deployment zone (par for Paris and mtl for Montreal)
   4. org the organization ID the application will be created under.

Refer to clever create for more details on application creation with Clever Tools.

Setting up environment variables on Clever Cloud

With the Clever Cloud console

1. Go to the Clever Cloud console, and find the app you want to fine tune under it’s organization.
2. Find the Environment variables menu and select it.
3. In this menu, you will see a form with VARIABLE_NAME and variable value fields.
4. Fill them with the desired values then select Add.
5. Don’t forget to “Update Changes” at the end of the menu.

With the Clever Tools CLI

1. Make sure you have clever-tools installed locally. Refer to our CLI getting started.
2. In your code folder, do clever env set <variable-name> <variable-value>

Refer to environment variables reference for more details on available environment variables on Clever Cloud.

You can of course create custom ones with the interface we just demonstrated, they will be available for your application.

Configure your Java application

About Cargo

To run your app, you can, for example, use plugins like cargo (Find it here). Your application must be set to listen on the port 8080.

Available Java versions

Simply set the environment variable CC_JAVA_VERSION to the version you want.

Accepted values are 7, 8, 11, 17 or graalvm-ce (for GraalVM 21.0.0.2, based on OpenJDK 11.0).

We follow the official Java roadmap by supporting both LTS and latest non-LTS versions.

We are using OpenJDK distribution for mentionned Java versions.

Mandatory configuration

Option 1: JSON file in repository

The clevercloud/maven.json (maven.json file in clevercloud folder which is at the root of your repository) file must contain the goal field to indicate how to start your application:

  {
    "deploy": {
      "goal": "yourgoal"
    }
  }

An example of what can be found as a goal value is:

"-Dtest.active=false -Dexec.mainClass=\"com.example.Main\" assembly:jar-with-dependencies exec:java"

Option 2: Environment variable

If you don’t want to add a file to your repository, or if you’re using a monorepository with multiple applications in directories configured with the APP_FOLDER environment variable, you’ll probably prefer to use an environment variable for deployment configuration.

Simply define MAVEN_DEPLOY_GOAL="yourgoal" and it’s OK!

Eg. MAVEN_DEPLOY_GOAL="spring-boot:run" for a Spring Boot application with spring-boot-maven-plugin

Optional configuration

The full configuration can look like the following:

{
  "build": {
    "type": "<string>",
    "goal": "<string>"
  },
  "deploy": {
    "goal": "<string>"
  }
}

You can use the following properties:

Specifying a profile

If you need to specify a maven profile (either for the build or the deploy goal, you can add it in the goal section:

"-Pmyprofile package"

Or use the CC_MAVEN_PROFILES environment variable.

Eg. CC_MAVEN_PROFILES="prod".

Custom run command

If you need to run a custom command you can specify it through the CC_RUN_COMMAND environment variable. This will override the default maven run we use to run your application.

Example:

CC_RUN_COMMAND="java -jar somefile.jar <options>"

Monitor your application with New Relic

You can use New Relic to monitor your application on Clever Cloud.

Please refer to our New Relic documentation to configure it for your application.

Git Deployment on Clever Cloud

You need Git on your computer to deploy via this tool. Here is the official website of Git to get more information: git-scm.com

Setting up your remotes

1. The “Information” page of your app gives you your Git deployment URL, it looks like this:

   1. git+ssh://[email protected]/<your_app_id>.git
   2. Copy it in your clipboard

2. Locally, under your code folder, type in git init to set up a new git repository or skip this step if you already have one

3. Add the deploy URL with git remote add <name> <your-git-deployment-url>

4. Add your files via git add <files path> and commit them via git commit -m <your commit message>

5. Now push your application on Clever Cloud with git push <name> master

Refer to git deployments for more details.

Linking a database or any other add-on to your application

By linking an application to an add-on, the application has the add-on environment variables in its own environment by default.

On add-on creation

Many add-ons do exist on Clever Cloud, please refer to the full list and check add-ons dedicated pages for full instructions.

During add-on creation, you will see Applications screen, with a list of your applications. You can toggle the button to Link and click next. If you finish the process of add-on creation, the application will automatically be linked to it.

Add-on already exists

In the Clever Cloud console, under the Service Dependencies menu of your application, you can use the Link addons dropdown menu to select the name of the add-on you want to link and use the add button to finish the process.

You can also link another application from the same page in the Clever Cloud console, using the Link applications dropdown menu.

More configuration

Need more configuration? To run a script at the end of your deployment? To add your private SSH key to access private dependencies?

Go check the Common configuration page.

You may want to have an advanced usage of your application, in which case we recommend you to read the Administrate documentation section.

If you can’t find something or have a specific need like using a non supported version of a particular software, please reach out to the support.