Creating tenants in BMC Helix Platform


To use the same BMC Helix Platform for multiple BMC Helix Service Management instances, create the required number of tenants in BMC Helix Platform. For each BMC Helix Platform tenant, you can install BMC Helix Service Management and use BMC Helix Service Management in a multitenant environment.

Use the tctl utility to create BMC Helix Platform tenants.

Before you begin

To create a tenant

  1. Log in to the tctl utility.
    1. From the folder where you downloaded the tctl utlity, edit the config file and add the details according to your environment.
    2. From the directory where the config file is located, run the following command:

      tctl login
    3. On theBMC Helix Single Sign-On authentication page, enter the user name and password and authenticate.
      The user name is the admin and the default password is bmcAdm1n1#. This user is a local user in the tmsrealm realm, and is different from the BMC Helix Single Sign-On admin user. 
    4. Click Log in.
  2. Create the tenant.json file by using the following details as an example. This file is used to create the tenant. 

    {
    "name": "york",
    "email": "jsmith@bmc.com",
    "first_name": "John",
    "last_name": "Smith",
    "phone": "1234678",
    "environment": "dev",
    "domain": "york-private-small.bmc.com",
    "description": "York",
    "country": "United Kingdom",
    "login_id": "hannah_admin",
    "type": "LICENSE"
    }

    The following table describes the parameters:

    Parameter name

    Description

    name

    Name of the tenant.

    email

    Email ID of the administrator user of the tenant.

    first_name

    First name of the administrator user.

    last_name

    Last name of the administrator user.

    phone

    Contact number of the administrator user.

    environment

    Type of the environment.

    The value of this parameter depends on the kind of setup that you want to create, such as, dev, qa, or production.

    Important:

    • Do not use "prod" to indicate the production environment.
    • Do not use special characters.
    • The value of this parameter is not based on deployment size, such as,
      compact, small, medium, or large.

    domain

    The tenant domain.

    Important: Only small case letters, digits, and hyphen are valid values.

    description

    Description of the tenant.

    country

    Country where the tenant is located.

    login_id

    Login ID of the administrator user.

    type

    Type of the tenant.

    Valid values:

    • LICENSE
    • TRIAL
  3. Run the following command to create a new tenant:

    tctl create tenant -f tenant.json

    The email address specified in the JSON file receives the following emails:

    • An email for license activation
    • An email for setting the password for the initial user
  4. Activate the tenant by using link in the email.
  5. Verify the active services.
    1. To see the list of services that are activated on the new tenant, run the following command:

      tctl get tenant-service <tenant_id>    

      Expected output:

      get_tenant_service.png

    2. To activate a service on the new tenant, run the following command:

      tctl activate service <tenant_id> -i <service-id>

      For example, the following image shows the Discovery service activated for the new tenant:

      activate_service_discov.png


Where to go from here

Deploy-BMC-Helix-Service-Management-in-a-multitenant-BMC-Helix-Platform-environment

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*