.. _upgrade-ISO-before-upgrade:

Before upgrading
-----------------------------

.. _24.2|EKB-22058:
.. _25.1|VOSS-1434:
.. _25.4|EKB-13086:
.. _25.4|VOSS-1470:


.. important::   

   Before upgrading, check if the boot password is enabled.
   Use the command: ``system boot password``.

   If it is enabled, the password should either be:

   *  disabled using the command ``system boot password disable``

   or 

   * enabled and updated to a known value using the command ``system boot password enable``

   For details, refer to the topic: "System Boot Passwords" in the Platform Guide. 


Dependencies
..............

The supported upgrade paths to release 25.4 using this ISO upgrade:

* ``24.x`` > ``25.4``


Versions
..........

Before starting with this upgrade, please read the following notes related to upgrades from 
earlier versions of the software. 

.. rubric:: Model Instance Filters

From release 25.4 onwards, a uniqueness constraint is applied to Model Instance Filter (MIF) names
across all hierarchies. 

Before upgrading to release 25.4, remove duplicate Model Instance Filters (MIF's) above HCS hierarchy level.
A pre-check script will stop the upgrade if duplicates are found.

A migrate script for Delta Bundle upgrades runs to detect duplicate names across hierarchies and
to automatically rename these using the following convention for duplicates downwards in the hierarchy:
   
``{original_name}_dup_{zero-padded 3 digit number}``, e.g.: `_dup_001`, `_dup_002`.



.. rubric:: Microsoft PowerShell integration 

.. important::

   Microsoft customers: 
   
   * Before proceeding with the upgrade to 25.4 and when using UC Automation for Microsoft Teams and Microsoft Exchange,
     please contact VOSS to assist regarding memory requirements for the PowerShell service on unified and application nodes.
     Additional memory of at least 8GB of RAM may need to be available.

     .. raw:: html
     
        For details, refer to <a href="automate-system-hardware-specification.html">VOSS Product suite hardware specifications</a>.

     
   * During the upgrade to 25.3, a migration will be performed on all Microsoft Tenant instances. Please export all
     existing instances of the Microsoft Tenant configurations (``relation/MicrosoftTenant``) to Excel or JSON prior
     to upgrading, to be used as a reference in case connectivity issues to either MSGraph or PowerShell are encountered
     during the upgrade.   
   



.. rubric:: Release 24.2 - Sync and Dashboard Management

* After upgrade to release 24.2, dashboard management is available after 30 minutes,
  since the scheduled ``delta-sync`` process initially carries out a *full sync* and thereafter
  an incremental resource sync. No manual sync is therefore required after upgrade.
  For details, see the Insights Analytics section of the Platform Guide.

* Ensure that: 

  * An additional 70 GB disk is available for the Insights database
  * All application and database nodes memory allocation is 32 GB with 32 GB reservation

    .. raw:: html 

       See: <a href="../platform/tasks-backup-restore-new-add-more-space-large-restore.html">Adding Hard Disk Space</a>
       and <a href="automate-system-hardware-specification.html">VOSS Hardware Specifications</a>.

    .. raw:: latex

       See *Adding Hard Disk Space* in the Platform Guide and *VOSS Hardware Specifications* in the Architecture and Hardware Specification Guide.

    This disk is needed to assign to the ``insights-voss-sync:database`` mount point. See :ref:`upgrade-ISO-mount-insights-disk`.
 


.. rubric:: Release 24.1 onwards - Microsoft Teams, Deprecation of Basic Authentication 

Starting with Automate 24.1, Microsoft PowerShell must be set up for app (application) registration for 
authentication. 

See the following references: 

* `VOSS Automate 24.1 - Microsoft Customers, Upgrade Planning for App Registration <https://documentation.voss-solutions.com/release_24.1-PB1/html/VOSS-Automate-24.1-Microsoft-Customers-Upgrade-Planning-for-App-Registration.pdf>`_ 

* 
  .. raw:: html

     <a href="../create-msteams-service-acc-azure.html">Create MS Teams Service Account on Microsoft Cloud</a>

  .. raw:: latex

     Create MS Teams Service Account on Microsoft Cloud in the Core Feature Guide


.. rubric:: Release 24.1 onwards - Virtual Machine and ESXi Version Compatibility, and AVX Support  

Before starting your upgrade, ensure that the hardware version of each of your virtual machines (VMs) is at least 
version 11, compatible with ESXi 6.0 and up, and that your host CPU supports AVX (Advanced Vector Extensions). 

A ``cluster check`` command in the Automate pre-upgrade steps checks for AVX support. To 
ensure that AVX support is added to the VMs, you'll need to upgrade the compatibility of the VM in vCenter.  


.. rubric:: Before upgrading to release 24.1:

* Install ``EKB-21455-21.4.0_patch.script`` first. Refer to ``MOP-EKB-21455-21.4.0_patch.pdf``.

  * **Server Name**: https://voss.portalshape.com
  * **Path**: **Downloads > VOSS Automate > 24.1 > Upgrade > ISO**
  * **MOP**: MOP-EKB-21455-21.4.0_patch.pdf
  * **Patch File**: EKB-21455-21.4.0_patch.script


Maintenance windows and upgrade duration
.........................................

.. note:: 

   Release 25.2 installed ``tmux`` to replace ``screen``. If you are upgrading from earlier than 25.2:

   * The ``screen`` command should be used where indicated *before* the upgrade. See: :ref:`screen-command`.
   * The ``tmux`` command should be used where indicated *after* the upgrade. See: :ref:`tmux-command`.

   If you are upgrading from 25.2:

   * The ``tmux`` command should be used throughout. See: :ref:`tmux-command`.


Normal operations will be interrupted during an upgrade. Perform the upgrade in a maintenance 
window. Refer to the type of upgrade for details on the upgrade duration.

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 reduced downtime.

Ensure that sufficient time is allocated to the maintenance window. This may vary in accordance with your 
topology, number of devices and subscribers.

The information below serves as a guideline: 

.. note:: 
  
   Contact VOSS support if further guidance is required.

* Cluster upgrade: 4h
* Template install: 2.5h
* For a 500K Data User system (13Mil RESOURCE documents), the expected ``upgrade_db`` step is about 12h.
* For a 160K Data User system (2.5Mil RESOURCE documents), the expected ``upgrade_db`` step is about 2.5h.

You can follow the progress on the Admin Portal transaction list.

