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:
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:
- 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.
Execute one of the following commands, where
<IOTS_HOME> is the directory where you installed the product distribution:
Log into the Management Console using the following URL format:
- By default,
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
adminand the password as
adminand set a new password.
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.
- Click Add New Tenant in the Configure tab of the IoTS management console.
Enter the tenant information in Register A New Organization screen as follows, and click Save.
Parameter Name Description Domain The 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 Tenant The usage plan defines limitations (such as number of users, bandwidth etc.) for the tenant. First Name/Last Name The name of the tenant admin. Admin Username The login username of the tenant admin. The username always ends with the domain name (e.g., email@example.com) Admin Password The password used to log in using the admin username specified. Admin Password (Repeat) Repeat the password to confirm. The email address of the admin.
- 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:
- Log into the Management Console.
- Switch to the Configure tab and click View Tenants.
- Search for the tenant based on the tenant domain name.
- Click Edit.
- Edit the tenant details as required. Note that the domain, tenant ID and usage plan can not be modified.
- Click Update.
- Optionally, click Deactivate, if you wish to deactivate the tenant.
Make sure to make the following changes to the email templates and device type to support multi-tenancy.