Introduction to Add-ons

Add-ons are a way to add services to your application, for example a database or a caching system, to enrich its features.

An add-on can be shared by different applications to share data between them. It can be a database shared by two or three applications of your infrastructure for example, or they can be independent.

The add-ons offer different plan to adapt to your needs. You can find details about them on the documentation page of the add-on.

Available add-ons

Clever Cloud provides multiple add-ons to work with your applications:

Warning on SHARED plans

Add-ons having a free plan are meant for testing purposes, not production usage. These add-ons usually rely on shared resources, resulting in variable, non-guaranteed performances and stability.
Shared clusters may not be running the same version as dedicated instances.

Create an add-on for your application

In order to create an add-on for your application, go to the Clever Cloud Console. When you are in the main page of the console, go to the organization in which you wan to create the add-on, for example your personal space.

When you are in the organization, click on Add an add-on. This space let you create and configure the add-on to follow your needs.

First, choose which type of add-on you want to create. See above to have a list of available add-ons and the corresponding pages for a description and information.

Now, select the plan you need for you add-on. You can find details about the pricing, the capacity of the add-on, ... on this page or in the corresponding documentation page.

The third step offers you to choose with which application you want to link you add-on. Linking an add-on to an application will provide configuration to the application through environment variables. This environment variables must be used in your application to, for example, provide the credentials and the localization of the database provided by the add-on.

The last step lets you choose the name of the add-on (for example "My database") and the region where the add-on is hosted. Click on the Create button and the add-on will now be available in your organization, and corresponding environment variables will be available for the applications linked to the add-on you just created.

Managing your add-on

Once an add-on is created, two tabs are available:

  • the Information tab
  • the Configuration tab

To link an add-on with your application, just follow the following steps:

  1. Go in the organization of your application and click on the name of the application you want to link with your add-on.
  2. Go in the Add-ons section.
  3. Click on the Link button of the add-on you want to link to your application.

Information screen

This screen sums-up the characteristics of the selected add-on. Features and environment variables (if applicable) are shown.

Example of the information tab of an add-on

Configuration screen

Add-ons can be managed from the Configuration tab. This screen is managed directly by the provider of the add-on.

Example of the configuration tab of an add-on

Delete an add-on

To delete an add-on, go to the Configuration page of the add-on, and click on Remove add-on. Warning: After deletion of the add-on, all associated data will be removed.

Edit me on GitHub