/
Copy Deploy/Update modules

Copy Deploy/Update modules

Nov 23, 2023

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 a set of modules

Job: backend-modules-deploy

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

config_type

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

string

Tenant id where module should be installed

admin_username

string

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 recreated

Steps

  1. Go to Jenkins

  2. Navigate to Rancher → Update → backend-modules-deploy

  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 where module should be deployed

    3. config_type - If needed select deployment config type

    4. install_json - Type/Paste json formatted install list of modules

    5. enable_modules - Set to true if module should be registered, to false if module should be only deployed without registration in okapi

    6. tenant_id - Set tenant id where module should be registered

    7. admin_username - Set tenant admin username

    8. admin_password - Set tenant admin password

    9. load_reference - Set to true if reference data needed

    10. load_sample - Set to true if sample data needed

    11. reinstall - Set to true if module should be reinstall (if same version already registered in okapi)

    12. reindex_elastic_search - Set to true if elasticsearch reindex needed

    13. recreate_elastic_search_index - Set to true if elasitcsearch index should be recreated

  5. Click Build button

  6. Wait for completion

Job flow

Example