/
Copy Create tenant

Copy Create tenant

Nov 23, 2023

This article describes how to create additional tenant for Rancher based project with ability to deploy UI for the tenant

The purpose of this job, is to give possibility for developers to use multi tenancy for Rancher based environments

Job: create-tenant

Parameters

Parameter

Type

Description

Parameter

Type

Description

refresh_parameters

boolean

Service parameter for parameters refreshing

rancher_cluster_name

list<string>

Name of cluster where project environment hosted

rancher_project_name

list<string>

Name of target environment where changes should be applied

install_list

text

(Optional) If you would like to install custom list of modules - provide it to the field below
For example: mod-search, mod-data-export, mod-organizations
If you would like to install all modules - ignore the option

reference_tenant_id

string

Id used to extract list of installed modules. For Rancher environments it's usually diku

tenant_id

string

Id used for tenant creation

tenant_name

string

Name used for tenant creation

tenant_description

string

Description used for tenant creation

admin_username

string

Tenant admin user name

admin_password

secure string

Tenant admin user password.
Please, necessarily provide password for admin user!

reindex_elastic_search

boolean

True if elasticsearch reindex needed

recreate_elastic_search_index

boolean

True if elasticsearch index should be recreated

load_reference

boolean

True if reference data should be loaded during provisioning

load_sample

boolean

True if sample data should be loaded during provisioning

deploy_ui

boolean

Turn on if you would like to provide UI access to new tenant

folio_repository

list<string>

Choose a repo type for UI bundle build that will be deployed for your new tenant

folio_branch

list<string>

Choose a branch name for UI bundle build that will be deployed for your new tenant

To create new tenant you should know in what cluster you environment located. See Projects(Namespaces) page.

 

Steps

  1. Go to Jenkins

  2. Navigate to Rancher → Update → create-tenant

  3. Click Build with Parameters (if you didn't see this button, contact Kitfox team)

  4. Select parameters

    1. rancher_cluster_name - Select name of the cluster where your rancher environment located

    2. rancher_project_name - Select name of target environment

    3. install_list - (Optional) If you would like to install custom list of modules - provide it to the field below. For example: mod-search, mod-data-export, mod-organizations. If you would like to install all modules - ingnore the option 

    4. reference_tenant_id - Provide Id of a tenant used to extract list of installed modules. For Rancher environments it's usually diku

    5. tenant_id - Provide Id used for tenant creation

    6. tenant_name - Provide name used for tenant creation

    7. tenant_description - Provide description used for tenant creation

    8. admin_username - Provide admin user name for new tenant

    9. admin_password - Please, necessarily click Change Password option and provide password for admin user

    10. reindex_elastic_search - Turn on if search index should be created during provisioning

    11. load_reference - Turn on if reference data should be loaded during provisioning

    12. load_sample - Turn on if sample data should be loaded during provisioning

    13. deploy_ui - Turn on if you would like to provide UI access to the new tenant

    14. folio_repository - Select repository from which UI bundle should build for the new tenant (platform-complete or platform-core)

    15. folio_branch - Select branch from which UI bundle should build for the new tenant

  5. Click Build button

  6. Wait for completion

Job flow

Example