.. _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: | |
| | |
| |
|
| | |
| | |
| Or using SCP: | |
| | |
| | |
| * **scp platform@:~/media** | |
| | |
| | |
| | |
| Verify that the ``.script`` file copied: | |
| | |
| | |
| * **ls -l media/** | |
| | |
| | |
| Verify that the original ``.sha256`` checksums on the | |
| SFTP server match. | |
| | |
| | |
| * **system checksum media/** | |
| | |
| ``Checksum: `` | |
| | |
| | |
+------------------------------------------------------------------------------------------+--------------------+
.. _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 |
| | |
| |
|
| | |
| |
|
| | |
+-------------------------------------------------------------------------------------------+--------------------+
.. _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. |
|
| window. | |
| |
|
| | |
| | |
+----------------------------------------------------------------------------------------------+--------------------+
| 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 |
| | |
| |
|
| | |
| |
|
| | |
| | |
+----------------------------------------------------------------------------------------------+--------------------+
| | |
| **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 |
| | |
| |
|
| | |
| |
|
| | |
| | |
+----------------------------------------------------------------------------------------------+--------------------+
.. _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 |
| | |
| |
|
| | |
| |
|
| | |
+---------------------------------------------------------------------------------------+--------------------+
| 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. |
|
| | |
| |
|
| | |
| | |
| 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 ** and | |
| **backup create ** 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 |
| | |
| |
|
| | |
| 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/** |
|
| | |
| From release 19.1.2 and later, the ``delete-on-success`` parameter |
|
| 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. | |
+---------------------------------------------------------------------------------------+--------------------+
.. 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
.. _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 |
| | |
| |
|
| | |
| |
|
| | |
+--------------------------------------------------------------------------------------+--------------------+
| 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 |
| | |
| |
|
| | |
| |
|
| | |
+--------------------------------------------------------------------------------------+--------------------+
| Check for needed security updates. | |
| | |
| * **security check** | |
| | |
| If one or more updates are required, complete all the security updates. | |
| | |
| | .. raw:: html |
| * **security update** | |
| |
|
| | |
| |
|
| * **system reboot** | |
| | |
| | |
+--------------------------------------------------------------------------------------+--------------------+
.. _standalone_Post-Template-Upgrade-Tasks:
Post Template Upgrade Tasks
...........................
.. 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. | |
| | |
| **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. |
|
| | |
| If your web browser cannot open the user interface, clear your browser cache before |
|
| trying to open the interface again. | |
| | |
+--------------------------------------------------------------------------------------+--------------------+
| | |
| | .. raw:: html |
| | |
| |
|
| | |
| |
|
| | |
| | |
+--------------------------------------------------------------------------------------+--------------------+
.. _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. | |
| |
|
| | |
| |
|
| | |
+------------------------------------------------------------------------------------+--------------------+
.. _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: |
**. | unchecked> |
| | |
| |
|
| | |
| | |
+---------------------------------------------------------------------------------+--------------------+
.. _delta-standalone-upgrade-release-specific-updates:
Release Specific Updates
................................................
.. tabularcolumns:: |p{13.5cm}|p{4cm}|
+-----------------------------------------------------------------------------------------------+--------------------+
| Description and Steps | Notes and Status |
+===============================================================================================+====================+
| | |
| 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. |
|
| | |
| |
|
+-----------------------------------------------------------------------------------------------+--------------------+
.. _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: |
|
| 'log view platform/execute.log' | |
| directory to an SFTP server: |
|
| | |
| * **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 |