.. _upgrade_multinode_ISO:

.. rst-class:: chapter-with-expand

Unified Node Topology: Upgrade a Multinode Environment with the ISO and Template
-----------------------------------------------------------------------------------

.. index:: cluster;cluster check
.. index:: cluster;cluster upgrade
.. index:: screen
.. index:: database;database convert_drive
.. index:: app; app cleanup

.. _19.1.1|EKB-1249:
.. _19.1.2|EKB-2262:
.. _19.2.1|EKB-2636:
.. _19.2.1|VOSS-497|EKB-3126:
.. _20.1.1|VOSS-661:    
.. _20.1.1|VOSS-661|EKB-4836:    
.. _20.1.1|EKB-5552:    
.. _20.1.1|VOSS-724|EKB-4923:
.. _20.1.1|EKB-6669:    

    
    
.. note::    

  * When upgrading from VOSS-4-UC 18.1.3, refer to :ref:`upgrade-18.1.3-to-current`.
  * Upgrading to release 21.1 *requires a system on 19.x, with security updates completed*.
    The upgrade includes:
   
    * an upgrade to the underlying operating system to Ubuntu 18.04.4.
    * the installation of a new **cluster check**
      command available from the 21.1 ISO by running 
      **app install check_cluster**.
    
  * While template installation and system upgrade takes approximately two hours
    at a single site, this may vary in accordance with your topology, number of
    devices and subscribers. Adjust your upgrade maintenance window
    to allow for your configuration.
    
    You can follow the progress on the Admin Portal transaction list.
  * When upgrading from CUCDM 11.5.3 Patch Bundle 2 or VOSS-4-UC 18.1 Patch Bundle 2
    and earlier, re-import specified CUC models according to your current version.
    Refer to the final upgrade procedure step.
  * Tasks that are marked **Prior to Maintenance Window** can be completed a few days prior to
    the scheduled maintenance window so that VOSS support can be contacted if needed and
    in order to allow for reduce down time.
  * If any Microsoft integrations exist in VOSS Automate pre-upgrade, then the existing device
    connections configured for Azure AD Online will be migrated to MS Graph.  The MS Graph connection
    configuration requires additional details, which must be obtained prior to upgrade.
    Please see the *VOSS Automate Configuration and Sync* and *Microsoft Configuration Setup*
    topics in the Core Feature Guide. The connection configuration must be added to the migrated connection
    details after upgrade to ensure continued serviceability.
   
    * Ensure MicrosoftTenant, MSTeamsOnline and MSGraph instance have the same name by renaming instances.

  * If you have FIPS enabled on your system, the before continuing with the upgrade, see: 

    .. raw:: html

       <a href="../platform/reference-system-FIPS.html#upgrading-from-release-19-3-x-with-fips-enabled">Upgrading from Release 19.3.x with FIPS enabled</a>.

    .. raw:: latex

       The Upgrading from Release 19.3.x with FIPS enabled section in the Platform Guide.
  

The standard **screen** command should be used where indicated.
See: :ref:`screen-command`.



.. _Prior-to-Maintenance-Window-Download-Files-and-Check-ISO:

