.. _upgrade-standalone_ISO:

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

Upgrade a Single Node Cluster Environment with the ISO and Template
---------------------------------------------------------------------

.. index:: voss;voss post-upgrade-migrations
.. index:: screen
.. index:: database;database convert_drive
.. index:: app; app cleanup

.. _19.1.2|EKB-2262:   
.. _19.2.1|VOSS-497:   
.. _19.2.1|VOSS-497|EKB-3126:   
.. _20.1.1|VOSS-661:
.. _20.1.1|EKB-5552:
.. _20.1.1|EKB-6669:

.. important::

   * Upgrading to release 21.1 *requires a system on 19.x, with security updates completed*.
   * 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.
   * 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.


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



.. _standalone_Download-Files-and-Check:

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 file to the ``media/`` folder. Two 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 match.                                                                 |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| * **system checksum media/<upgrade_iso_or_ova_file>**                                |                    |
|                                                                                      |                    |
|   ``Checksum: <SHA256>``                                                             |                    |
|                                                                                      |                    |
| * **system checksum media/<upgrade_template_file>**                                  |                    |
|                                                                                      |                    |
|   ``Checksum: <SHA256>``                                                             |                    |
|                                                                                      |                    |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+
                   



.. _standalone_Upgrade-Security-Health-Steps:

Security and Health Steps single node cluster (Prior to Maintenance Window)
..................................................................................


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

+----------------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                              | Notes and Status   |
+====================================================================================================+====================+
| Validate the system health.                                                                        |                    |
|                                                                                                    |                    |
|                                                                                                    |                    |
|                                                                                                    |                    |
| Verify there are no pending Security Updates:                                                      | .. raw:: html      |
|                                                                                                    |                    |
|                                                                                                    |    <div><input     |
| **security check**                                                                                 |    type='checkbox' |
|                                                                                                    |    id='done'       |
|                                                                                                    |    name='done'     |
|                                                                                                    |    unchecked>      |
|                                                                                                    |    <label          |
|                                                                                                    |    for='isdone'>   |
|                                                                                                    |    Done</label>    |
|                                                                                                    |    </div>          |
+----------------------------------------------------------------------------------------------------+--------------------+
| Check system health.                                                                               |                    |
|                                                                                                    |                    |
| * **diag disk**                                                                                    |                    |
|                                                                                                    |                    |
| 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)                                                                        |                    |
|                                                                                                    |                    |
|                                                                                                    |                    |
|                                                                                                    |                    |
|                                                                                                    | .. raw:: html      |
|                                                                                                    |                    |
|                                                                                                    |    <div><input     |
|                                                                                                    |    type='checkbox' |
|                                                                                                    |    id='done'       |
|                                                                                                    |    name='done'     |
|                                                                                                    |    unchecked>      |
|                                                                                                    |    <label          |
|                                                                                                    |    for='isdone'>   |
|                                                                                                    |    Done</label>    |
|                                                                                                    |    </div>          |
|                                                                                                    |                    |
| * **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.               |                    |
+----------------------------------------------------------------------------------------------------+--------------------+



.. _standalone_Schedules-Transactions-Version-Check:

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


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

+-------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                     | Notes and Status   |
+===========================================================================================+====================+
| 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>          |
|                                                                                           |                    |
|                                                                                           |                    |
+-------------------------------------------------------------------------------------------+--------------------+
|                                                                                           |                    |
| **Customized ``data/Settings``**                                                          |                    |
|                                                                                           |                    |
| If ``data/Settings`` instances have been modified, record these or export them as JSON.   |                    |
|                                                                                           |                    |
| The modifications can be re-applied or exported JSON instances can be merged following    |                    |
| the upgrade. See: :ref:`standalone_Post-Template-Upgrade-Tasks`.                          |                    |
|                                                                                           |                    |
| **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                  | .. raw:: html      |
|   **About > Extended Version**                                                            |                    |
|                                                                                           |    <div><input     |
|                                                                                           |    type='checkbox' |
|                                                                                           |    id='done'       |
|                                                                                           |    name='done'     |
|                                                                                           |    unchecked>      |
|                                                                                           |    <label          |
|                                                                                           |    for='isdone'>   |
|                                                                                           |    Done</label>    |
|                                                                                           |    </div>          |
|                                                                                           |                    |
|                                                                                           |                    |
+-------------------------------------------------------------------------------------------+--------------------+


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

