This article describes how to deploy and enable modules from install json formatted list
The purpose of this job, is to give possibility for developers to update deploy a set of modules
Job: backend-modules-deploydeployModulesFromJson
Parameters
refresh_parameters | boolean | Service parameter for parameters refreshing |
rancher_cluster_name | CLUSTER | list<string> | Name of cluster where project environment hosted |
rancher_project_nameNAMESPACE | list<string> | Name of target environment where changes should be applied |
configtypeTYPE | list<string> | Config for module deployment (cpu, memory, replica count, etc) |
install_json | text | Json formatted install list of modules |
enable_modules | boolean | True if module should be registered in okapi, false if only deploy without registration |
tenant_id | DEFAULT_TENANT_ID | string | Tenant id where module should be installed |
adminusernamestring | Tenant admin user name | admin_password | secure string | Tenant admin user password |
load_reference | boolean | True if reference data should be loaded during provisioning |
load_sample | boolean | True if sample data should be loaded during provisioning |
reinstall | boolean | True if force reinstall needed |
reindex_elastic_search | boolean | True if elasticsearch reindex needed |
recreate_elastic_search_index | boolean | True if elasticsearch index should be recreatedtext | Json formatted install list of modules |
LOAD_REFERENCE | boolean | Set to true to load reference data during install |
LOAD_SAMPLE | boolean | Set to true to load sample data during install |
SIMULATE | boolean | Set to true to simulate installation before install |
REINSTALL | boolean | Set to true to re-enable modules during install |
IGNORE_ERRORS | boolean | Set to true to ignore errors during install |
Steps
- Go to Jenkins
- Navigate to Rancher → Update → backend-modules-deploy folioRancher -> folioDevTools -> moduleDeployment -> deployModulesFromJson
- Click Build with Parameters (if you didn't see this button, contact Kitfox team)
- Select parameters
- rancher_cluster_name CLUSTER - Select name of the cluster where your rancher environment located
- rancher_project_name NAMESPACE - Select name of target environment where module should be deployed
- configCONFIG_type TYPE - If needed select deployment config type
- install_json - Type/Paste json formatted install list of modules
- enable_modules - Set to true if module should be registered, to false if module should be only deployed without registration in okapi
tenant_id - DEFAULT_TENANT_ID - Set tenant id where module should be registered
- adminINSTALL_username - Set tenant admin username
- admin_password - Set tenant admin password
- load_reference JSON - Type/Paste json formatted install list of modules
- LOAD_REFERENCE - Set to true if reference data needed
- loadLOAD_sample SAMPLE - Set to true if sample data neededreinstall
- SIMULATE - Set to true to simulate installation before install
- REINSTALL - Set to true if module should be reinstall (if same version already registered in okapi)
- reindexIGNORE_elastic_search ERRORS - Set to true if elasticsearch reindex neededrecreate_elastic_search_index - Set to true if elasitcsearch index should be recreatedto ignore errors during install
- Click Build button
- Wait for completion
Job flow
Drawio |
---|
border | true |
---|
| |
---|
diagramName | backend-modules-deploy |
---|
simpleViewer | false |
---|
width | |
---|
links | auto |
---|
tbstyle | top |
---|
lbox | true |
---|
diagramWidth | 634 |
---|
revision | 2 |
---|
|
Example