Jar deployment
Overview
Clever Cloud offers you to run any Java ARchive file. You do not need to change your code, but running it on Clever Cloud needs some configuration files or environment variable to specify the the JAR path.
Note : like other runtimes, Java application needs to listen on 0.0.0.0:8080
Create an application on Clever Cloud
via the web console
- Select the proper organization you want to add the application to. At this point you should only have the Personal Space, click on the Me button in the left sidebar.
- Create a new application by clicking on the Create… button in the sidebar, then select an application.
- Select a brand new instance (or a repository from GitHub if your account is linked).
- Then select Java + JAR in the platform list.
- Configure your scaling options.
- 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
- Make sure you have clever-tools installed locally. Report to the getting started.
- In your code folder, do
clever create --type <type> <app-name> --region <zone> --org <org>
wheretype
is the type of technology you rely on,app-name
the name you want for your application,zone
deployment zone (par
for Paris andmtl
for Montreal), andorg
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
- Go to the Clever Cloud console, and find the app you want to fine tune under it’s organization.
- Find the Environment variables menu and select it.
- 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
- Make sure you have clever-tools installed locally. Report to the getting started
- 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.
Default version
We are using Java version 11 by default.
New applications will have the CC_JAVA_VERSION environment variable set to 11.
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.
non-LTS versions
Every non-LTS versions where Premier support ends will be removed without warning as you should be able to switch to the next available non-LTS version without any trouble.Configure your Java application
You must either have the CC_JAR_PATH
environment variable containing the
path to your jar or provide a clevercloud/jar.json
file (jar.json file in
clevercloud folder which is at the root of your repository) that
contains at least the following:
{
"deploy": {
"jarName": "path/to/jar"
}
}
That is the least you need to do. Note that path/to/jar
must not start with a /
and that the path should be relative to your repository’s root.
Build options
You do not need to build and commit a JAR. Instead you can push your
sources and build them with either gradle, ant or maven. Here is the
configuration you need to provide in the clevercloud/jar.json
file:
{
"build": {
"type": "maven"|"gradle"|"ant",
"goal": "package"
}
}
The goal
field is what will be asked to the build command, like mvn package
for a maven
build with the package
goal.
An configuration example with a maven build that generates a JAR with embedded dependencies is:
{
"build": {
"type": "maven",
"goal": "package"
},
"deploy": {
"jarName": "target/myproject-1.0-jar-with-dependencies.jar"
}
}
An example of full configuration
You can pass extra arguments to the java
command by using the environment
variable CC_EXTRA_JAVA_ARGS
and to your JAR by using CC_JAR_ARGS
The full configuration can look like the following:
{
"build": {
"type": "<string>",
"goal": "<string>"
},
"deploy": {
"goal": "<string>",
"jarName": "<string>"
}
}
You can use the following properties:
Usage | Field | Description |
---|---|---|
Optional | build -> type | can be maven , gradle or ant |
Optional | build -> goal | is the target you want to use to build your project |
Optional | deploy -> goal | the goal/target and options you want to execute to deploy/run you project |
Required | build -> jarName | jar file name of your application |
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.
Custom run command
If you need to run a custom command (or just pass options to the program),
you can specify it through the CC_RUN_COMMAND
environment variable.
This will override the default way of running 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")
.
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
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.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.Add the deploy URL with
git remote add <name> <your-git-deployment-url>
.Add your files via
git add <files path>
and commit them viagit commit -m <your commit message>
.Now push your application on Clever Cloud with
git push <name> master
Refer to the quickstart for more details on git deployments.
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.