Skip to end of banner
Go to start of banner

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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

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

refresh_parametersbooleanService parameter for parameters refreshing
agentlist<string>Java agent required for module 
backend_modulelist<string>Name of the module to build
folio_branchlist<string>Name of module feature branch to build
mvn_optionsstringMvn options for build (if needed)
rancher_cluster_namelist<string>Name of cluster where project environment hosted
rancher_project_namelist<string>Name of target environment where changes should be applied
config_typelist<string>Config for module deployment (CPU, memory, replica count, etc)
enable_modulesboolean

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

tenant_idstringTenant ID where the module should be installed
admin_usernamestringTenant admin user name
admin_passwordsecure stringTenant admin user password
load_referencebooleanTrue if reference data should be loaded during provisioning
load_samplebooleanTrue if sample data should be loaded during provisioning
reinstallbooleanTrue if force reinstall needed
reindex_elastic_searchbooleanTrue if the elastic search reindex needed
recreate_elastic_search_indexbooleanTrue if the elastic search index should be recreated
(Optional)
booleanSet 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
  5. Click Build button
  6. Wait for completion

Job flow

Example

Example

  • No labels