Upgrade from v8.5.x to v9.4.x
Overview
This guide describes the steps for in-place SPA upgrade from 8.5.x to 9.4.x. During the upgrade procedure, the installer:
- Creates a backup of the current config files.
- Replaces them with the new versions.
- Overrides values in new files with those from the old installation.
caution
Do not change passwords when performing this upgrade. Use the same passwords from your SPA 8.5 installation. Otherwise, upgrade will fail. Changing passwords is supported after upgrading to SPA 9.4.
Do not use dots "." in paths.
Prerequisites
- WorkFusion SPA 8.5.x is installed on RHEL 7.
- WorkFusion SPA 9.4.x product install packages are downloaded and extracted to
<PACKAGE_DIR>on all servers. s3_hostnameadded as additional A or CNAME record for APP server.- APP server's TLS certificate must be valid for
app_hostnameands3_hostname(either wildcard or SAN). - Prepare Business Processes to upgrade migration notes.
Predefined common variables (set your own values in config.yml before
installation):
- WorkFusion user. Default is
wfuser. - WorkFusion Home Directory. Default is
/opt/workfusion. - WorkFusion Installer Directory. Default is
/opt/workfusion/wf_installer.
Available servers:
- apm: APM server
- app: APP server
- db: DB server
- ocr: OCR server
- vds-master: AutoML Master server
- vds-slave: AutoML Agent server
Preparation steps
Ensure that DNS names for servers are configured according to the DNS name configuration section.
The following DNS names are not required and can be removed:
crowdcontrol.taglib.db.example.com
cv-help.db.example.com
doc-upload.db.example.com
logos.crowdcomputing.db.example.com
public.crowdcontrol.db.example.com
recorder-images.db.example.com
secdocs.db.example.com
tinymce-resources.db.example.com
vds-models.db.example.com
vds-resources.db.example.com
workfusion-resources.db.example.com
workfusiondevelopment.db.example.com
workspace-resources.db.example.com
Stop all processes on all servers.
SSH into
<SERVER_ROLE>server.Run as:
wfmanager stop allCopy certificates and configs into the 9.4
<PACKAGE_DIR>. The old certificates, secrets and config files can be reused from previous installation. They can be found in/distr/2018-04-28-1524913731/.Run as
<WF_USER>on all servers:cd <PACKAGE_DIR> cp -r <INSTALL_DIR>/distr/2018-04-28-1524913731/certificates . cp <INSTALL_DIR>/distr/2018-04-28-1524913731/config.yml ./config_overrides.yml cp <INSTALL_DIR>/distr/2018-04-28-1524913731/secrets.yml ./secrets_overrides.ymlTurn off passwords verification checks. Starting from 9.1, we introduced verification for passwords complexity on the precheck phase:
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: "$", "&".
The passwords verification may cause failures during the upgrade. Passwords from the previous installation will be used during the upgrade, and they might not satisfy new password requirements.
cd <PACKAGE_DIR> echo "passwords_check: false" >> ./config_overrides.ymlAdd
s3_hostnameinto config file:cd <PACKAGE_DIR> echo "s3_hostname: app-s3.hostname" >> ./config_overrides.ymlCopy the license file. The license file should be copied to APP Server only.
Run as
<WF_USER>:cp <INSTALL_DIR>/license.properties .
Upgrade order
The upgrade order is as follows:
- DB Server
- APP Server
- Other servers (can be updated in parallel)
Upgrade steps
Go to WorkFusion Installer Directory:
cd <PACKAGE_DIR>
DB, APP, APM, OCR servers
Perform Precheck and Preinstall operations.
Run as
root:./install.sh precheck <SERVER_ROLE> -e @config_overrides.yml -e @secrets_overrides.yml ./install.sh preinstall <SERVER_ROLE> -e @config_overrides.yml -e @secrets_overrides.ymlPerform Installation and Post-install Check operations.
./install.sh install <SERVER_ROLE> -e @config_overrides.yml -e @secrets_overrides.yml ./install.sh check <SERVER_ROLE> -e @config_overrides.yml -e @secrets_overrides.yml
AutoML-Master Server
Perform Precheck and Preinstall operations.
Run as
root:./install.sh precheck vds-master -e @config_overrides.yml -e @secrets_overrides.yml -e ''{\'vds_update_zookeeper_config\':false}'' ./install.sh preinstall vds-master -e @config_overrides.yml -e @secrets_overrides.yml -e ''{\'vds_update_zookeeper_config\':false}''Perform Installation and Post-install Check operations.
./install.sh install vds-master -e @config_overrides.yml -e @secrets_overrides.yml -e ''{\'vds_update_zookeeper_config\':false}'' ./install.sh check vds-master -e @config_overrides.yml -e @secrets_overrides.yml -e ''{\'vds_update_zookeeper_config\':false}''
AutoML-Agent Server
Perform Precheck and Preinstall operations.
Run as
root:./install.sh precheck vds-slave -e @config_overrides.yml -e @secrets_overrides.yml ./install.sh preinstall vds-slave -e @config_overrides.yml -e @secrets_overrides.ymlPerform Installation and Post-install Check operations.
./install.sh install vds-slave -e @config_overrides.yml -e @secrets_overrides.yml ./install.sh check vds-slave -e @config_overrides.yml -e @secrets_overrides.yml
After upgrade to 9.4, the default workfusion password is changed to wf_password from secrets.yml.
Post-upgrade steps
You can review difference between old configuration files and new in changes log: /distr/latest/diff_changes_.log
note
If Riak was used as an S3 storage, you'll need to perform data migration from Riak to Minio in accordance with the MinIO upgrade and migration guide since Riak was deprecated and replaced by Minio starting from SPA 9.0.4 version.
Follow the steps from the Post-installation guide to make sure the environment works properly.