Download Files and Check (Prior to Maintenance Window) 
.......................................................


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+--------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                | Notes and Status   |
+======================================================================================+====================+
| VOSS files:                                                                          |                    |
|                                                                                      |                    |
| **https://voss.portalshape.com > Downloads > VOSS Automate > XXX > Upgrade**         |                    |
|                                                                                      |                    |
| Download ``.iso``/``.ova`` and ``.template`` files, where XXX matches the release.   |                    |
|                                                                                      |                    |
| * Transfer the ``.iso``/``.ova`` file to the ``media/`` folder of all nodes.         |                    |
| * Transfer the ``.template`` file to the ``media/`` folder of the primary node.      |                    |
|                                                                                      |                    |
| Two transfer options:                                                                |                    |
|                                                                                      | .. raw:: html      |
| Either using SFTP:                                                                   |                    |
|                                                                                      |                    |
|                                                                                      |    <div><input     |
| * **sftp platform@<unified_node_hostname>**                                          |    type='checkbox' |
|                                                                                      |    id='done'       |
| * **cd media**                                                                       |    name='done'     |
|                                                                                      |    unchecked>      |
| * **put <upgrade_iso_or_ova_file>**                                                  |    <label          |
|                                                                                      |    for='isdone'>   |
| * **put <upgrade_template_file>**                                                    |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
|                                                                                      |                    |
| Or using SCP:                                                                        |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| * **scp <upgrade_iso_or_ova_file> platform@<unified_node_ip_address>:~/media**       |                    |
|                                                                                      |                    |
| * **scp <upgrade_template_file> platform@<unified_node_ip_address>:~/media**         |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| Verify that the ``.iso``/``.ova`` image and ``.template`` file copied:               |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| * **ls -l media/**                                                                   |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| Verify that the original ``.sha256`` checksums on the                                |                    |
| Download site server match.                                                          |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| * **system checksum media/<upgrade_iso_or_ova_file>**                                |                    |
|                                                                                      |                    |
|   ``Checksum: <SHA256>``                                                             |                    |
|                                                                                      |                    |
| * **system checksum media/<upgrade_template_file>**                                  |                    |
|                                                                                      |                    |
|   ``Checksum: <SHA256>``                                                             |                    |
|                                                                                      |                    |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+


.. _Prior-to-Maintenance-Window-Security-Health-Steps:

Security and Health Check Steps (Prior to Maintenance Window)
.............................................................


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+----------------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                              | Notes and Status   |
+====================================================================================================+====================+
| Verify that the primary node is the active primary node at the time of upgrade.                    |                    |
|                                                                                                    |                    |
| **database config**                                                                                | .. raw:: html      |
|                                                                                                    |                    |
| Ensure that the node on which the installation will be initiated has the ``stateStr``              |    <div><input     |
| parameter set to **PRIMARY** and has the **highest** ``priority`` **number**                       |    type='checkbox' |
| (highest priority number could vary depending on cluster layout).                                  |    id='done'       |
|                                                                                                    |    name='done'     |
| Example output ::                                                                                  |    unchecked>      |
|                                                                                                    |    <label          |
|   <ip address>:27020:                                                                              |    for='isdone'>   |
|     priority: <number>                                                                             |    Done</label>    |
|     stateStr: PRIMARY                                                                              |    </div>          |
|     storageEngine: WiredTiger                                                                      |                    |
|                                                                                                    |                    |
| Validate the system health. Carry out the following (19.x only):                                   |                    |
|                                                                                                    |                    |
| * **system mount** - mount the upgrade ISO.                                                        |                    |
| * **app install check_cluster** - install the new version of the **cluster check**                 |                    |
|   command.                                                                                         |                    |
|                                                                                                    |                    |
|   .. raw:: latex                                                                                   |                    |
|                                                                                                    |                    |
|      For details, refer to the "Cluster Check" topic in the Platform Guide.                        |                    |
|                                                                                                    |                    |
|   .. raw:: html                                                                                    |                    |
|                                                                                                    |                    |
|      For details, refer to <a href="../platform/reference-cluster-check.html">Cluster Check</a>.   |                    |
|                                                                                                    |                    |
| * **cluster check** - inspect the output of this command for warnings and errors. You              |                    |
|   can also use **cluster check verbose** to see more details. While warnings will not              |                    |
|   prevent an upgrade, it is advisable that these be resolved prior to upgrading where              |                    |
|   possible. Some warnings may be resolved by upgrading.                                            |                    |
|                                                                                                    |                    |
|   For troubleshooting and resolutions,                                                             |                    |
|   also refer to the *Health Checks for Cluster Installations Guide* and *Platform Guide*.          |                    |
|                                                                                                    |                    |
|   If there is any sign of the paths below are over 80% full, a clean-up is needed,                 |                    |
|   for example to avoid risk of full logs occurring during upgrade.                                 |                    |
|   Clean-up steps are indicated next to the paths:                                                  |                    |
|                                                                                                    |                    |
|   ::                                                                                               |                    |
|                                                                                                    |                    |
|       /              (call support if over 80%)                                                    |                    |
|       /var/log       (run: log purge)                                                              |                    |
|       /opt/platform  (remove any unnecessary files from /media directory)                          |                    |
|       /tmp           (reboot)                                                                      |                    |
|                                                                                                    |                    |
|                                                                                                    |                    |
|   On the Primary Unified Node, verify there are no pending Security Updates on any of the          |                    |
|   nodes.                                                                                           |                    |
|                                                                                                    |                    |
| .. note::                                                                                          |                    |
|                                                                                                    |                    |
|    If you run **cluster status** after installing the new version of **cluster check**, any        |                    |
|    error message regarding a failed command can be ignored. This error message will not show       |                    |
|    after upgrade.                                                                                  |                    |
|                                                                                                    |                    |
| * **Adaptation check** - if the *GS SME Adaptation* is installed, check for duplicate instances of |                    |
|   of ``GS_SMETemplateData_DAT`` and deleted any duplicates before upgrading to 21.2.               |                    |
+----------------------------------------------------------------------------------------------------+--------------------+


.. _Maintenance-Window-Schedules-Transactions-Version-Check:

Schedules, Transactions and Version Check (Maintenance Window) 
..................................................................


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+-------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                     | Notes and Status   |
+===========================================================================================+====================+
| Run **cluster check** and verify that no warnings and errors show.                        |                    |
|                                                                                           |                    |
| Turn off any scheduled imports to prevent syncs triggering part way through the upgrade.  |                    |
| Two options are available:                                                                |                    |
|                                                                                           |                    |
| Individually for each job:                                                                |                    |
|                                                                                           |                    |
| 1. Log in on the Admin Portal as a high level administrator above Provider level.         |                    |
| 2. Select the **Scheduling** menu to view scheduled jobs.                                 |                    |
| 3. Click each scheduled job. On the Base tab, uncheck the **Activate** check box.         |                    |
|                                                                                           |                    |
| Mass modify:                                                                              |                    |
|                                                                                           |                    |
| 1. On the Admin Portal, export scheduled syncs into a bulk load sheet.                    | .. raw:: html      |
| 2. Modify the schedule settings to de-activate scheduled syncs.                           |                    |
| 3. Import the sheet.                                                                      |    <div><input     |
|                                                                                           |    type='checkbox' |
| Schedules enabled on the CLI:                                                             |    id='done'       |
|                                                                                           |    name='done'     |
| 1. Run **schedule list** to check if any schedules exist and overlap with the maintenance |     unchecked>     |
|    window.                                                                                |    <label          |
| 2. For overlapping schedules, disable. Run **schedule disable <job-name>**.               |    for='isdone'>   |
|                                                                                           |    Done</label>    |
|                                                                                           |    </div>          |
|                                                                                           |                    |
|                                                                                           |                    |
+-------------------------------------------------------------------------------------------+--------------------+
| Check for running imports. Either wait for them to complete or cancel them:               |                    |
|                                                                                           |                    |
| 1. Log in on the Admin Portal as a high level administrator above Provider level.         |                    |
| 2. Select the **Transaction** menu to view transactions.                                  |                    |
| 3. Filter the **Action** column:                                                          |                    |
|                                                                                           |                    |
|    a. Choose **Status** as "Processing" and then choose each **Action**                   |                    |
|       that starts with "Import", for example, "Import Unity Connection".                  |                    |
|    b. Click **Search** and confirm there are no results.                                  |                    |
|    c. If there are transactions to cancel, select them and click **Cancel**.              |                    |
|                                                                                           |                    |
|                                                                                           | .. raw:: html      |
|                                                                                           |                    |
|                                                                                           |    <div><input     |
|                                                                                           |    type='checkbox' |
|                                                                                           |    id='done'       |
|                                                                                           |    name='done'     |
|                                                                                           |    unchecked>      |
|                                                                                           |    <label          |
|                                                                                           |    for='isdone'>   |
|                                                                                           |    Done</label>    |
|                                                                                           |    </div>          |
|                                                                                           |                    |
+-------------------------------------------------------------------------------------------+--------------------+
|                                                                                           |                    |
| **Version**                                                                               |                    |
|                                                                                           |                    |
| Record the current version information. This is required for upgrade troubleshooting.     |                    |
|                                                                                           |                    |
| * Log in on the Admin Portal and record the information contained in the menu:            | .. raw:: html      |
|   **About > Version**                                                                     |                    |
|                                                                                           |    <div><input     |
|                                                                                           |    type='checkbox' |
|                                                                                           |    id='done'       |
|                                                                                           |    name='done'     |
|                                                                                           |    unchecked>      |
|                                                                                           |    <label          |
|                                                                                           |    for='isdone'>   |
|                                                                                           |    Done</label>    |
|                                                                                           |    </div>          |
|                                                                                           |                    |
|                                                                                           |                    |
+-------------------------------------------------------------------------------------------+--------------------+

.. _Maintenance-Window-Pre-Upgrade-Steps:

Pre-Upgrade Steps (Maintenance Window)  
...............................................


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+-----------------------------------------------------------------------------------------+--------------------+
| As part of the rollback procedure, ensure that                                          |                    |
| a suitable restore point is obtained prior to the start of the                          |                    |
| activity, as per the guidelines for the infrastructure on which                         |                    |
| the VOSS Automate platform is deployed.                                                 |                    |
|                                                                                         |                    |
|                                                                                         | .. raw:: html      |
|                                                                                         |                    |
|                                                                                         |    <div><input     |
|                                                                                         |    type='checkbox' |
|                                                                                         |    id='done'       |
|                                                                                         |    name='done'     |
|                                                                                         |    unchecked>      |
|                                                                                         |    <label          |
|                                                                                         |    for='isdone'>   |
|                                                                                         |    Done</label>    |
|                                                                                         |    </div>          |
|                                                                                         |                    |
| Optional: If a backup is also required, use the                                         |                    |
| **backup add <location-name>** and                                                      |                    |
| **backup create <location-name>** commands. For details, refer to the *Platform Guide*. |                    |
|                                                                                         |                    |
+-----------------------------------------------------------------------------------------+--------------------+

   
.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+---------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                       | Notes and Status   |
+=============================================================================================+====================+
| After restore point creation and before upgrading: validate system health and check all     |                    |
| services, nodes and weights for the cluster:                                                |                    |
|                                                                                             |                    |
| * **cluster run application cluster list**                                                  |                    |
|                                                                                             |                    |
|   Make sure all application nodes show 3 or 5 nodes.                                        |                    |
|                                                                                             |                    |
|                                                                                             |                    |
|                                                                                             |                    |
|                                                                                             |                    |
|                                                                                             | .. raw:: html      |
|                                                                                             |                    |
|                                                                                             |    <div><input     |
| * **cluster check** - inspect the output of this command, for warnings and errors. You      |    type='checkbox' |
|   can also use **cluster check verbose** to see more details.                               |    id='done'       |
|                                                                                             |    name='done'     |
|   * Make sure no services are stopped/broken. The message 'suspended waiting for mongo'     |    unchecked>      |
|     is normal on the fresh unified nodes.                                                   |    <label          |
|                                                                                             |    for='isdone'>   |
|   * Check that the database weights are set. It is *critical* to ensure the weights are set |    Done</label>    |
|     before upgrading a cluster.                                                             |    </div>          |
|     Example output:                                                                         |                    |
|                                                                                             |                    |
|     ::                                                                                      |                    |
|                                                                                             |                    |
|        172.29.21.240:                                                                       |                    |
|            weight: 80                                                                       |                    |
|        172.29.21.241:                                                                       |                    |
|            weight: 70                                                                       |                    |
|        172.29.21.243:                                                                       |                    |
|            weight: 60                                                                       |                    |
|        172.29.21.244:                                                                       |                    |
|            weight: 50                                                                       |                    |
|                                                                                             |                    |
|   * Verify the primary node in the primary site and ensure no nodes are in the              |                    |
|     'recovering' state (``stateStr`` is not ``RECOVERING``). On the primary node:           |                    |
|                                                                                             |                    |
+---------------------------------------------------------------------------------------------+--------------------+

.. _Maintenance-Window-upgrade-ISO:

Upgrade (Maintenance Window)  
............................


.. note::


   By default, the cluster upgrade is carried out in parallel on all nodes and without any
   backup in order to provide a fast upgrade.



.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+---------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                 | Notes and Status   |
+=======================================================================================+====================+
| It is recommended that the upgrade steps                                              |                    |
| are run in a terminal opened with the **screen** command.                             |                    |
|                                                                                       |                    |
| Verify that the ISO has been uploaded to the ``media/`` directory on each node. This  |                    |
| will speed up the upgrade time.                                                       |                    |
|                                                                                       |                    |
| On the primary unified node:                                                          |                    |
|                                                                                       |                    |
|                                                                                       |                    |
| * **screen**                                                                          | .. raw:: html      |
|                                                                                       |                    |
|                                                                                       |                    |
| * **cluster upgrade media/<upgrade_iso_file>**                                        |    <div><input     |
|                                                                                       |    type='checkbox' |
| Note: If the system reboots, do not carry out the next manual reboot step.            |    id='done'       |
| When upgrading from pre-19.1.1, an automatic reboot should be expected.               |    name='done'     |
|                                                                                       |    unchecked>      |
| Manual reboot *only if needed*:                                                       |    <label          |
|                                                                                       |    for='isdone'>   |
| * **cluster run notme system reboot**                                                 |    Done</label>    |
|                                                                                       |    </div>          |
| If node messages: ``<node name> failed with timeout`` are displayed,                  |                    |
| these can be ignored.                                                                 |                    |
|                                                                                       |                    |
| * **system reboot**                                                                   |                    |
|                                                                                       |                    |
| Since all services will be stopped, this takes some time.                             |                    |
|                                                                                       |                    |
| Close **screen**: ``Ctrl-a \``                                                        |                    |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+

All unused docker images except ``selfservice`` and ``voss_ubuntu`` images
will be removed from the system at this stage.


.. _Maintenance-Window-Post-Upgrade-Security-Health-Steps:

Post-Upgrade and Health Steps  (Maintenance Window)
.............................................................


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+--------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                | Notes and Status   |
+======================================================================================+====================+
| On the primary unified node, verify the cluster status:                              |                    |
|                                                                                      |                    |
| * **cluster check**                                                                  | .. raw:: html      |
|                                                                                      |                    |
| * If any of the above commands show errors, check for further details to assist      |    <div><input     |
|   with troubleshooting:                                                              |    type='checkbox' |
|                                                                                      |    id='done'       |
|   **cluster run all diag health**                                                    |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+
| To remove a mount directory ``media/<iso_file basename>`` on nodes that may          |                    |
| have remained after for example an upgrade, run:                                     |                    |
|                                                                                      | .. raw:: html      |
| **cluster run all app cleanup**                                                      |                    |
|                                                                                      |    <div><input     |
|                                                                                      |    type='checkbox' |
|                                                                                      |    id='done'       |
|                                                                                      |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+
| If upgrade is successful, the screen session can be closed by typing **exit** in the |                    |
| screen terminal. If errors occurred, keep the screen terminal                        |                    |
| open for troubleshooting purposes and contact VOSS support.                          | .. raw:: html      |
|                                                                                      |                    |
|                                                                                      |    <div><input     |
|                                                                                      |    type='checkbox' |
|                                                                                      |    id='done'       |
|                                                                                      |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+



.. _Maintenance-Window-database-filesystem-conversion-iso:

Database Filesystem Conversion  (if required, Maintenance Window)
..................................................................

.. important::

   This step is to be carried out *only if* you have not converted the file system before.

   To check if the step is *not* required:
   
   * Run **drives list** and ensure that the LVM storage shows for
     *all converted database nodes* under ``Volume Groups``.
     If the output of the **drives list** command
     contains ``dm-0 - mongodb:dbroot``, the step is *not* required.
     Refer to the **drives list**  command output example below.


   The **database convert_drive** command provides parameters
   that allow for a flexible upgrade schedule in order to limit
   system downtime. 
    
   When the **database convert_drive** command is run, the ``voss-deviceapi``
   service will be stopped first and started after completion. The command
   should therefore be run during a maintenance window while there are no
   running transactions.
     
   The procedure and commands in this step depend on:
   
   * your topology
   * latency between data centers
   * upgrade maintenance windows - **Window 1** to **Window 3** represent chosen maintenance windows. 

   First inspect the table below for guidance on the commands to run according to your configuration and preferences.

   * Run all commands on the primary unified node:

     * Ensure states of database nodes are not DOWN - otherwise the command will fail
   
       **database config**  (``stateStr`` is not ``DOWN``)
     * Ensure database weights are set and have 1 maximum weight - otherwise the command will fail

       **database weight list** (one ``weight`` value is maximum)


   * For 2 and 3 maintenance windows: after the upgrade (prior to Windows 2 and 3), only nodes with converted drives will generate valid backups. 

     For example, if the primary drive is converted, backups from the primary node can be used to restore the database.
     If there is a database failover to the highest weight secondary node that was not converted, 
     it will not be possible for backups to be generated on that secondary node until the drive is converted.


.. tabularcolumns:: |p{1.5cm}|p{1.2cm}|p{1.2cm}|p{1.2cm}|p{6.5cm}|p{4cm}|

+-----------+----------+----------+-----------+--------------------------------------------------+----------------------------------------------------+
| Topology  | Window 1 | Window 2 |  Window 3 |  Commands (DC = valid data center name)          | Description                                        |
+===========+==========+==========+===========+==================================================+====================================================+
| multinode | Y        |          |           |  **database convert_drive primary**              | Recommended for a system with latency < 10ms.      |
|           |          |          |           |                                                  |                                                    |
|           |          |          |           |  **database convert_drive secondary all**        |                                                    |
+-----------+----------+----------+-----------+--------------------------------------------------+----------------------------------------------------+
| multinode | Y        | Y        |           | Window 1:                                        | Can be used for a system with latency < or > 10ms. |
|           |          |          |           |                                                  |                                                    |
|           |          |          |           | **database convert_drive primary**               | Allows for smaller maintenance windows.            |
|           |          |          |           |                                                  |                                                    |
|           |          |          |           | Window 2:                                        | Cluster is not available during maintenance        |
|           |          |          |           |                                                  | windows.                                           |
|           |          |          |           | **database convert_drive secondary all**         |                                                    |
+-----------+----------+----------+-----------+--------------------------------------------------+----------------------------------------------------+
| multinode | Y        | Y        |  Y        | Window 1:                                        | Can be used for a system with latency > 10ms.      |
|           |          |          |           |                                                  |                                                    |
|           |          |          |           | **database convert_drive primary**               | Allows for smaller maintenance windows.            |
|           |          |          |           |                                                  |                                                    |
|           |          |          |           | Window 2:                                        | Cluster is not available during maintenance        |
|           |          |          |           |                                                  | windows.                                           |
|           |          |          |           | **database convert_drive secondary <first DC>**  |                                                    |
|           |          |          |           |                                                  |                                                    |
|           |          |          |           | Window 3:                                        |                                                    |
|           |          |          |           |                                                  |                                                    |
|           |          |          |           | **database convert_drive secondary <second DC>** |                                                    |
+-----------+----------+----------+-----------+--------------------------------------------------+----------------------------------------------------+


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+---------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                 | Notes and Status   |
+=======================================================================================+====================+
| Database Filesystem Conversion step                                                   |                    |
|                                                                                       | .. raw:: html      |
| Shut down all the nodes. Since all services will be stopped, this takes some time.    |                    |
|                                                                                       |    <div><input     |
| * **cluster run all system shutdown**                                                 |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
|                                                                                       |    unchecked>      |
|                                                                                       |    <label          |
| * Create restore point for all the unified servers so that the system can easily      |    for='isdone'>   |
|   be reverted in the case of a conversion error.                                      |    Done</label>    |
|                                                                                       |    </div>          |
|                                                                                       |                    |
|   As part of the rollback procedure, ensure that                                      |                    |
|   a suitable restore point is obtained prior to the start of the                      |                    |
|   activity, as per the guidelines for the infrastructure on which                     |                    |
|   the VOSS Automate platform is deployed.                                             |                    |
| * Run the **convert_drive** command *with parameters according to the table above*.   |                    |
|                                                                                       |                    |
|   Wait until it completes successfully.                                               |                    |
|                                                                                       |                    |
| * **database config**                                                                 |                    |
|                                                                                       |                    |
|   Ensure that the storage engine for *all converted database nodes* shows as          |                    |
|   ``storageEngine: WiredTiger``.                                                      |                    |
|                                                                                       |                    |
| * **drives list**                                                                     |                    |
|                                                                                       |                    |
|   Ensure that the LVM storage shows for *all database nodes* under ``Volume Groups``. |                    |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+


In the example below, ``dbroot/dm-0`` shows under ``Volume Groups``, ``Logical volumes``
                                                                                        
::                                                                                      
                                                                                        
   $ drives list                                                                        
   Used disks and mountpoints:                                                          
   sdc1 - services:backups                                                              
   dm-0 - mongodb:dbroot                                                                
                                                                                        
   Unused disks:                                                                        
   none - if disks have been hot-mounted, it may be necessary to reboot the system      
                                                                                        
   Unused mountpoints:                                                                  
   services:SWAPSPACE                                                                   
                                                                                        
   Volume Groups                                                                        
   voss - 10.0 GB free, 60.0 GB total                                                   
   Physical volumes:                                                                    
   sdd1                                                                                 
   Logical volumes:                                                                     
   dbroot/dm-0 - 50.0 GB                                                                
                                                                                        



.. _Maintenance-Window-Database-Schema-Upgrade:


Database Schema Upgrade (Maintenance Window) 
.............................................


.. important::

   When upgrading from 19.X or earlier, please refer to the VOSS-4-UC 21.1 Release Changes and Impact
   document for details on model and workflow changes. Customizations related to these changes may be
   affected by this step.



.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+---------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                 | Notes and Status   |
+=======================================================================================+====================+
| It is recommended that the upgrade steps                                              |                    |
| are run in a terminal opened with the **screen** command.                             |                    |
|                                                                                       |                    |
| On the primary unified node:                                                          |                    |
|                                                                                       | .. raw:: html      |
| * **screen**                                                                          |                    |
|                                                                                       |    <div><input     |
| * **voss upgrade_db**                                                                 |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
| Check cluster status                                                                  |    unchecked>      |
|                                                                                       |    <label          |
| * **cluster check**                                                                   |    for='isdone'>   |
|                                                                                       |    Done</label>    |
|                                                                                       |    </div>          |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+


.. _Maintenance-Window-Template-Upgrade-ISO:


Template Upgrade (Maintenance Window) 
.....................................



.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+---------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                 | Notes and Status   |
+=======================================================================================+====================+
| It is recommended that the upgrade steps                                              |                    |
| are run in a terminal opened with the **screen** command.                             |                    |
|                                                                                       |                    |
| On the primary unified node:                                                          |                    |
|                                                                                       | .. raw:: html      |
| * **screen**                                                                          |                    |
|                                                                                       |    <div><input     |
| * **app template media/<VOSS Automate.template>**                                     |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
|                                                                                       |    unchecked>      |
|                                                                                       |    <label          |
|                                                                                       |    for='isdone'>   |
|                                                                                       |    Done</label>    |
|                                                                                       |    </div>          |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+



The following message appears:                                                                   
                                                                                                 
::                                                                                               
                                                                                                 
   Running the DB-query to find the current environment's 
   existing solution deployment config... 
                                                                                                 
* Python functions are deployed                                                                  
* System artifacts are imported.                                                                 
                                                                                                 
The template upgrade automatically detects the deployment mode: "Enterprise",                    
"Provider with HCM-F" or "Provider without HCM-F".                                               
A message displays according to the selected deployment type.
Check for one of the messages below:                                    
                                                                                                 
::                                                                                               
                                                                                                 
   Importing EnterpriseOverlay.json
                                                                                                
   Importing ProviderOverlay_Hcmf.json ...
                                                                                                
   Importing ProviderOverlay_Decoupled.json ...
                                                                                                 
The template install automatically restarts necessary applications. If a cluster is detected,    
the installation propagates changes throughout the cluster.                                      


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                    | Notes and Status   |
+==========================================================================================+====================+
|                                                                                          |                    |
| Review the output from the **app template** command and confirm that the upgrade message | .. raw:: html      |
| appears:                                                                                 |                    |
|                                                                                          |    <div><input     |
|                                                                                          |    type='checkbox' |
|                                                                                          |    id='done'       |
|                                                                                          |    name='done'     |
|                                                                                          |    unchecked>      |
|                                                                                          |    <label          |
|                                                                                          |    for='isdone'>   |
|                                                                                          |    Done</label>    |
|                                                                                          |    </div>          |
|                                                                                          |                    |
|                                                                                          |                    |
+------------------------------------------------------------------------------------------+--------------------+

::

 Deployment summary of PREVIOUS template solution
 (i.e. BEFORE upgrade):
 -------------------------------------------------                      
                                                                                              
                                                                                              
 Product: [PRODUCT]                                                                           
 Version: [PREVIOUS PRODUCT RELEASE]                                                          
 Iteration-version: [PREVIOUS ITERATION]                                                      
 Platform-version: [PREVIOUS PLATFORM VERSION]                                                
                                                                                              
                                                                                               
This is followed by updated product and version details:
                                                                                               
::

  Deployment summary of UPDATED template solution 
  (i.e. current values after installation):    
  -----------------------------------------------    
                                                                                               
  Product: [PRODUCT]                                                                           
  Version: [UPDATED PRODUCT RELEASE]                                                           
  Iteration-version: [UPDATED ITERATION]                                                       
  Platform-version: [UPDATED PLATFORM VERSION]                                                 
                                                                                               
                                                                                               
                                                                                               


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+-----------------------------------------------------------------------------+--------------------+
| Description and Steps                                                       | Notes and Status   |
+=============================================================================+====================+
|                                                                             |                    |
|                                                                             | .. raw:: html      |
|                                                                             |                    |
| * If no errors are indicated, create a restore point.                       |    <div><input     |
|                                                                             |    type='checkbox' |
|                                                                             |    id='done'       |
|                                                                             |    name='done'     |
|                                                                             |    unchecked>      |
|                                                                             |    <label          |
|                                                                             |    for='isdone'>   |
|                                                                             |    Done</label>    |
|                                                                             |    </div>          |
|                                                                             |                    |
|   As part of the rollback procedure, ensure that                            |                    |
|   a suitable restore point is obtained prior to the start of the            |                    |
|   activity, as per the guidelines for the infrastructure on which           |                    |
|   the VOSS Automate platform is deployed.                                   |                    |
+-----------------------------------------------------------------------------+--------------------+
|                                                                             |                    |
|                                                                             | .. raw:: html      |
|                                                                             |                    |
| For an unsupported upgrade path, the install script stops with the message: |    <div><input     |
|                                                                             |    type='checkbox' |
|                                                                             |    id='done'       |
| ::                                                                          |    name='done'     |
|                                                                             |    unchecked>      |
|                                                                             |    <label          |
|     Upgrade failed due to unsupported upgrade path.                         |    for='isdone'>   |
|     Please log in as sysadmin                                               |    Done</label>    |
|     and see Transaction logs for more detail.                               |    </div>          |
|                                                                             |                    |
| You can roll back as per the guidelines for the infrastructure on which     |                    |
| the VOSS Automate platform is deployed.                                     |                    |
|                                                                             |                    |
+-----------------------------------------------------------------------------+--------------------+
|                                                                             |                    |
|                                                                             | .. raw:: html      |
| If there are errors for another reason, the install script stops with a     |                    |
| failure message listing the problem. Contact VOSS support.                  |    <div><input     |
|                                                                             |    type='checkbox' |
|                                                                             |    id='done'       |
|                                                                             |    name='done'     |
|                                                                             |    unchecked>      |
|                                                                             |    <label          |
|                                                                             |    for='isdone'>   |
|                                                                             |    Done</label>    |
|                                                                             |    </div>          |
|                                                                             |                    |
+-----------------------------------------------------------------------------+--------------------+
|                                                                             |                    |
|                                                                             | .. raw:: html      |
| Verify the ``extra_functions`` have the *same checksum* across the cluster. |                    |
|                                                                             |    <div><input     |
| * **cluster run application voss get_extra_functions_version -c**           |    type='checkbox' |
|                                                                             |    id='done'       |
|                                                                             |    name='done'     |
|                                                                             |    unchecked>      |
|                                                                             |    <label          |
|                                                                             |    for='isdone'>   |
|                                                                             |    Done</label>    |
|                                                                             |    </div>          |
|                                                                             |                    |
+-----------------------------------------------------------------------------+--------------------+
| Post upgrade migrations:                                                    |                    |
|                                                                             |                    |
| On a single node of a cluster, run:                                         | .. raw:: html      |
|                                                                             |                    |
| * **voss post-upgrade-migrations**                                          |    <div><input     |
|                                                                             |    type='checkbox' |
|                                                                             |    id='done'       |
|                                                                             |    name='done'     |
|                                                                             |    unchecked>      |
|                                                                             |    <label          |
|                                                                             |    for='isdone'>   |
|                                                                             |    Done</label>    |
|                                                                             |    </div>          |
|                                                                             |                    |
+-----------------------------------------------------------------------------+--------------------+


Data migrations that are not critical to system operation can have significant
execution time at scale. These need to be performed after the primary upgrade,
allowing the migration to proceed whilst the system is in use - thereby limiting
upgrade windows.

A transaction is queued on VOSS Automate and its progress is displayed as it executes.




.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+---------------------------------+--------------------+
| Description and Steps           | Notes and Status   |
+=================================+====================+
|                                 |                    |
| Check cluster status and health | .. raw:: html      |
|                                 |                    |
| * **cluster status**            |    <div><input     |
|                                 |    type='checkbox' |
|                                 |    id='done'       |
|                                 |    name='done'     |
|                                 |    unchecked>      |
|                                 |    <label          |
|                                 |    for='isdone'>   |
|                                 |    Done</label>    |
|                                 |    </div>          |
|                                 |                    |
+---------------------------------+--------------------+


.. _Maintenance-Window-Post-Template-Upgrade-Tasks:


Post Template Upgrade Tasks (Maintenance Window) 
................................................


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+--------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                | Notes and Status   |
+======================================================================================+====================+
|                                                                                      |                    |
| **Customized ``data/Settings``**                                                     |                    |
|                                                                                      |                    |
| Merge the previously backed up customized ``data/Settings`` with the latest settings |                    |
| on the system by manually adding the differences or exporting the latest settings    |                    |
| to JSON, merging the customized changes and importing the JSON.                      |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| **Support for VG400 and VG450 Analogue Gateways**                                    |                    |
|                                                                                      |                    |
| Before adding the VG400 or VG450 Gateway, the ``device/cucm/GatewayType``            |                    |
| model needs to be imported for each Unified CM.                                      |                    |
|                                                                                      |                    |
| 1. Create a Model Type List which includes the ``device/cucm/GatewayType`` model.    |                    |
| 2. Add the Model Type List to all the required Unified CM Data Syncs.                |                    |
| 3. Execute the Data Sync for all the required Unified CMs.                           |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| **Verify the upgrade**                                                               | .. raw:: html      |
|                                                                                      |                    |
| Log in on the Admin Portal and check the information contained in the                |                    |
| **About > Version** menu. Confirm that versions have upgraded.                       |    <div><input     |
|                                                                                      |    type='checkbox' |
| * **Release** should show 21.2                                                       |    id='done'       |
| * **Platform Version** should show 21.2                                              |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+
|                                                                                      | .. raw:: html      |
|                                                                                      |                    |
|                                                                                      |    <div><input     |
| * Check themes on all roles are set correctly                                        |    type='checkbox' |
|                                                                                      |    id='done'       |
|                                                                                      |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+
|                                                                                      | .. raw:: html      |
|                                                                                      |                    |
|                                                                                      |    <div><input     |
| * For configurations that make use of the Northbound Billing Integration (NBI),      |    type='checkbox' |
|   please check the service status of NBI and restart if necessary.                   |    id='done'       |
|                                                                                      |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+


.. _Maintenance-Window-Restore_Schedules:

Restore Schedules (Maintenance Window) 
......................................


.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+--------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                | Notes and Status   |
+======================================================================================+====================+
| Re-enable scheduled imports if any were disabled prior to the upgrade.               |                    |
| Two options are available:                                                           |                    |
|                                                                                      |                    |
| Individually for each job:                                                           |                    |
|                                                                                      |                    |
| 1. Log in on the Admin Portal as a high level administrator above Provider           |                    |
|    level.                                                                            |                    |
| 2. Select the **Scheduling** menu to view scheduled jobs.                            |                    |
| 3. Click each scheduled job. On the Base tab, check the **Activate** check box.      |                    |
|                                                                                      |                    |
| Mass modify:                                                                         |                    |
|                                                                                      |                    |
| 1. Modify the exported sheet of schedules to activate scheduled syncs.               |                    |
| 2. Import the bulk load sheet.                                                       | .. raw:: html      |
|                                                                                      |                    |
| .. note::                                                                            |                    |
|                                                                                      |                    |
|    Select the **Skip next execution** option if you do not wish to execute schedules |                    |
|    overlapping the maintenance window, but only execute thereafter.                  |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| Schedules enabled on the CLI:                                                        |    <div><input     |
|                                                                                      |    type='checkbox' |
| 1. For disabled schedules that were overlapping the maintenance window, enable.      |    id='done'       |
|                                                                                      |    name='done'     |
|    Run **schedule enable <job-name>**.                                               |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
|                                                                                      |                    |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+

.. _Maintenance-Window-Release-specific-updates:


Release Specific Updates (Maintenance Window) 
................................................

.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+-------------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                           | Notes and Status   |
+=================================================================================================+====================+
| When upgrading from CUCDM 11.5.3 Patch Bundle 2 or VOSS-4-UC 18.1 Patch Bundle 2 and earlier,   |                    |
| re-import the following from all CUCM devices, since this upgrade deleted obsolete CUC timezone |                    |
| codes from the VOSS Automate database:                                                          |                    |
|                                                                                                 |                    |
| * CUC models:                                                                                   | .. raw:: html      |
|                                                                                                 |                    |
|   ``device/cuc/TimeZone``                                                                       |    <div><input     |
|                                                                                                 |    type='checkbox' |
|                                                                                                 |    id='done'       |
|                                                                                                 |    name='done'     |
| Note:                                                                                           |    unchecked>      |
|                                                                                                 |    <label          |
| This is a once off data migration step. If this was performed previously when upgrading         |    for='isdone'>   |
| to 19.1.x, then it does not have to be repeated.                                                |    Done</label>    |
|                                                                                                 |    </div>          |
+-------------------------------------------------------------------------------------------------+--------------------+
| After upgrading, obtain and install the following patch                                         |                    |
| according to its accompanying MOP file, where XXX matches the release.:                         |                    |
|                                                                                                 |                    |
| * **Server Name**: ``https://voss.portalshape.com``                                             | .. raw:: html      |
| * **Path**: **Downloads > VOSS Automate > XXX > Upgrade**                                       |                    |
| * **Patch Directory**: ``Update_CUC_Localization_patch``                                        |    <div><input     |
| * **Patch File**: ``Update_CUC_Localization_patch.script``                                      |    type='checkbox' |
| * **MOP File**: ``MOP-Update_CUC_Localization.pdf``                                             |    id='done'       |
|                                                                                                 |    name='done'     |
|                                                                                                 |    unchecked>      |
| Note:                                                                                           |    <label          |
|                                                                                                 |    for='isdone'>   |
| This is a once off data migration step. If this was performed previously when upgrading         |    Done</label>    |
| to 19.x, then it does not have to be repeated.                                                  |    </div>          |
|                                                                                                 |                    |
+-------------------------------------------------------------------------------------------------+--------------------+
| Re-import the following from all CUCM devices:                                                  |                    |
|                                                                                                 |                    |
| * CUCM models:                                                                                  | .. raw:: html      |
|                                                                                                 |                    |
| ``device/cucm/PhoneType``                                                                       |    <div><input     |
|                                                                                                 |    type='checkbox' |
| For steps to create a custom data sync, refer to the chapter on Data Sync                       |    id='done'       |
| in the Core Feature Guide.                                                                      |    name='done'     |
|                                                                                                 |    unchecked>      |
|                                                                                                 |    <label          |
| Note:                                                                                           |    for='isdone'>   |
|                                                                                                 |    Done</label>    |
| This is a once off data migration step. If this was performed previously when upgrading         |    </div>          |
| to 19.1.x, then it does not have to be repeated.                                                |                    |
+-------------------------------------------------------------------------------------------------+--------------------+
|                                                                                                 |                    |
|  User Management migration updates default authentication types on SSO Identity Providers.      | .. raw:: html      |
|  If an SSO Identity Provider exists at the provider hierarchy level, the                        |                    |
|  default authentication settings:                                                               |    <div><input     |
|                                                                                                 |    type='checkbox' |
|  * Authentication Scope: Current hierarchy level and below                                      |    id='done'       |
|  * User Sync Type: All users                                                                    |    name='done'     |
|                                                                                                 |    unchecked>      |
|  will not allow any non-SSO user logins (typically local administrators).                       |    <label          |
|  The solution is to log in as higher level administrator account (full access)                  |    for='isdone'>   |
|  and set the SSO Identity Provider:                                                             |    Done</label>    |
|                                                                                                 |    </div>          |
|  * Authentication Scope: Current hierarchy level only                                           |                    |
|  * User Sync Type: LDAP synced users only                                                       |                    |
|                                                                                                 |                    |
|  Please refer to the *SSO Identity Provider: Field Reference* topic in the Core Feature Guide.  |                    |
+-------------------------------------------------------------------------------------------------+--------------------+








.. _Maintenance-Window-Log-Files-Error-Checks:


Log Files and Error Checks (Maintenance Window) 
................................................

.. tabularcolumns:: |p{13.5cm}|p{4cm}|

+----------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                            | Notes and Status   |
+==================================================================================+====================+
| Inspect the output of the command line interface for upgrade errors,             | .. raw:: html      |
| for example ``File import failed!`` or ``Failed to execute command``.            |                    |
|                                                                                  |                    |
| Use the **log view** command to view any log files indicated in the error        |                    |
| messages, for example, run the command if the following message appears:         |    <div><input     |
|                                                                                  |    type='checkbox' |
| ::                                                                               |    id='done'       |
|                                                                                  |    name='done'     |
|    For more information refer to the execution log file with                     |    unchecked>      |
|    'log view platform/execute.log'                                               |    <label          |
|                                                                                  |    for='isdone'>   |
| For example, if it is required send all the install log files in the ``install`` |    Done</label>    |
| directory to an SFTP server:                                                     |    </div>          |
|                                                                                  |                    |
| * **log send sftp://x.x.x.x install**                                            |                    |
|                                                                                  |                    |
+----------------------------------------------------------------------------------+--------------------+
|                                                                                  | .. raw:: html      |
| Log in on the Admin Portal as system level administrator, go to                  |                    |
| **Administration Tools > Transaction** and inspect the transactions              |    <div><input     |
| list for errors.                                                                 |    type='checkbox' |
|                                                                                  |    id='done'       |
|                                                                                  |    name='done'     |
|                                                                                  |    unchecked>      |
|                                                                                  |    <label          |
|                                                                                  |    for='isdone'>   |
|                                                                                  |    Done</label>    |
|                                                                                  |    </div>          |
|                                                                                  |                    |
+----------------------------------------------------------------------------------+--------------------+

.. _upgrade-18.1.3-to-current:

Upgrading from 18.1.3 to Current Release - Summary
...................................................

Below are the summarized steps to upgrade from 18.1.3.

* The steps require the necessary scripts, templates and ISOs to be in the ``media/`` directory.
* For details on the specific commands, refer to the corresponding steps above.
* For general usage of commands to carry out tasks, refer to the *Platform Guide*.

.. tabularcolumns:: |p{12.5cm}|p{5cm}|

+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| Command and task sequence                                                | Comment                                                                                                                |
+==========================================================================+========================================================================================================================+
| ``cluster status``                                                       | no service mismatch, all nodes ok                                                                                      |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``cluster run all diag disk``                                            | check for disks over 90% full                                                                                          |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``database config``                                                      | ensure all unified nodes have a weight, and are in a good state: primary, secondary,arbiter                            |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| manual check                                                             | stop / check for transactions running, stop where possible                                                             |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| external task                                                            | create restore point as per the guidelines for the infrastructure on which the VOSS Automate platform is deployed.     |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``cluster run all app install media/EKB-4124-18.1.3_patch.script``       | refer to steps details above                                                                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``cluster upgrade media/platform-install-19.2.1-1570776653.iso --force`` | refer to steps details above                                                                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``cluster run all security update --force``                              | refer to steps details above                                                                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| external task                                                            | create restore point as per the guidelines for the infrastructure on which the VOSS Automate platform is deployed.     |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``cluster upgrade media/platform-install-<current>-<nnnnnnnnnn>.iso``    | refer to preliminary and upgrade steps details above; ``<current>-<nnnnnnnnnn>`` matches the downloaded release ISO    |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``cluster run all security update``                                      | refer to steps details above                                                                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``database config``                                                      | make sure all databases are in the correct state                                                                       |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``database convert_drive <params>``                                      | Run the **convert_drive** command with *parameters* according to the table at: Database Filesystem Conversion section. |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``voss upgrade_db``                                                      | refer to steps details above                                                                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ``app template media/<VOSS Automate.template>``                          | refer to steps details above                                                                                           |
+--------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+