On this page

Gradle deployment

Overview

Clever Cloud offers you to run your Gradle projects. You can deploy this kind of project without changing your code, but running it on Clever Cloud needs some configuration files or environment variables, to add parameters like your gradle task for example.

Gradle is a project automation tool that builds upon the concepts of Apache Ant and Apache Maven and introduces a Groovy-based domain-specific language (DSL) instead of the more traditional XML form of declaring the project configuration.

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

Create an application on Clever Cloud

via the web console

  1. Create a new app by clicking on the Add an Application button, in the sidebar.
  2. Select a brand new instance (or a repository from GitHub if your account is linked).
  3. Then select Java or Groovy + Gradle in the platform list.
  4. Configure your scaling options.
  5. Enter your application’s name and description and click “Next”. You can also select the region you want (North America or Europe).

Refer to the 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. Report to the getting started.
  2. In your code folder, do clever create --type <type> <app-name> --region <zone> --org <org> where type is the type of technology you rely on, app-name the name you want for your application, zone deployment zone (par for Paris and mtl for Montreal), and org the organization ID the application will be created under.

Refer to the documentation 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. Fill them with the desired values then select Create.

With the Clever Tools CLI

  1. Make sure you have clever-tools installed locally. Report to the 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.

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.

Configure your Java application

You must provide a clevercloud/gradle.json file (gradle.json file in clevercloud folder which is at the root of you application) that contains at least the following:

{
  "deploy": {
    "goal": "grails:run"
  }
}

That is the only option you really need to supply.

Optional configuration

The full configuration can look like the following:

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

You can use the following properties:

UsageFieldDescription
Optionalbuild -> typecan be maven, gradle or ant
Optionalbuild -> goalis the target you want to use to build your project
Requireddeploy -> goalthe goal/target and options you want to execute to deploy/run you project

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 way of runing your application.

Example:

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

Environment injection

Clever Cloud can inject environment variables that are defined in the dashboard and by add-ons linked to your application.

For Java applications, the environment is injected in the System.getProperties() object.

So, to use a variable, you just need System.getProperties().getProperty("MY_VARIABLE").

For Groovy applications, just use the System.getProperty("MY_VARIABLE").

The Gradle Wrapper

Since Gradle can come in many versions, Clever Cloud automatically support the [Gradle Wrapper|https://www.gradle.org/docs/current/userguide/gradle_wrapper.html].

Just create and commit the gradlew file and the wrapper jar and properties files:

./
	clevercloud/
		gradle.json
	gradlew
	gradle/wrapper/
		gradle-wrapper.jar
		gradle-wrapper.properties
	src/

Monitor your application with New Relic

You can use New Relic to monitor your application on Clever Cloud. Please refer to the 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: git+ssh://[email protected]/<your_app_id>.git. 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 the quickstart for more details on git deployments.

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.

Comments