Regular Operations
Single-tenant and multi-tenant mode
Tool Management can either run in single-tenant mode or in multi-tenant mode.
Single-tenant mode
In single-tenant mode, the toolmanagement-tenant image is not used and the connectionstring for the database can be directly configured for the toolmanagement-backend image.
If running in single-tenant mode and the main tenant used is not the bci tenant, the default tenant id has to be changed accordingly.
Please refer to the keys scheduler_default_tenant_config and blocksmanagement_default_tenant_config and set them to the typically used tenant id. It is advised to perform this configuration before the toolmanagement-backend service is started for the first time.
|
Multi-tenant mode
In multi-tenant mode, the toolmanagement-tenant image is required. In contrast to other Nexeed IAS modules, tool management uses/requires a different database or user/schema for each tenant.
In this scenario the main tool management database is used by the tenant service and stores the mapping of tenantId ←→ Connectionstring. This mapping information is used by the Tool Management backend service to retrieve the connectionstring for a tenant.
The connectionstrings that will be stored in the database are encrypted. Tool Management provides a UI to manage tenants and their connections. This tenant settings UI is only available for BCI admins (and hosted by the Tool Management web service).
If a new tenant is added to the system the information for the tenant connection has to be provided via the UI. If the same database user (on different databases) is used for multiple tenants or a separate database user is created for each tenant can be decided for each installation separately.
After providing the information the database must be initialized, this can be done using the UI. After initialization the tenant will be available in Tool Management.
Switching from single-tenant to multi-tenant mode
The following steps have to be performed in order to switch Tool Management from single-tenant to multi-tenant mode:
-
Stop all Tool Management services
-
Backup the current Tool Management database
-
Make sure that the configured database in the inventory is only used in the toolmanagement-tenant service and not in the toolmanagement-backend service.
This can either be done by renaming the existing database or by changing the inventory variables to use a new database -
Start the toolmanagement-tenant service providing a database connection to an empty database. This will cause the service to perform a database migration to the expected state
-
Start the toolmanagement-web service for hosting the UI for the tenant management.
-
After the tenant service is started, the tenant settings UI can be accessed via the Portal (or alternatively accessing [toma-module-url]/standalone).
The backed up database should be configured for the desired tenant. -
The other Tool Management services can now also be started.