[Deprecated] Deploy/Update backend/edge/okapi module from feature branch

[Deprecated] Deploy/Update backend/edge/okapi module from feature branch

This article describes how to build and deploy backend/edge/okapi from a development feature branch

The purpose of this job is to allow developers to deploy and test their changes in a complete environment before merging to the mainline branch.

Job: feature-backend-module-deploy

Parameters

Parameter

Type

Description

Parameter

Type

Description

refresh_parameters

boolean

Service parameter for parameters refreshing

agent

list<string>

Java agent required for module 

backend_module

list<string>

Name of the module to build

folio_branch

list<string>

Name of module feature branch to build

mvn_options

string

Mvn options for build (if needed)

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)

enable_modules

boolean

True if the module should be registered in okapi, false if only deployed without registration

tenant_id

string

Tenant ID where the 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 the elastic search reindex needed

recreate_elastic_search_index

boolean

True if the elastic search index should be recreated

enable_rw_split (Optional)

boolean

Set true to Enable Read/Write split

Steps

  1. Go to Jenkins

  2. Navigate to Rancher → Update → feature-backend-module-deploy

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

  4. Select parameters

    1. agent - Select an agent with the proper Java version required by the module

    2. backend_module - Select module to build and deploy

    3. folio_branch - Select the feature branch to build

    4. mvn_options - Type additional mvn options if needed

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

    6. rancher_project_name - Select the name of the target environment where the module should be deployed

    7. config_type - If needed select deployment config type

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

    9. tenant_id - Set tenant id where the module should be registered

    10. admin_username - Set tenant admin username

    11. admin_password - Set tenant admin password

    12. load_reference - Set to true if reference data needed

    13. load_sample - Set to true if sample data needed

    14. reinstall - Set to true if the module should be reinstalled (if the same version is already registered in okapi)

    15. reindex_elastic_search - Set to true if elastic search reindex needed

    16. recreate_elastic_search_index - Set to true if elastic search index should be recreated

    17. enable_rw_split - Set true to Enable Read/Write split

  5. Click Build button

  6. Wait for completion

Job flow

Example