.NET – Clever Cloud Documentation

.NET

Overview

Clever Cloud allows you to deploy .NET web applications. This page explains you how to set up your application to run it with the .NET runtime.

You don’t need to change a lot in your application, the requirements section explains how to configure your apps with some mandatory files to add, and properties to setup.

⚠️

If you encounter an issue, please contact the support.

Create an application on Clever Cloud

With the web console

Refer to Quickstart for more details on application creation via the console.

With the Clever Tools CLI

Make sure you have clever-tools installed locally or follow our CLI getting started guide.
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

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 Add.
Don’t forget to “Update Changes” at the end of the menu.

With the Clever Tools CLI

Make sure you have clever-tools installed locally. Refer to our CLI 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.

Configure your Dotnet application

.NET version

The versions used on Clever Cloud are the following:

Default Version	Accepted Versions
`6.0`	`8.0`

You can change the default version by setting the CC_DOTNET_VERSION environment variable to 6.0. Clever Cloud doesn’t support non-LTS and older versions.

Requirements

Be sure that:

You have pushed in master branch.
You listen on port 8080, by default each .NET application is created with the ASPNETCORE_URLS="http://0.0.0.0:8080" environment variable.
You have committed the different files of your project and the corresponding project file (.csproj, .fsproj or .vbproj).

Take an example with the cc-dotnet-demo.

If needed, you could add the APP_FOLDER=<your_app_folder> environment variable to define the application folder inside the Git repository (where .*proj is stored).

During deployment, the runtime automatically detects the cc-dotnet-demo.csproj file and the target framework net8.0. Then, it publishes the .NET project:

dotnet publish --framework net8.0 --configuration Release

No additional configuration is required (unless multiple project files or target frameworks are present, see the documentation below).

Multiple project files in the repository

If multiple project files are present in your repository, you can specify the file to use (without the .*proj extension) with the CC_DOTNET_PROJ environment variable.

CC_DOTNET_PROJ=cc-dotnet-demo

Multiple binary targets

If your project file defines multiple targets, like :

1
2
3
4
5
6
<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net6.0;net8.0</TargetFramework>
  </PropertyGroup>
  ...

You must specify the one you want to run, with the CC_DOTNET_TFM environment variable.

If CC_DOTNET_TFM is specified, then the executable produced by this target is used to start the application.

CC_DOTNET_TFM=net6.0

Dependencies

Make sure to list all your dependencies in your project file. For example:

1
2
3
4
5
6
7
  ...
  <ItemGroup>
    <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="5.0.1" />
    <PackageReference Include="Microsoft.SyndicationFeed.ReaderWriter" Version="1.0.2" />
  </ItemGroup>
  </ItemGroup>
</Project>

Compiled dependencies are cached by default to speed up deployments. You can turn off dependencies caching completely by removing the CC_CACHE_DEPENDENCIES environment variable.

If you want to rebuild your application from scratch, you can select “rebuild and restart” from the console or launch clever restart --without-cache from CLI

Configure profile

The default profile is Release but you can use the CC_DOTNET_PROFILE environment variable to change this configuration.

CC_DOTNET_PROFILE=Debug

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.

For instance, you can have CC_RUN_COMMAND=./bin/Release/net6.0/exherbo-x64/myapp <options>.

Private dependencies

Clever Cloud supports private dependency management with NuGet package manager.

Add the configuration file nuget.config :

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <packageSources>
     <clear />
     <add key="my_nuget_repo" value="%PACKAGE_REGISTRY_URI%" />
 </packageSources>
 <packageSourceCredentials>
     <my_nuget_repo>
         <add key="Username" value="%PACKAGE_REGISTRY_USERNAME%" />
         <add key="ClearTextPassword" value="%PACKAGE_REGISTRY_PASSWORD%" />
     </my_nuget_repo>
 </packageSourceCredentials>
</configuration>

Set environment variables in the console according to your own information : PACKAGE_REGISTRY_URI, PACKAGE_REGISTRY_USERNAME and PACKAGE_REGISTRY_PASSWORD

Environment injection

Clever Cloud injects environment variables from your application settings as mentioned in setting up environment variables and is also injecting in your application production environment, those from your linked add-ons.

Custom build configurations

On Clever Cloud you can define some build configuration: like the app folder to deploy or the path to validate your application deployment is ready To do that follow the documentation here and add the environement variable you need.

To access environment variables from your code, you can use System.Environment.GetEnvironmentVariable("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:
1. git+ssh://git@push.clever-cloud.com/<your_app_id>.git
2. 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 via git commit -m <your commit message>
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: refer to the full list and check add-ons dedicated pages for full instructions.

During add-on creation, an Applications screen appears, 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 is automatically 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 add-ons 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.

Enable health check during deployment

The healthcheck allows you to limit downtimes. Indeed, you can provide Clever Cloud with paths to check. If these paths return something other than 200, the deployment will fail.

Add one (or several) environment variable as such:

CC_HEALTH_CHECK_PATH=/my/awesome/path

CC_HEALTH_CHECK_PATH_0=/my/awesome/path
CC_HEALTH_CHECK_PATH_1=/my/other/path

The deployment process checks all paths. All of them must reply with a 200 OK response code.

By default, when no environment variable (for ex: APP_HOME) is defined, the monitoring checks your repository root path /.

Example

Using the path listed above, below are the expected logs:

Response from GET /my/awesome/path is 200
Response from GET /my/other/path is 500
Health check failed:
- GET /my/other/path returned 500.
If the deployment fails after this message, please update your configuration and redeploy.

In this example, the first path is OK, but the second one failed. This gives you a hint on what failed in your application.

Best practice for healthcheck endpoints

To make the most of a healthcheck endpoint, have it check your critical dependencies. For example:

execute SELECT 1 + 1; on your database
retrieve a specific Cellar file
ping a specific IP through a VPN

Last updated on August 16, 2024