Copy Create tenant
- Volodymyr Kartsev
- Renat Safiulin
Owned by Volodymyr Kartsev
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 |
|---|---|---|
| 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
- Go to Jenkins
- Navigate to Rancher → Update → create-tenant
- Click Build with Parameters (if you didn't see this button, contact Kitfox team)
- Select parameters
- rancher_cluster_name - Select name of the cluster where your rancher environment located
- rancher_project_name - Select name of target environment
- 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
- reference_tenant_id - Provide Id of a tenant used to extract list of installed modules. For Rancher environments it's usually diku
- tenant_id - Provide Id used for tenant creation
- tenant_name - Provide name used for tenant creation
- tenant_description - Provide description used for tenant creation
- admin_username - Provide admin user name for new tenant
- admin_password - Please, necessarily click Change Password option and provide password for admin user
- reindex_elastic_search - Turn on if search index should be created during provisioning
- load_reference - Turn on if reference data should be loaded during provisioning
- load_sample - Turn on if sample data should be loaded during provisioning
- deploy_ui - Turn on if you would like to provide UI access to the new tenant
- folio_repository - Select repository from which UI bundle should build for the new tenant (platform-complete or platform-core)
- folio_branch - Select branch from which UI bundle should build for the new tenant
- Click Build button
- Wait for completion
Job flow
Example
