.. _upgrade-standalone_delta:

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

Upgrade a Single Node Cluster Environment with the Delta Bundle
----------------------------------------------------------------

.. index:: voss;voss post-upgrade-migrations
.. index:: screen

.. _19.1.2|EKB-2262:   
.. _19.2.1|VOSS-497:   
.. _19.2.1|VOSS-497|EKB-3126:   
.. _19.3.4|EKB-6669:
.. _19.3.4|EKB-1969:
.. _19.3.4|EKB-4132:
.. _19.3.4|EKB-6084:


   
.. note::    

  * While 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.

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



.. _standalone_Download-Files-and-Check:

Download Files and Check
........................



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

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

.. _standalone_Adaptations-Check:

Adaptations Check
.................

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

+-------------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                     | Notes and Status   |
+===========================================================================================+====================+
| Identify installed adaptations and determine any effect on the upgrade plan.              |                    |
|                                                                                           |                    |
| If the release is accompanied by Upgrade Notes, refer to the details.                     | .. raw:: html      |
|                                                                                           |                    |
|                                                                                           |    <div><input     |
|                                                                                           |    type='checkbox' |
|                                                                                           |    id='done'       |
|                                                                                           |    name='done'     |
|                                                                                           |    unchecked>      |
|                                                                                           |    <label          |
|                                                                                           |    for='isdone'>   |
|                                                                                           |    Done</label>    |
|                                                                                           |    </div>          |
|                                                                                           |                    |
+-------------------------------------------------------------------------------------------+--------------------+



.. _standalone_Schedules-Transactions-Version-Check:

Schedules, Transactions and Version Check
.........................................


.. 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 GUI 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 GUI, 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 GUI 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 GUI and record the information contained in the **About > Extended Version** | .. raw:: html      |
|                                                                                              |                    |
|                                                                                              |    <div><input     |
|                                                                                              |    type='checkbox' |
|                                                                                              |    id='done'       |
|                                                                                              |    name='done'     |
|                                                                                              |    unchecked>      |
|                                                                                              |    <label          |
|                                                                                              |    for='isdone'>   |
|                                                                                              |    Done</label>    |
|                                                                                              |    </div>          |
|                                                                                              |                    |
|                                                                                              |                    |
+----------------------------------------------------------------------------------------------+--------------------+



.. _standalone_Pre_Upgrade-Security-Health-Steps:

Pre-Upgrade, Security and Health Steps
.......................................


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

+---------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                 | Notes and Status   |
+=======================================================================================+====================+
| Validate the system health.                                                           |                    |
|                                                                                       |                    |
|                                                                                       |                    |
| **diag health**                                                                       |                    |
|                                                                                       |                    |
| If there is any sign of the paths below are over 80% full, a clean-up is needed       |                    |
| 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)                                                           |                    |
|                                                                                       |                    |
|                                                                                       |                    |
|                                                                                       |                    |
| 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>          |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+
| Create a restore point.                                                               |                    |
|                                                                                       |                    |
| 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.                                               |    <div><input     |
|                                                                                       |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
|                                                                                       |    unchecked>      |
|                                                                                       |    <label          |
|                                                                                       |    for='isdone'>   |
|                                                                                       |    Done</label>    |
|                                                                                       |    </div>          |
|                                                                                       |                    |
|                                                                                       |                    |
| VOSS cannot guarantee that a restore point can be used to successfully                |                    |
| restore VOSS Automate. If you cannot                                                  |                    |
| restore the application from a restore point, your only recourse is to reinstall      |                    |
| the application.                                                                      |                    |
|                                                                                       |                    |
|                                                                                       |                    |
|                                                                                       |                    |
| 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**                                                                 |                    |
|                                                                                       |                    |
+---------------------------------------------------------------------------------------+--------------------+

.. _upgrade-Script:

Upgrade 
...........................



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

+---------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                 | Notes and Status   |
+=======================================================================================+====================+
| It is recommended that the upgrade steps                                              |                    |
| are run in a terminal opened with the **screen** command.                             |                    |
|                                                                                       |                    |
| * **screen**                                                                          |                    |
|                                                                                       |                    |
|                                                                                       |                    |
| Run (optionally with command parameters below):                                       |                    |
|                                                                                       | .. raw:: html      |
|                                                                                       |                    |
|                                                                                       |                    |
| * **app install media/<script_file>**                                                 |    <div><input     |
|                                                                                       |    type='checkbox' |
|                                                                                       |    id='done'       |
|                                                                                       |    name='done'     |
|                                                                                       |    unchecked>      |
|                                                                                       |    <label          |
|                                                                                       |    for='isdone'>   |
|                                                                                       |    Done</label>    |
| From release 19.1.2 and later, the ``delete-on-success`` parameter                    |    </div>          |
| and ``yes`` or ``no`` value have been added to remove or keep the the script file in  |                    |
| the ``media/`` directory after successful installation.                               |                    |
|                                                                                       |                    |
| Note that during the upgrade, phone registration data is cleared. A message will      |                    |
| show in the log: ``Remove phone registration data``. This is required so that old     |                    |
| values are not displayed, since after the upgrade this information is no longer       |                    |
| stored in the resource cache.                                                         |                    |
+---------------------------------------------------------------------------------------+--------------------+