Pre-Upgrade Steps single node cluster (Maintenance Window)
..................................................................  

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

+-----------------------------------------------------------------------------------------+--------------------+
| Create a restore point and then restart server.                                         |                    |
|                                                                                         |                    |
| As part of the rollback procedure, ensure that                                          |                    |
| a suitable restore point is obtained prior to the start of the                          | .. raw:: html      |
| activity, as per the guidelines for the infrastructure on which                         |                    |
| the VOSS Automate platform is deployed. If you cannot                                   |    <div><input     |
| restore the application from a restore point, your only recourse is to reinstall        |    type='checkbox' |
| the application.                                                                        |    id='done'       |
| When the backup is complete and you do not need the restore point for                   |    name='done'     |
| restore activities, you can remove it.                                                  |    unchecked>      |
|                                                                                         |    <label          |
|                                                                                         |    for='isdone'>   |
|                                                                                         |    Done</label>    |
|                                                                                         |    </div>          |
| After the restore point has been created, restart.                                      |                    |
|                                                                                         |                    |
| Optional: If a backup is required in addition to the restore point, 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   |
+=======================================================================================+====================+
| Before upgrading, check all services:                                                 |                    |
|                                                                                       |                    |
| Make sure no services are stopped/broken. The message 'suspended waiting for mongo'   |                    |
| is normal on a fresh node.                                                            |                    |
|                                                                                       |                    |
| * **app status**                                                                      |                    |
|                                                                                       | .. raw:: html      |
|                                                                                       |                    |
|                                                                                       |    <div><input     |
|                                                                                       |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
|                                                                                       |    unchecked>      |
|                                                                                       |    <label          |
|                                                                                       |    for='isdone'>   |
|                                                                                       |    Done</label>    |
| Verify the node is not in the 'recovering' state (``stateStr`` is not ``RECOVERING``) |                    |
|                                                                                       |                    |
|                                                                                       |                    |
| * **database config**                                                                 |                    |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+

.. _Maintenance-Window-upgrade-ISO-standalone:

