.. _upgrade-standalone_delta: .. rst-class:: chapter-with-expand Upgrade a Standalone Environment with the Delta Bundle ------------------------------------------------------ .. index:: voss;voss post-upgrade-migrations .. index:: screen .. index:: database;database convert_drive .. _19.1.2|EKB-2262: .. _19.2.1|VOSS-497: .. _19.2.1|VOSS-497|EKB-3126: .. 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. From VOSS-4-UC 18.1 or CUCDM 11.5.3 onwards, the standard **screen** command should be used where indicated, and the `reconnect` parameter is available if needed: * **screen** - start a new session * **screen -ls** - show sessions already available * **screen -r [screen PID]** - reconnect to a disconnected session We recommend using the **screen** command to avoid failures if the connection is interrupted whilst running the command. If the connection is interrupted whilst running the command in ``screen`` then the session can be retrieved by first listing the sessions PID currently running in screen: **screen -ls**, and then reconnecting to the session using **screen -r [screen PID]**. The version of **screen** used in VOSS-4-UC also supports the creation of a log file. If long-running commands will be run, the log file captures screen console output up to the session timeout. A message shows: :: timed out waiting for input: auto-logout To create a screen log file: 1. Run **screen** and wait for screen to open. 2. Press **-a** then **:** (colon). This will enter screen command mode at the bottom of the console. 3. Create your screen logfile in the ``media/`` directory: a. In screen command mode, type **logfile media/.log** #. Press **** #. Press **-a** and then **H** to start writing to the log file #. Run your commands. If the **screen** session times out, you can obtain console output from the log file, for example: **$ sftp platform@:media/.log** .. _standalone_Download-Files-and-Check: Download Files and Check ........................ .. tabularcolumns:: |p{13.5cm}|p{4cm}| +--------------------------------------------------------------------------------+--------------------+ | Description and Steps | Notes and Status | +================================================================================+====================+ | | | | VOSS SFTP server: ``secure.voss-solutions.com`` | | | | | | Download ``XXX-Delta-Bundle.script`` file from the VOSS SFTP server. | | | Transfer the ``XXX-Delta-Bundle.script`` file to the ``media/`` folder. | | | Two transfer options: | .. raw:: html | | | | | Either using SFTP: | | | | | | |
** | type='checkbox' | | | id='done' | | * **cd media** | name='done' | | | unchecked> | | * **put ** | | | |
| | | | | | | | 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 | | | | | |
| | | | | |
| | | | +-------------------------------------------------------------------------------------------+--------------------+ | Run template customization audits at the ``sys`` and ``sys.hcs`` hierarchy levels | | | to identify template definitions and instances that were not | | | delivered in the standard template packages during an installation or upgrade. | | | | | | The audit report includes custom model schema definitions as well as data, | | | domain, and view instances created on the hierarchy node as a result of | | | workflow execution. If the release is accompanied by Upgrade Notes, refer to the details. | .. raw:: html | | | | | 1. Log in as an administrator above Provider level that has access to the hierarchies. |
Reports > Audit Template Customization**. | type='checkbox' | | 3. Choose the hierarchy node for which you want to audit customized templates. | id='done' | | 4. Click **Save**. | name='done' | | | unchecked> | | View the audit report: | | | A list of template customization audit reports is displayed. |
| | 6. Click a report to view the details. | | | The message field shows how many customized templates were found at the | | | hierarchy node. The details fields lists the model type and instance of each | | | customized template. Record and / or export the report details so that any | | | adaptations to models can be restored during the post-upgrade steps. | | +-------------------------------------------------------------------------------------------+--------------------+ .. _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. |
| | | | | |
| | | | | | | +----------------------------------------------------------------------------------------------+--------------------+ | 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 | | | | | |
| | | | | |
| | | | | | | +----------------------------------------------------------------------------------------------+--------------------+ | 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 | | | | | |
| | | | | |
| | | | +---------------------------------------------------------------------------------------+--------------------+ | Shutdown server and take snapshots from VMWare and then restart server: | | | | | | Use VMware snapshots. Consider the following; | | | | .. raw:: html | | * VOSS cannot guarantee that a VMware snapshot can be used to successfully | | | restore VOSS-4-UC or any Cisco HCS Management application. If you cannot |
| | | | | * **system shutdown** |
| | | | | | | | Log into VMWare and take a snapshot. | | | | | | After the snapshot, restart: | | | | | | * Power up the servers via VMWare. | | | | | | Optional: If a backup is required in addition to the snapshot, 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 | +=======================================================================================+====================+ | From VOSS-4-UC 18.1 or CUCDM 11.5.3 onwards, 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/ delete-on-success yes --force** |
| | | | | |
| | | | +---------------------------------------------------------------------------------------+--------------------+ .. _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_Wired-Tiger: Database Filesystem Conversion .............................. .. important:: This step is to be carried out *only if* you have not converted the file system before. To check if the step is *not* required: 1. Run **database config** and ensure that the storage engine shows as ``storageEngine: WiredTiger``. #. Run **drives list** and ensure that the LVM storage shows for the converted database node under ``Volume Groups``. The **database convert_drive** command provides parameters allows 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 standalone 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. | | | |
| | | | | Boot the system in VMWare. |
| | Stop transactions from being scheduled. | | | | | | Run: | | | | | | * **database convert_drive standalone** | | | | | | Note: this step may take a while. 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 shows for the *database node* 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_Post-Template-Upgrade-Tasks: Post Template Upgrade Tasks ........................... .. tabularcolumns:: |p{13.5cm}|p{4cm}| +-------------------------------------------------------------------------------------------+--------------------+ | Description and Steps | Notes and Status | +===========================================================================================+====================+ | | | | Verify the upgrade: | .. raw:: html | | | | | Log in on the GUI and check the information contained in the **About > Extended 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 | | | | | |
| | | | | |
| | | | | | | +---------------------------------------------------------------------------------+--------------------+ .. _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 |
| | | | | |
| | | | +----------------------------------------------------------------------------------+--------------------+ .. |VOSS-4-UC| replace:: VOSS-4-UC .. |Unified CM| replace:: Unified CM