.. _Post-Upgrade-Security-Health-Steps:

Post-Upgrade, Security and Health Steps 
................................................



.. 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>          |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+
| Check for needed security updates.                                                   |                    |
|                                                                                      |                    |
| * **security check**                                                                 |                    |
|                                                                                      |                    |
| If one  or more updates are required, complete all the security updates.             |                    |
|                                                                                      |                    |
|                                                                                      | .. raw:: html      |
| * **security update**                                                                |                    |
|                                                                                      |    <div><input     |
|                                                                                      |    type='checkbox' |
|                                                                                      |    id='done'       |
|                                                                                      |    name='done'     |
| Note: *if the system reboots, do not carry out the next manual reboot step*.         |    unchecked>      |
|                                                                                      |    <label          |
| Manual reboot *only if needed*:                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
|                                                                                      |    </div>          |
| * **system reboot**                                                                  |                    |
|                                                                                      |                    |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+


.. _standalone_Post-Template-Upgrade-Tasks:

Post Template Upgrade Tasks
...........................

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

+--------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                                | Notes and Status   |
+======================================================================================+====================+
|                                                                                      |                    |
| **Customized ``data/Settings``**                                                     |                    |
|                                                                                      |                    |
| Merge the previously backed up customized ``data/Settings`` with the latest settings |                    |
| on the system by manually adding the differences or exporting the latest settings    |                    |
| to JSON, merging the customized changes and importing the JSON.                      |                    |
|                                                                                      |                    |
|                                                                                      |                    |
| **Support for VG400 and VG450 Analogue Gateways**                                    |                    |
|                                                                                      |                    |
| Before adding the VG400 or VG450 Gateway, the ``device/cucm/GatewayType``            |                    |
| model needs to be imported for each Unified CM.                                      |                    |
|                                                                                      |                    |
| 1. Create a Model Type List which includes the ``device/cucm/GatewayType`` model.    |                    |
| 2. Add the Model Type List to all the required Unified CM Data Syncs.                |                    |
| 3. Execute the Data Sync for all the required Unified CMs.                           |                    |
|                                                                                      |                    |
| **Verify the upgrade**                                                               | .. raw:: html      |
|                                                                                      |                    |
| Log in on the GUI and check the information contained in the **About > Version**     |                    |
| menu. Confirm that versions have upgraded.                                           |    <div><input     |
|                                                                                      |    type='checkbox' |
| * **Release** should show 21.2                                                       |    id='done'       |
| * **Platform Version** should show 21.2                                              |    name='done'     |
|                                                                                      |    unchecked>      |
|                                                                                      |    <label          |
|                                                                                      |    for='isdone'>   |
|                                                                                      |    Done</label>    |
| If your web browser cannot open the user interface, clear your browser cache before  |    </div>          |
| trying to open the interface again.                                                  |                    |
|                                                                                      |                    |
+--------------------------------------------------------------------------------------+--------------------+
|                                                                                      |                    |
|                                                                                      | .. 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-Adaptations:

Restore Adaptations
...................

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

+------------------------------------------------------------------------------------+--------------------+
| Description and Steps                                                              | Notes and Status   |
+====================================================================================+====================+
|                                                                                    |                    |
| Restore and adaptations prior to upgrade.                                          |                    |
|                                                                                    |                    |
| If the release is accompanied by Upgrade Notes, refer to the details on adaptation | .. raw:: html      |
| impact.                                                                            |                    |
|                                                                                    |    <div><input     |
|                                                                                    |    type='checkbox' |
|                                                                                    |    id='done'       |
|                                                                                    |    name='done'     |
|                                                                                    |    unchecked>      |
|                                                                                    |    <label          |
|                                                                                    |    for='isdone'>   |
|                                                                                    |    Done</label>    |
|                                                                                    |    </div>          |
|                                                                                    |                    |
+------------------------------------------------------------------------------------+--------------------+

.. _standalone_Restore_Schedules:

Restore Schedules
.................


.. 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 GUI 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_Log-Files-Error-Checks:


Log Files and Error Checks
..........................

.. 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      |
|                                                                                  |                    |
| 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 GUI 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>          |
|                                                                                  |                    |
+----------------------------------------------------------------------------------+--------------------+






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