Upgrade single node cluster (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:                                                          |                    |
|                                                                                       |                    |
|                                                                                       |                    |
| * **screen**                                                                          |                    |
|                                                                                       |                    |
| * If upgrading from *earlier* than release 20.1.1:                                    |                    |
|                                                                                       |                    |
|   **app upgrade media/<upgrade_iso_file>**                                            |                    |
|                                                                                       |                    |
|   .. note::                                                                           |                    |
|                                                                                       |                    |
|      If upgrading from release 20.1.1, on the *primary unified* node,                 |                    |
|      use the command:                                                                 |                    |
|                                                                                       |                    |
|      **cluster upgrade media/<upgrade_iso_file>**                                     |                    |
|                                                                                       |                    |
|      If upgrading from release 21.1 and up, on the *primary application* node,        |                    |
|                                                                                       | .. raw:: html      |
|      **cluster upgrade media/<upgrade_iso_file>**                                     |                    |
|                                                                                       |    <div><input     |
|                                                                                       |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
| All unused docker images except ``selfservice`` and ``voss_ubuntu`` images            |    unchecked>      |
| will be removed from the system at this stage.                                        |    <label          |
|                                                                                       |    for='isdone'>   |
|                                                                                       |    Done</label>    |
|                                                                                       |    </div>          |
|                                                                                       |                    |
| Note: If the system reboots, do not carry out the next manual reboot step.            |                    |
| When upgrading from pre-19.1.1, an automatic reboot should be expected.               |                    |
|                                                                                       |                    |
| To remove a mount directory ``media/<iso_file basename>`` on nodes that may           |                    |
| have remained after for example an upgrade, run:                                      |                    |
|                                                                                       |                    |
| **cluster run all app cleanup**                                                       |                    |
|                                                                                       |                    |
| Manual reboot *only if needed*:                                                       |                    |
|                                                                                       |                    |
| * **system reboot**                                                                   |                    |
|                                                                                       |                    |
| If node messages: ``<node name> failed with timeout`` are displayed,                  |                    |
| these can be ignored.                                                                 |                    |
|                                                                                       |                    |
| Since all services will be stopped, this takes some time.                             |                    |
|                                                                                       |                    |
| Close **screen**: ``Ctrl-a \``                                                        |                    |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+

.. note::

   In order to carry out fewer upgrade steps, the updates of instances
   of the some models are skipped in the cases where:
   
   * ``data/CallManager`` instance does not exist as instance in ``data/NetworkDeviceList``
   * ``data/CallManager`` instance exists, but ``data/NetworkDeviceList`` is empty
   * Call Manager AXL Generic Driver and Call Manager Control Center Services
     match the ``data/CallManager`` IP



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

Post-Upgrade, Security and Health Steps single node cluster (Maintenance Window)
....................................................................................


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



+---------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                 | Notes and Status   |
+=======================================================================================+====================+
| Verify the status:                                                                    |                    |
|                                                                                       |                    |
| * **diag health**                                                                     | .. raw:: html      |
|                                                                                       |                    |
|                                                                                       |    <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>          |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+
| Complete all the security updates.                                                    |                    |
|                                                                                       |                    |
|                                                                                       | .. raw:: html      |
| * **security update**                                                                 |                    |
|                                                                                       |    <div><input     |
| The docker images ``selfservice`` and ``voss_ubuntu`` will be removed from            |    type='checkbox' |
| the system at this stage.                                                             |    id='done'       |
|                                                                                       |    name='done'     |
| Note: If the system reboots, do not carry out the next manual reboot step .           |    unchecked>      |
| When upgrading from pre-19.1.1, an automatic reboot should be expected.               |    <label          |
|                                                                                       |    for='isdone'>   |
| Manual reboot *only if needed*:                                                       |    Done</label>    |
|                                                                                       |    </div>          |
| * **system reboot**                                                                   |                    |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+


.. _standalone_database-filesystem-conversion-iso:

Database Filesystem Conversion single node cluster (Maintenance Window, if required)
..........................................................................................

.. important::


   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.
     
   For a single node cluster system drive conversion, ensure the ``standalone``
   parameter is used. 

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

+---------------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                             | Notes and Status   |
+===================================================================================================+====================+
|                                                                                                   |                    |
|                                                                                                   | .. raw:: html      |
| Shut down. Since all services will be stopped, this takes some time.                              |                    |
|                                                                                                   |    <div><input     |
| * **system shutdown**                                                                             |    type='checkbox' |
|                                                                                                   |    id='done'       |
|                                                                                                   |    name='done'     |
|                                                                                                   |    unchecked>      |
|                                                                                                   |    <label          |
| Create a restore point as per the guidelines for the infrastructure on which the VOSS Automate    |    for='isdone'>   |
| platform is deployed so that the system can easily be reverted in the case of a conversion error. |    Done</label>    |
|                                                                                                   |    </div>          |
| Stop transactions from being scheduled.                                                           |                    |
|                                                                                                   |                    |
| Run:                                                                                              |                    |
|                                                                                                   |                    |
| * **database convert_drive standalone**                                                           |                    |
|                                                                                                   |                    |
| Note: this step may take a few hours. Wait until it completes successfully.                       |                    |
|                                                                                                   |                    |
|                                                                                                   |                    |
| * **database config**                                                                             |                    |
|                                                                                                   |                    |
|   Ensure that the storage engine for the *database node* shows as ``storageEngine: WiredTiger``   |                    |
|                                                                                                   |                    |
| * **drives list**                                                                                 |                    |
|                                                                                                   |                    |
|   Ensure that the LVM storage for the *database node* shows 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                                                                         |                    |
|                                                                                                   |                    |
+---------------------------------------------------------------------------------------------------+--------------------+



.. _standalone_Database-Schema-Upgrade:


Database Schema Upgrade single node cluster (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.                             |                    |
|                                                                                       |                    |
|                                                                                       | .. raw:: html      |
| * **screen**                                                                          |                    |
|                                                                                       |    <div><input     |
| * **voss upgrade_db**                                                                 |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
|                                                                                       |    unchecked>      |
|                                                                                       |    <label          |
|                                                                                       |    for='isdone'>   |
|                                                                                       |    Done</label>    |
|                                                                                       |    </div>          |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+


.. _standalone_Template-Upgrade:


Template Upgrade single node cluster (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.                             |                    |
|                                                                                       |                    |
|                                                                                       | .. 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.          
                                                                                                             


.. 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, make a backup or restore point as per the                        |    <div><input     |
|   guidelines for the infrastructure on which the VOSS Automate platform is deployed.           |    type='checkbox' |
|                                                                                                |    id='done'       |
|   This restore point can be used if post-upgrade patches that may be required, fail.           |    name='done'     |
|                                                                                                |    unchecked>      |
|                                                                                                |    <label          |
|                                                                                                |    for='isdone'>   |
|                                                                                                |    Done</label>    |
|                                                                                                |    </div>          |
|                                                                                                |                    |
+------------------------------------------------------------------------------------------------+--------------------+
|                                                                                                |                    |
|                                                                                                | .. 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 restore to the backup or rollback/revert to the restore point made before the upgrade. |                    |
|                                                                                                |                    |
|                                                                                                |                    |
+------------------------------------------------------------------------------------------------+--------------------+
|                                                                                                |                    |
|                                                                                                | .. 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>          |
|                                                                                                |                    |
+------------------------------------------------------------------------------------------------+--------------------+
| Post upgrade migrations:                                                                       |                    |
|                                                                                                | .. raw:: html      |
|                                                                                                |                    |
| * **voss post-upgrade-migrations**                                                             |    <div><input     |
|                                                                                                |    type='checkbox' |
|                                                                                                |    id='done'       |
| Data migrations that are not critical to system operation can have significant                 |    name='done'     |
| execution time at scale. These need to be performed after the primary upgrade,                 |    unchecked>      |
| allowing the migration to proceed whilst the system is in use - thereby limiting               |    <label          |
| upgrade windows.                                                                               |    for='isdone'>   |
|                                                                                                |    Done</label>    |
| A transaction is queued on VOSS Automate and its progress is displayed as it executes.         |    </div>          |
|                                                                                                |                    |
+------------------------------------------------------------------------------------------------+--------------------+


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

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



.. _standalone_Post-Template-Upgrade-Tasks:

Post Template Upgrade Tasks single node cluster (Maintenance Window)
...........................................................................

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

+--------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                | Notes and Status   |
+======================================================================================+====================+
|                                                                                      |                    |
| **SSO Login URL check if needed**                                                    |                    |
|                                                                                      |                    |
| Verify the SSO Login URL if needed. Go to **Single Sign On > SSO Identity Provider** |                    |
| and ensure your URL matches the **SSO Login URL** value.                             |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| **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.3                                                       |    id='done'       |
| * **Platform Version** should show 21.3                                              |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
| If your web browser cannot open the user interface, clear your browser cache before  |    Done</label>    |
| trying to open the interface again.                                                  |    </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>          |
|                                                                                      |                    |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+


.. _standalone_Restore_Schedules:

Restore Schedules single node cluster (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**  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>          |
|                                                                                 |                    |
|                                                                                 |                    |
+---------------------------------------------------------------------------------+--------------------+

.. _standalone_Release-specific-updates:


Release Specific Updates single node cluster (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'     |
|                                                                                                 |    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.                                                |                    |
+-------------------------------------------------------------------------------------------------+--------------------+
| 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>      |
| Note:                                                                                           |    <label          |
|                                                                                                 |    for='isdone'>   |
| This is a once off data migration step. If this was performed previously when upgrading         |    Done</label>    |
| to 19.1.x, then it does not have to be repeated.                                                |    </div>          |
|                                                                                                 |                    |
+-------------------------------------------------------------------------------------------------+--------------------+
|                                                                                                 |                    |
|  When upgrading to release 21.3, users of Microsoft apps should after upgrade, select each      | .. raw:: html      |
|  Microsoft Tenant (``relation/MicrosoftTenant``) in the Admin GUI and click **Save** on it      |                    |
|  without making any changes.                                                                    |    <div><input     |
|                                                                                                 |    type='checkbox' |
|  This step is required so that VOSS Automate can communicate with the Tenant post upgrade.      |    id='done'       |
|                                                                                                 |    name='done'     |
|                                                                                                 |    unchecked>      |
|                                                                                                 |    <label          |
|                                                                                                 |    for='isdone'>   |
|                                                                                                 |    Done</label>    |
|                                                                                                 |    </div>          |
+-------------------------------------------------------------------------------------------------+--------------------+




.. _standalone_Log-Files-Error-Checks:


Log Files and Error Checks single node cluster (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>          |
|                                                                                  |                    |
+----------------------------------------------------------------------------------+--------------------+



For Upgrading from 18.1.3 to the current release, see: :ref:`upgrade-18.1.3-to-current`.


.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM