hosts.yml options
The hosts.yml config file is located in the installation package and contains parameters of servers' hostnames. The file is to be completed before product installation.
# Your hostnames for installation
mssql_hostname:
app_hostnames:
int_hostnames:
bep_master_hostnames:
bep_agent_hostnames:
ocr_hostnames:
rpa_hostnames:
bi_hostnames:
# Mandatory DNS aliases
vault_lb_hostname:
minio_lb_hostname:
nexus_lb_hostname:
rabbitmq_lb_hostname:
mesos_lb_hostname:
marathon_lb_hostname:
workspace_lb_hostname:
workfusion_lb_hostname:
bot_manager_lb_hostname:
kibana_lb_hostname:
ocr_lb_hostname:
bi_lb_hostname:
# Deprecated settings
# Windows-based OCR is not supported for new installations. So, keep 'ocrwin_hostnames' setting empty if you're performing clean install.
# This setting exists for backward compatibility. If you're performing upgrade from lower product version, and already have windows-based OCR server(s).
ocrwin_hostnames:
# HOW TO FILL THIS FILE?
# - Don't uncomment any commented lines in this file (the lines which start with "#")
# - Don't comment any uncommented lines in this file
# - Provide DNS names for Workfusion IA Cloud Enterprise servers in the format 'hostname: server-name.example.com'
# - At least one space should be present between each 'key: value'
# - You cannot specify IP addresses instead of hostnames because the hostnames will be used in config files and must meet certificates' requirements
# - The specified servers must be up and running and satisfy system requirements per product documentation
# - The provided hostnames must be resolvable from within each server of the environment
#
# If you don't plan to use funtionality of some server(s) keep the respective hostname value(s) EMPTY.
# Mandatorily you must specify: mssql_hostname, int_hostnames, bep_master_hostnames, bep_agent_hostnames, app_hostnames.
# This list of components provides core product functionality for business-processes execution.
#
# In most cases you need to also specify: rpa_hostnames, bi_hostnames, and (ocr_hostnames OR ocrwin_hostnames). It is recommended to use linux-based OCR.
# If you don't plan to use OCR, RPA, or BI functionality (i.e. for some demo setup) you need to keep the respective hostnames empty.
# Don't comment the lines, and don't provide the dummy values, don't remove the colon sign (":") from the end of line.
#
# The format of filling the settings for HA (high availability) mode and non-HA mode is similar,
# with the difference in the number of servers specified.
# Example configuration for non-HA environment (you should set "ha_mode: False" in config.yml):
#
# mssql_hostname: mssql.example.com
# int_hostnames: app1.example.com
# bep_master_hostnames: app1.example.com
# app_hostnames: app1.example.com
# bep_agent_hostnames: bepagent1.example.com,bepagent2.example.com,bepagent3.example.com
# ocr_hostnames: ocr1.example.com,ocr2.example.com,ocr3.example.com
# ocrwin_hostnames:
# bi_hostnames: bi1.example.com
# rpa_hostnames: rpa1.example.com,rpa2.example.com,rpa3.example.com
#
# Notes:
# - For non-HA mode we use the same hostname value for int_hostnames, bep_master_hostnames, and app_hostnames - "app1.example.com"
# - This means that we're planning to install "integration server components", "bep-master server components", and "application server components" into single server - app1.example.com.
# - In fact, from installer perspective each "hostname" option here represents some set of "software components", and for the "value" field we specify where we want to install this "set of components".
# - Though we specified multiple servers for "bep_agent_hostnames", "ocr_hostnames", "rpa_hostnames" this doesn't mean high-availability mode.
# - Bep Agents, RPA, and OCR servers are scalable horizontally, and can be specified with multiple hosts in either HA, or non-HA installation mode, depending on desired performance of the platform.
# - Bep Agents, RPA, and OCR servers can also be added after product installation if at some point of time you need to increase product performance.
# - "mssql_hostname" here may represent either hostname of your standalone MS SQL server, or endpoint of your MS SQL Always On Cluster. It should be single DNS name.
# Example configuration for HA environment (you should set "ha_mode: True" in config.yml):
#
# mssql_hostname: mssql.example.com
# int_hostnames: int1.example.com,int2.example.com,int3.example.com
# bep_master_hostnames: bepmaster1.example.com,bepmaster2.example.com,bepmaster3.example.com
# app_hostnames: app1.example.com,app2.example.com
# bep_agent_hostnames: bepagent1.example.com,bepagent2.example.com,bepagent3.example.com
# ocr_hostnames: ocr1.example.com,ocr2.example.com,ocr3.example.com
# ocrwin_hostnames:
# bi_hostnames: bi1.example.com,bi2.example.com
# rpa_hostnames: rpa1.example.com,rpa2.example.com,rpa3.example.com
#
# Notes:
# - For HA mode it is mandatory to have
# - exactly 3 integration servers (int_hostnames);
# - exactly 3 bep-master servers (bep_master_hostnames);
# - exactly 2 application servers (app_hostnames);
# - exactly 2 BI servers (bi_hostnames);
# - Most of INT, BEPMASTER, and APP product components will be working in active/standby mode which means that only one running SERIVICE on any of the SERVERS at any given time handles requests.
# - The purpose of HA mode is to ensure that standby services get up and running automaticcally in case of crush of leader service, crush of entire server, or network hardware.
# - Despite the fact that there are more servers, HA mode doesn't increase product performance comparing with non-HA mode.
# - To increase product performance you need to scale BEP AGENTS, RPA, or OCR (depending on the types of tasks you want to accelerate).
# - You cannot specify the same DNS name for any of servers.
# !IMPORTANT
# You need to provide 12 additional DNS names.
# For HA mode: all below DNS names must be assigned to IP address of external load balancer located in your infrastructure.
# For non-HA mode: all below DNS names must be assigned to IP address of APP server (which means APP server's IP address should be accessible with 13 separate DNS names).
# You may use either "CNAME" or "A" DNS record types, or you may specify all DNS names in hosts files on each server of the environment (including windows hosts).
# ALL below DNS names MUST be DIFFERENT (must differ from each other and must differ from DNS names provided above for servers)
# They are required for correct traffic balancing and routing based on the values of "Host" HTTP header in requests.
# Example (will be the same for HA and non-HA modes with the difference of which IP address is behind the provided hostname):
#
# vault_lb_hostname: vault.example.com
# minio_lb_hostname: minio.example.com
# nexus_lb_hostname: nexus.example.com
# rabbitmq_lb_hostname: rabbitmq.example.com
# mesos_lb_hostname: mesos.example.com
# marathon_lb_hostname: marathon.example.com
# workspace_lb_hostname: workspace.example.com
# workfusion_lb_hostname: workfusion.example.com
# bot_manager_lb_hostname: bot-manager.example.com
# kibana_lb_hostname: kibana.example.com
# ocr_lb_hostname: ocr.example.com
# bi_lb_hostname: bi.example.com
# The settings below are for internal usage only. Do not edit, remove, or comment them. Do not specify any values.
lb_hostname:
keycloak_lb_hostname: