Skip to main content
Skip table of contents

Upgrade VeridiumID from 3.x to 3.4

This document will provide a step by step procedure to upgrade to VeridiumID 3.4.

The procedure will provide information regarding both update methods:

  • using a configured YUM repository

  • using local packages

The update is done without downtime, one node at a time. Please start with WEBAPP nodes and after that do the installation on PERSISTENCE nodes. In order to have no impact, please take out from the balancer the node on which install is running.
WEBAPP node is a server where websecadmin is installed, PERSISTENCE node is a server where cassandra is installed.

The application 3.x is compatible with 3.4 database schema.

Summary:

1) Download packages

2) Pre-requirements

3) Start Update

4) Post update steps

5) Other referrences

1) Download packages

For update procedure, with local packages, please download only “VeridiumID Update packages” archive containing all RPMs.

Package URL

MD5

SHA1

Description

Update Packages Archive

1e24961b1adbe6bb86689da9f41071f7

6fad303613e4a72787629c67198f50a0592aa911

VeridiumID Update packages archive containing all RPMs, for local update procedure

For Update using a YUM repository, please download all packages and make them available within your own local repository

Package URL

MD5

SHA1

Description

WebsecAdmin

01d5957ed9af6701a7975525311c2ae9

8e630bc0394bc010b5586fc59d14a40c55edba17

VeridiumID Admin Dashboard

Migration

c15b44b2bdd78e740c2f239f03215106

9272eed692c2144bc458c21cdadf683d8bd112a5

VeridiumID migration tool

Websec

194e1d4c167a95e025fafc5acee09b75

31e6109dbe933bc3132e07a5c7af443442eec3a1

VeridiumID Websec

AdService

0a5e324c238dfd9e85052d140a164560

bed2aadc9d9e91d6cfb3b25ad4d1763ba7603a58

VeridiumID Directory Service component

DMZ

8980e883c72e49674ca46e60831bc417

40d1847536989f9b4424fec5b91dd1623bfee590

VeridiumID DMZ service

Data Retention

67f19838b2e7a6c37f3baa01787ae931

1b0d4ecfe8057c7e14bd05c651de2ed508dbcada

VeridiumID Data Retention service

Fido

586ff98765bf31e5908583b3d61c147c

c7a50df39c6307352ea1882ba57bdf9eecec09e0

VeridiumID Fido service

Notifications

0307e0d1a47d01e422f1ea104ff6ae20

b5ddea8d11b8ef2550eaeb7ef90709e3045a142b

VeridiumID Notifications service

OPA

dc274f4c9d54e7f1b6359e68d50e112d

955512af1e13429316e4ab10a179822509db7ed7

VeridiumID Open Policy Agent

Elasticsearch

5243a19dcd0bb8ef97645604f6076d0a

8239058d12fbb07ff23e8fbd184b7464edaead9f

VeridiumID Elasticsearch

Zookeeper

4796bd26c31dca6a7f57ba69556cc49c

55f6ef85365ebb9dc825e6b1908d2e56f2a787e3

VeridiumID Zookeeper

Cassandra

6947733b40d5a8a4d2a4b2ef7f6698f2

092a6a5c65be12c7fda326830e97b017138c0192

VeridiumID Cassandra

Haproxy

5ad386c18491a0a410677a0a99ab9d23

03d8e83f78183ed8ebca4eb69044b956d38f66a0

VeridiumID Haproxy

Statistics

ff5531636bc84a584cf8bdb54994d7b8

80415b56ea258dd08956e4c21c1c387e59250a4b

VeridiumID Statistics services

SelfServicePortal

5af15881be4c87c0924f1bc0ed37009a

4055a686ad3f6851d5a1881a7a440d340b5c9084

VeridiumID Self Service Portal

Shibboleth

2b3b62dcd840d0a5e9a4c76ded538686

a15a31333a58fae8e5d8c4ebd1f53f6c9c38982e

VeridiumID Shibboleth Identity Provider

Tomcat

3e0bb7da02e04e18e048217d8f7cdc44

873eac33ce82155aaedf88fd499f8685c39f9f09

VeridiumID Tomcat

Freeradius

86425b4e65e45a2a3910e5e8bdef3035

a50b654b2ecf21d0ccddd89a20ec8850ac65ca14

VeridiumID FreeRadius

4F

f95449b6987da2135d5d6b758522425f

3470047f35ee718b75a090a4c32292d653e228bb

VeridiumID 4F biometric library

VFace

8ca4b625a31fda8c10667ad01b987ab2

31864b55e69ced22cab4d9a887a71af22dc9f96a

VeridiumID VFace biometric library

Python

3ef5a7527f3dd9c9fa49ad3e15656fd3

3072f88a483a4801702a973ee36eb19274187beb

Python RPM

Update procedure RPM

95f0f6827680acfcf416fcc8efe4a0e8

ffb203e7463668914de5718c2e6fc2a151e50b09

