Document toolboxDocument toolbox

Managing tenants

Owned by Sarabjeet Kaur
Last updated: Nov 16, 2023
4 min read

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

If you have multiple instances of Kyvos and Kyvos Manager running in your organization, you can manage them as tenants under a single administrator portal called Tenant Management Portal.

To configure an instance of Kyvos Manager as the Tenant Management Portal, perform the following steps:

  1. Deploy a separate instance of Kyvos Manager, as explained in the Kyvos Manager Installation Guide. This instance will be configured as the Tenant Management portal using the following steps:

    1. On this Kyvos Manager instance, edit the kyvosmanager.properties file available at  ../kyvosmanager_war/kyvosmanager/conf/  location.
      Set the following property: 
      APP_MODE=MANAGEMENT_CONSOLE

    2. Start the Kyvos Manager ONLY after making this configuration change. If already started, you need to restart the Kyvos Manager server to bring the property into effect.

  2. Access the Tenant Management Portal http://<KM IP>:<port>/kyvosmanager . The Tenants page is displayed with a list of existing tenants (if any).

On the Tenant Management Portal, you can:

  1. Register new tenants and update or deregister existing tenants.

  2. Manage tenants by accessing the respective tenant's:

    1. Kyvos Manager Portal to update Kyvos configurations or cluster settings.

    2. Kyvos Web portal and work on the Kyvos entity objects and connections, build semantic model, analyze semantic model data, share entities with tenant users, and so on.

Registering a tenant

Important

If the tenant that you want to register is TLS enabled, then before registering it as a tenant, you MUST add certificates in the jre folder of the Tenant Management Portal.

Steps:

  1. Keep the  server.crt file of the tenant handy. This is available on the Kyvos machine at: <install location>/kyvos/commons/config/ckstore/

  2. Now access the Tenant Management Portal machine through the terminal, and navigate to the kyvosmanager_war / jre / jre /lib/security/  folder.

  3. Here, copy the server.crt file that you took from the tenant.

  4. Create a backup of the  cacerts  file available at  / kyvosmanager_war / jre / jre /lib/security/ location.

  5. Run the following command to import server.crt in  cacerts  certificate.
    keytool -import -alias keycert -file server.crt -keystore cacerts -storepass changeit

  6. Restart the Kyvos Manager server of the Tenant Management Portal.

To register an existing Kyvos instance as a tenant, perform the following steps.

  1. On the Tenant management portal, click REGISTER TENANT.

  2. On the Register Tenant dialog box, enter details as:

    1. Tenant Name: Provide a relevant name for the tenant.

    2. Kyvos Manager Portal URL: Provide the URL of the Kyvos Manager portal that you want to add as a tenant.

    3. Description: Optionally, provide a description for the tenant.

  3. Click REGISTER.

Once the tenants are registered, they are displayed on the Tenants page as:

If the new tenant is not displayed, click REFRESH or refresh your browser page.

Tip

  • To view Kyvos or Kyvos Manager portals for the tenant, click the Open corresponding to it. The portal will open in a new browser window.

  • If you do not see the Open link for any of the Kyvos portals, check the corresponding Kyvos Manager to confirm if the Kyvos cluster exists.

Tenant actions

You can perform the following actions on tenants using the corresponding icons, as shown in the figure below.

  1. Refresh

  2. Edit

  3. Deregister

Tips

In case of any errors related to connecting with the Tenant Kyvos Manager during registration or update, you will see the corresponding details on your screen.

For example:

Editing/Updating tenant information

To edit or update information for a tenant:

  1. Click the edit icon corresponding to the tenant.

  2. In the Update dialog box, make the necessary changes.

  3. Click Update.

  4. Click the refresh icon corresponding to the tenant if the changes are not reflected.

Deregistering/Deleting tenant

To deregister a tenant:

  1. Click the cross icon corresponding to the tenant.

  2. Click Deregister.

Copyright Kyvos, Inc. All rights reserved.