Skip to main content

Admin Console

Dashboard​

Dashboard

In the main dashboard, it is possible to view all tenants created and create new ones by clicking on Create new tenant.

Tenant info

To select an existing tenant, click on the name; otherwise, it is also possible to delete the tenant through the three dots menu.

Delete Tenant

danger

Attention, this option is irreversible. All the tenant data will be lost.

Create a new tenant​

Create a new tenant

To create a new tenant, fill out the form:

  • Tenant name.
  • Tenant slug.
  • Realm name.
  • Tenant description.
  • Select location.
  • Email of users with whom the tenant should be shared.

Tenant Overview​

Tenant page

On the page related to the tenant, it is possible to view all the information necessary to interact with the data contained within it.

General Info​

This card contains the general info of the tenant, such as:

  • Name: the name of the tenant.
  • Slug: reference name.
  • Cluster: the name of the cluster where the realm of this tenant resides.
  • Location: the cloud provider and zone of the cluster.
  • Realm: the realm name.
  • API URL: the base API URL to reach the Astarte instance containing the realm.
  • Dashboard button: click this button to access the Astarte Dashboard of your realm.
  • Delete tenant button: delete the tenant and its associated realm.

Design System​

The Platform supports the customization of the graphical design. The customization happens via the Admin Console and consists of the following:

  • Logo: This image file will be presented on the authentication pages and the menu on the portal.
  • Theme: dictates the colors, fonts, spacing, and visual style of the portal.

You can customize these settings for each tenant.

Tenant Design System

Besides the default one, you can upload a custom image file.

Theme​

The Platform provides some theme presets to choose from. You can also upload a custom CSS theme.

Custom theme specs​

A custom theme is a CSS file that follows CSS syntax and has the .css extension.

The file is expected to define the same classes and CSS properties of Bootstrap 5.1, plus the following additional ones:

  • The --online, --offline, --fault CSS properties define the colors shown on the related device status.
  • The color-online, color-offline, color-fault classes, that should apply those colors, such as .color-online { color: var(--online) }.

You can compile the CSS file from a customized SASS version of the default Bootstrap sources. Here you can find a path to prepare a build pipeline documented https://getbootstrap.com/docs/5.0/getting-started/build-tools/

note

Please note that the style customization is in active development, and breaking changes is possible.

Custom theme examples​

A sample theme could be the compiled CSS file of the following SASS:

// Default values for Boostrap init
$theme-colors: (
  "primary": #0631cc,
  "accent": #11b0ef,
);

$black: #000;

$box-shadow: 0 0.2rem 0.4rem rgba($black, 0.15);
$box-shadow-lg: 0 0.2rem 0.2rem rgba($black, 0.5);

@import "~bootstrap/scss/bootstrap.scss";

:root {
  --online: var(--success);
  --offline: var(--gray);
  --fault: var(--danger);
}

.color-online {
  color: var(--online);
}

.color-offline {
  color: var(--offline);
}

.color-fault {
  color: var(--fault);
}

Realm private key​

This private key allows you to generate custom tokens to access all your realm APIs (Realm Management, Pairing, AppEngine).

Clea utility commands​

These are some useful commands you can execute with the command line utility astartectl to manage directly the data stored in Astarte. Use the token shown in the textbox to interact with astartectl, since you'll need a JWT with claims for both AppEngine and Realm Management.

Realm management token​

This is a ready-to-use token to interact with Realm Management API. The token expires 24 hours after its creation. Below is shown the date and time of expiration of the token.

AppEngine Token​

This is a ready-to-use token to interact with AppEngine API. The token expires 24 hours after its creation. Below is shown the date and time of expiration of the token.

Pairing Token​

A ready-to-use token to interact with Pairing API. This token never expires after its creation.

Tenant Applications​

From this section, you can create and manage third-party Clea Portal Apps customized by you to better fit your needs.

Tenant Design System

Here it is possible to create new applications or modify the existing ones.

Tenant Design System

The information needed to load a Clea Portal App within the Clea Portal UI are the following:

  • Display Name: is the name visualized in the Tab inside the Appliance page.
  • Name: is the name you choose to give to the application.
  • JS Bundle URL: is the URL where the JS Bundle of the application is deployed and accessible for download. It must be an externally accessible address so that Clea Portal can dynamically load the application when the appliance page is accessed.
  • Required Astarte interfaces: You need to set up the list of Astarte interfaces defined for this application. Each interface is determined by its name, major and minor versions. This application is loaded into every Appliance page that declares and uses these Astarte interfaces.