This documentation is for WSO2 IoT Server 3.2.0. View the documentation for the latest release.
Tenant Management - IoT Server 3.2.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

The goal of multi-tenancy is to maximize resource sharing across multiple users (while hiding the fact that these users are on the same server) and to ensure optimal performance. You can register tenants in the Management Console, allowing tenants to maintain separate domains for their institutions.

When multi-tenancy is used, certain tenants can sometimes become inactive for a long period of time. By default, if the inactive period is 30 minutes, the tenant is unloaded from the server memory. This requires the tenant to log in again before sending requests to the server.

If required, you can change the default time allowed for tenant inactiveness by adding  the -Dtenant.idle.time=<time_in_minutes> java property to the product startup script ( ./iot-server.sh file for Linux and   iot-server.bat  for Windows) as shown below:


JAVA_OPTS \
    -Dtenant.idle.time=30 \

All the WSO2 IoTS tenants can access the public Store, but tenants are always required to log in to view their private store. Before carrying out any tasks on the Management Console, we highly recommend you to change the default super tenant administrator password. You can also create a new tenant.

Changing the default tenant password

Before carrying out any tasks on the Management Console, we highly recommend you to change the default super tenant administrator password. Follow the instructions below to change the default super tenant administrators password:

  1. Open a command prompt:
    • On Windows, choose Start -> Run, type cmd at the prompt, and press Enter.
    • On Linux/Solaris, establish a SSH connection to the server or log in to the text Linux Console.
  2. Execute one of the following commands, where <IOTS_HOME> is the directory where you installed the product distribution:

    OSCommand
    Linux/Solaris
    sh <IOTS_HOME>/bin/iot-server.sh
    Windows
    <IOTS_HOME>\bin\iot-server.bat --run
  3. Log into the Management Console using the following URL format: 
    https://<IOTS_HOST>:<IOTS_HTTPS_PORT>/admin/carbon

    • By default, <IOTS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
    • By default,  <IOTS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

    For example:
    http://localhost:9443/admin/carbon/

  4. Enter the username as admin and the password as admin.
  5. Click Sign-in.
  6. Switch to the Configure tab.
  7. Click Users and Roles and thereafter click User.
  8. Click Change Password in the Actions column, in-line with the user admin and set a new password.
  9. Click Change.
  10. Log out and log in again with the new credentials.

Adding a new tenant

You can add a new tenant in the management console and then view it by following the procedure below. In order to add a new tenant, you should be logged in as a super user.

  1. Click Add New Tenant in the Configure tab of the IoTS management console.
  2. Enter the tenant information in Register A New Organization screen as follows, and click Save.

    Parameter NameDescription
    DomainThe domain name for the organization, which should be unique (e.g., abc.com). This is used as a unique identifier for your domain. You can use it to log into the admin console to be redirected to your specific tenant. The domain is also used in URLs to distinguish one tenant from another. 
    Select Usage Plan for TenantThe usage plan defines limitations (such as number of users, bandwidth etc.) for the tenant.
    First Name/Last NameThe name of the tenant admin.
    Admin Username The login username of the tenant admin. The username always ends with the domain name (e.g., admin@abc.com)
    Admin PasswordThe password used to log in using the admin username specified.
    Admin Password (Repeat)Repeat the password to confirm.
    EmailThe email address of the admin.
  3. After saving, the newly added tenant appears in the Tenants List page as shown below. Click View Tenants in the Configure tab of the management console to see information of all the tenants that currently exist in the system. If you want to view only tenants of a specific domain, enter the domain name in the Enter the Tenant Domain parameter and click Find.

Editing a tenant

Follow the instructions below to edit a tenant:

  1. Log into the Management Console.
  2. Switch to the Configure tab and click View Tenants.
  3. Search for the tenant based on the tenant domain name.
  4. Click Edit.
  5. Edit the tenant details as required. Note that the domain, tenant ID and usage plan can not be modified.
  6. Click Update.
  7. Optionally, click Deactivate, if you wish to deactivate the tenant.

What's next?

Make sure to make the following changes to the email templates and device type to support multi-tenancy.

  • No labels