Edit

Installation package and config files

Installation package contents

After the workfusion-full-release-flat-.tar.gz package is unpacked on the Linux server, you'll see the following file structure:

  workfusion-full-release-flat-<version>/
    config.yml                 ## main config file
    secrets.yml                ## config file for sensitive values, like usernames/passwords and SSL certificate details
    install.sh                 ## main installation script. Use it to install or update Workfusion Software components.
    generate-certificates.sh   ## helper script for generating self-signed certificates
    wf-backup.sh               ## Backup script that can be used for cold backup/restore of WorkFusion data and configs
    
    certificates/              ## directory for SSL certificates. Before installation you should place your certificate here or generate them using generate-certificates.sh script.
    sources/                   ## files used in the installation - workfusion artifacts and related software
    manifest.yml               ## manifest file describing the contents of `sources/`. Should not be modified by the end user.

    roles/                     ## Ansible roles and playbooks which power this installer. Should not be modified by the end user.
    generate-certificates.yml  ## The file is pre-built and should not be modified by the end user
    playbook.yml               ## The file is pre-built and should not be modified by the end user
    backup.yml                 ## The file is pre-built and should not be modified by the end user

The complete configuration consists of two files:

• config.yml

  The configuration file defines server hostnames, service ports, runtime user, home directory, execution parameters, and change some other options. The configuration file is thoroughly commented to explain each of the parameters. The most important parameters are described below, and you will also find server-specific configuration explained in the relevant sections.

• secrets.yml

  This configuration file serves to store any sensitive data, such as database credentials, path to license file, paths to TLS certificates, and so on.

The files contain simple key-value pairs, so they are comprehensive and easy to edit.

Configure parameters in config.yml

important

The configuration file is filled in once during the preparation to the DB Server installation and used for all other servers, except VDS Slave.

The config.yml configuration file contains a few common parameters shared by all servers, for example:

• wf_user: runtime user for all software

• install_dir: installation directory

• server host names

While wf_user and install_dir already have reasonable defaults, the hostnames must be defined by the end user.

note

config.yml has additional comments alongside these parameters.

Name	Description	Default
install_dir	Global path where all packages are installed. The installation directory must not contain the dot character (.) due to limitations of the UIMA library! For example, the following path cannot be processed correctly: /opt/worfusion-8.5.0 The path must be defined. Make sure that the path defined is correct.	/opt/workfusion
automate_system_packages_install	Install required packages at the preinstall phase. The value should be set to true. Do not change the value unless the installation is performed without access to the packages repository, for example, these components have already been installed.	true
https_enabled	Enable the connection over HTTPS. Affects all components.	true
wf_s3_backend	The value has two possible options to choose the S3 backend: minio or riak. Riak is unsupported, and MinIO is significantly better in terms of speed, reliability, and it is a currently supported product. Since 9.1, the default S3 object storage server is MinIO.	minio
rpa_manager_nodes	Define RPA Nodes, as well as the node host (hostname), port (port on which RPA will listen to), and count. This option is available in secrets.yml.	rpa_manager_nodes: - { host: "rpa-hub.example.com", port: "443", count: "2" }
rpa_manager_client_authorization	App Server Port-install check. Depends on whether RPA Manager is configured in the non-SSL mode or SSL mode. By default, it expects the SSL mode (true).	rpa_manager_client_authorization: true
ocr_platform	OCR platform selection. Two options available: Windows or Linux. These values are mutually exclusive: you have to define only Linux or Windows OCR platform value before installation. Both platforms running simultaneously are not supported at the moment.	Linux
log_level_type	Enables changing the log level for WorkFusion components logs. Possible values are prod or dev.	prod

Name	Description	Example
apm_hostname	DNS name of APM server.	apm.server.com
app_hostname	DNS name of WorkFusion host.	wf1.server.com
db_hostname	DNS name of database server.	db1.server.com
ocr_hostname	DNS name of OCR server.	ocr1.server.com
vds_master_hostname	DNS name of VDS master server.	ml1.server.com
vds_slave_hostname	DNS name of the VDS slave server. If you use clustered VDS, there can be multiple slaves. So, you will need to override this for each of them. See the installation guide for details. If using standalone VDS, set this to the same value as vds_master_hostname.	ml2.server.com
vds_nfs_hostname	Server where the NFS share for AutoML is created. In most installations, leave the default setting.
s3_hostname	Provide an additional DNS name for the APP server. !IMPORTANT: this must be a separate EXISTING DNS name assigned to the APP server. The APP server's certificate must be valid for both app_hostname and s3_hostname (either wildcard or SAN).
bi_hostname	DNS name of the BI server.	bi.server.com

If one server has a few host roles, the server must have all domain names that match the host roles it performs.

All domain names must be specified in the config.yml configuration file.

Precautions

• Make sure to use the same wf_user on all servers.
• Don't change wf_user and install_dir when upgrading an exisiting installation.

Configure parameters in secrets.yml

Note the following password policy rules for secrets.yml:

• In passwords, English alphabetical characters must be used.
• Passwords must contain 6-20 characters.
• Passwords must contain at least one capital letter [A-Z].
• Passwords must contain at least one number [0-9].
• Passwords must contain at least one of the following special symbols unless limitations are explicitly described in comments: "!", "*", "#", "%", "^", "@".
• Passwords must not contain the following symbols: "$", "&".

In secrets.yml, edit the following parameters:

Name	Description	Default
s3_access_key	Access key for S3 server.	-
s3_secret_key	Secret key for S3 server.	-
marathon_web_user	Marathon is protected by the HTTP authentication mechanism. Change this options to replace the default user (recommended).	marathon
marathon_web_password	Marathon is protected by the HTTP authentication mechanism. Change this option to replace the default password (recommended).	Pt1mdbw#jG
mesos_web_user	Mesos is protected by the HTTP authentication mechanism. Change this option to replace the default user (recommended).	mesos
mesos_web_password	Mesos is protected by the HTTP authentication mechanism. Change this option to replace the default password (recommended).	JLUm7xsuS!
wf_username	Default username for Control Tower.	workfusion
wf_password	Default password bcrypt hash for Control Tower.	ldT#!E3vHp