Products documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Tenants ======

===== Purpose =====
 
  * A single instance of Redpeaks can be used to monitor devices of multiple end customers/entities.
  * Tenants are silos you can use to isolate the data of those entities.
  * Users and administrators of a given tenant will never be able to see any data from another tenant.
  * Each tenant is assigned to its own database for storing configuration and device metadata. 
  * Each tenant is also assigned to a metrics database to store time series in an efficient way.

===== Tenants UI =====
{{..:administration:pasted:20210630-174757.png?1000}}
  * The tenants settings shows a table of the existing tenants.
  * It allows the following actions:
    * Create/Edit a tenant
    * Delete/bulk delete tenants


----
===== Create/Edit =====
{{..:administration:pasted:20210630-174316.png?600}}
  * Press **Create** or select **Edit** in the table action menu to open the tenant editor
  * Set the tenant's parameters
    * Name
    * Description
    * Key: A short key to uniquely identify the tenant.
    * Configuration database connector: To store configuration and metadata.
    * Metrics database connector: To store time series data.
    * Users

===== Add tenant users =====
  * Once you saved the tenant for the first time, the **Users** tab will become available
  * Create the first tenant admin user

{{..:administration:pasted:20210713-165958.png}}

{{:common:icon_info.png}}
You just need to create a tenant admin at this stage. Regular users can be then created from within tenant settings UI

{{:common:icon_warning.png}}
Users must be unique across all tenants (name and email adress)

----
===== Delete/Bulk delete =====

  * You can **delete** a single tenant or a group of tenants by either using the table action menu or the **bulk delete** button.