Update scripts

2) Pre-requirements

2.1) (MANDATORY) User requirements

We recommend using any user with sudo rights or root directly.

Python 3 must be installed. To check if you have a working Python 3 version run the following command:

CODE
python3 --version

If Python 3 is not installed, please see section 5.1 - How to install python 3

2.2) (OPTIONAL) Cassandra Backup

By default, the database backup procedure is scheduled on Saturday mornings at 04:00 AM. Please check under /opt/veridiumid/backup/cassandra directory on persistence layer nodes to see when the last successfull backup was executed.

CODE
ls -l /opt/veridiumid/backup/cassandra

If you wish to perform an additional backup of the Cassandra database, run the following script on persistence layer nodes as any user that has sudo rights or directly as root:

CODE
bash /opt/veridiumid/backup/cassandra/cassandra_backup.sh \
-c=/opt/veridiumid/backup/cassandra/cassandra_backup.conf

3) Start Update

The commands must be executed on ALL machines sequentially, first on WEBAPP and after that on PERSISTENCE, in order to update your VeridiumID platform to the latest 3.4 version.

Please execute all commands as root.

3.1) Update using a YUM repository

Please execute steps 3.1.1 on all servers in parallel. Please execute steps 3.1.2 and 3.1.3 on each server, one at a time, starting with WEBAPP and after that PERISTENCE. After 3.1.3, the server will be updated to desired version.

3.1.1) Install the necessary Update procedure on ALL machines

CODE
yum clean metadata
yum install -y veridiumid_update_procedure-8.1.18

The next steps will all be done from within the /etc/veridiumid/update-procedure/current/ directory.

CODE
cd /etc/veridiumid/update-procedure/current/

3.1.2) Run preUpdateSteps.py

Run the following command to stop the services on one node.

CODE
python3 preUpdateSteps.py --version 8.1.18 --use-repo

There might be ERROR messages in the output of the script but as long as the script does not stop its execution, it means that it’s not a stopping event.

3.1.3) Run startUpdate.py

Run the following command to install services on that specific node.

CODE
python3 startUpdate.py --version 8.1.18 --use-repo

There might be ERROR messages in the output of the script but as long as the script does not stop its execution, it means that it’s not a stopping event.

3.2) Update using local packages

Please execute steps 3.2.1 and 3.2.2 on all servers in parallel. Please execute steps 3.2.3 and 3.2.4 on each server, one at a time, starting with WEBAPP and after that PERISTENCE. After 3.2.4, the server will be updated to desired version.

3.2.1) Download the necessary Update packages on all nodes

To download the latest veridiumid-update-packages.zip, use the following link.

We recommend downloading to veridiumid’s HOME folder. As such, all the examples will feature this folder. If you wish to use another location, please avoid using /tmp/.

After downloading the veridiumid-update-packages-8.1.18.zip archive, you can run the following command to access its contents. This will create a directory called update-34 and another named packages inside of it:

CODE
cd /home/veridiumid
unzip veridiumid-update-packages-8.1.18.zip -d update-34

3.2.2) Install Update procedure on all nodes (no downtime while this package is installing)

CODE
cd update-34/packages/
yum localinstall -y veridiumid_update_procedure-8.1.18-20230728.x86_64.rpm
cd /etc/veridiumid/update-procedure/current/

3.2.3) Run preUpdateSteps.py

Run the following command to stop the services on one node.

CODE
python3 preUpdateSteps.py --version 8.1.18 \
--rpm-path /home/veridiumid/update-34/packages

There might be ERROR messages in the output of the script but as long as the script does not stop its execution, it means that it’s not a stopping event.
Use the –rpm-path parameter to define where the RPMs have been copied locally, for example: /home/veridiumid/update-34/packages/

3.2.4) Run startUpdate.py

Run the following command to install services on that specific node.

CODE
python3 startUpdate.py --version 8.1.18 \
--rpm-path /home/veridiumid/update-34/packages

There might be ERROR messages in the output of the script but as long as the script does not stop its execution, it means that it’s not a stopping event.
Use the –rpm-path parameter to define where the RPMs have been copied locally, for example: /home/veridiumid/update-34/packages/

3.3) Check the status of the VeridiumID Services

In order to check the status of the VeridiumID Services, you can run the following command. All services needs to have status Started.

CODE
bash /etc/veridiumid/check_services.sh

4) Post update steps

5) Other referrences.

5.1) How to install python 3

In order to run the update procedure all nodes must have Python 3 installed or the alternative provided by VeridiumID.

To check if the VeridiumID Python 3 package (this is optional) is present use the following command as root:

CODE
yum list installed veridiumid_python

If not installed please use the RPM from the following link.

To install the RPM run the following command as root:

CODE
# if using YUM repository:
yum -y install veridiumid_python

# or, if using local package:
yum localinstall -y veridiumid_python-3.6.8-20230728.x86_64.rpm

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.