Method of Procedure (MOP) for 21.4 Patch Bundle 1 Installation#

Dependencies#

  • Release 21.4

The supported upgrade path for this Patch Bundle Upgrade is:

21.4

Patch Overview#

  • Patch Name: 21.4.PB1-Delta-Bundle-patch.script

  • Features Included: See release notes for detail.

  • SHA256 Checksum: 7b7236543d538e882f92183dd165f0154941b7df8c31fe1be88815918a5eb30f

Important Information:#

Download Location#

The Patch and the MOP are available here:

  • Server Name: https://voss.portalshape.com

  • Path: Downloads > VOSS Automate > 21.4 > Patches

  • Patch Directory: Patch Bundle 1

  • Patch File: 21.4-PB1-Delta-Bundle-patch.script

  • MOP File (this file): MOP-21.4-PB1-Delta-Bundle-patch.pdf

Important

  • We recommend taking snapshots of all nodes that are part of the cluster before applying the patch - to be used for rollback if needed.

  • About Adaptations: We recommend verifying the compatibility of any installed adaptations with this patch bundle in a lab before installing in production. Some adaptations might need to be re-installed post patch bundle installation.

  • If you have a Microsoft-only environment and an existing number inventory, a rebuild may be needed.

    Contact VOSS to verify and assist in carrying out this step.

  • It is recommended that commands in installation steps are run in a terminal opened with the screen command.

  • For release 21.4-PB1, firewall modifications may be required to enable communication between the VOSS Automate unified/application nodes and the PowerShell Proxy server on TCP Port 5986. This should be considered as part of upgrade planning.

    For details on changing VOSS Automate and MS Proxy to communicate over HTTPS, refer to the Set up PowerShell Proxy section in the Microsoft Apps Management chapter of the Core Feature Guide.

Install Procedure for a Unified Node Topology#

Download Patch Script and Check#

Note

It is recommended that the file download is done prior to the maintenance window.

Download the following file

  • 21.4-PB1-Delta-Bundle-patch.script

to the media folder on the primary unified node.

Verify SHA256 checksum#

To verify SHA256 checksum for the patch, run the following command on the node the script was downloaded to:

  • Command : system checksum media/21.4-PB1-Delta-Bundle-patch.script

  • Expected: 7b7236543d538e882f92183dd165f0154941b7df8c31fe1be88815918a5eb30f

Pre-Installation, Version Check#

The release version should be 21.4:

  • Log in on the GUI and check the information contained in the menu About > Version > Release. The release version should be 21.4

Pre-Installation, Security and Health Steps#

  1. Verify that the primary database node is the active primary node at the time of upgrade.

    On the Primary Unified Node, run:

    database config

    This is to ensure that the node on which the installation will be initiated, has the:

    1. stateStr parameter set to PRIMARY

    2. highest priority number (highest priority number could vary depending on cluster layout).

    Example output

    <ip address>:27020:
priority: <number>
stateStr: PRIMARY
storageEngine: WiredTiger

  2. Validate the system health.

    On the primary unified node, run:

    cluster status

  3. Verify network connectivity, disk status, NTP and that there are no pending Security Updates.

    On the primary unified node, run:

    cluster check

    cluster run all diag disk

    If there is any sign of the paths below are over 80% full, a clean-up is needed to avoid risk of for example 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)

    On the primary unified node, run:

    cluster run all security check

    If there are pending Security Updates, then:

    On the primary unified node, run:

    cluster run all security update

    Then reboot all nodes:

    cluster run notme system reboot

    (If node messages: <node name> failed with timeout are displayed, these can be ignored.)

    system reboot

    Since all services will be stopped, this takes some time.

  4. Shutdown servers and take snapshots from VMWare.

    On the primary unified node, run:

    cluster run notme system shutdown

    Then after 1 minute: run:

    system shutdown

Patch Installation#

On the primary unified node, run:

app install media/21.4-PB1-Delta-Bundle-patch.script

Note

Before the patch installation starts, the user is prompted to:

  • Continue with the installation.

    Append the --force parameter to remove this prompt.

  • Delete or keep the patch script in the media directory after installation.

    Append the delete-on-success parameter with a yes|no value to the command to remove this prompt.

To remove all prompts, use the command and parameters:

app install media/21.4-PB1-Delta-Bundle-patch.script delete-on-success yes --force

Post-Upgrade, Security and Health Steps#

  1. On the primary node, verify the cluster status:

    • cluster status

  2. On each node verify security updates, network connectivity, disk status and NTP.

    • cluster check

  3. If there are pending Security Updates, then run security update on all nodes. On the primary node, run:

    • cluster run all security update

  4. Reboot all nodes:

    • cluster run notme system reboot

    (If node messages: <node name> failed with timeout are displayed, these can be ignored.)

    • system reboot

    Since all services will be stopped, this takes some time.

Install Procedure for a Modular Cluster Topology#

Download Patch Script and Check#

Note

It is recommended that the file download is done prior to the maintenance window.

Download the following file

  • 21.4-PB1-Delta-Bundle-patch.script

to the media folder on primary application node.

To check for this node:

  1. Log in on a node in your modular cluster.

  2. To find the primary application node in the cluster:

    $ cluster run all cluster primary role application

    Record the node entry where is_primary: true, for example:

    ---------- VOSS-UN-1, ip=192.168.100.3, role=webproxy,application, loc=cpt

    is_primary: true

Verify SHA256 checksum#

To verify SHA256 checksum for the patch, run the following command on the node the script was downloaded to:

  • Command : system checksum media/21.4-PB1-Delta-Bundle-patch.script

  • Expected: 7b7236543d538e882f92183dd165f0154941b7df8c31fe1be88815918a5eb30f

Pre-Installation, Version Check#

The release version should be 21.4:

  • Log in on the GUI and check the information contained in the menu About > Version > Release. The release version should be 21.4

Pre-Installation, Security and Health Steps#

  1. Verify that the primary database node is the active primary node at the time of upgrade.

    Have the IP address available of the node determined to be the primary database node. To find the primary database node in the cluster:

    $ cluster run all cluster primary role database

    Record the node entry IP where is_primary: true, for example:

    ---------- VOSS-UN-2, ip=192.168.100.4, role=database, loc=cpt


    is_primary: true

    This IP address will be used in command parameters during upgrade.

    Verify that the primary database node is the active primary node at the time of upgrade.

    On the primary application node, run:

    cluster run <primary db IP> database config

    From the output, ensure that the primary database node stateStr parameter is set to PRIMARY and it has the highest priority:<number> (highest priority number could vary depending on cluster layout).

    Example output

    <ip address>:27020:
  priority: <number>
  stateStr: PRIMARY
  storageEngine: WiredTiger

  2. Validate the system health.

    On the primary application node, run:

    cluster status

  3. Verify network connectivity, disk status, NTP and that there are no pending Security Updates.

    On the primary application node, run:

    cluster check

    cluster run all diag disk

    If there is any sign of the paths below are over 80% full, a clean-up is needed to avoid risk of for example 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)

    On the primary application node, run:

    cluster run all security check

    If there are pending security updates, then:

    On the primary application node, run:

    cluster run all security update

    Then reboot all nodes:

    cluster run notme system reboot

    (If node messages: <node name> failed with timeout are displayed, these can be ignored.)

    system reboot

    Since all services will be stopped, this takes some time.

  4. Shutdown servers and take snapshots from VMWare.

    On the primary application node, run:

    cluster run notme system shutdown

    Then after 1 minute: run:

    system shutdown

Patch Installation#

On the primary application node, run:

app install media/21.4-PB1-Delta-Bundle-patch.script

Note

Before the patch installation starts, the user is prompted to:

  • Continue with the installation.

    Append the --force parameter to remove this prompt.

  • Delete or keep the patch script in the media directory after installation.

    Append the delete-on-success parameter with a yes|no value to the command to remove this prompt.

To remove all prompts, use the command and parameters:

app install media/21.4-PB1-Delta-Bundle-patch.script delete-on-success yes --force

Post-Upgrade, Security and Health Steps#

  1. On the primary application node, verify the cluster status:

    • cluster status

  2. On each node verify Security Updates, network connectivity, disk status and NTP.

    • cluster check

  3. If there are pending Security Updates, then run security update on all nodes. On the primary application node, run:

    • cluster run all security update

  4. Reboot all nodes:

    • cluster run notme system reboot

    (If node messages: <node name> failed with timeout are displayed, these can be ignored.)

    • system reboot

    Since all services will be stopped, this takes some time.

Install Procedure for a Single Node Cluster Environment#

Download Patch Script and Check#

Note

It is recommended that the file download is done prior to the maintenance window.

Download the following file

  • 21.4-PB1-Delta-Bundle-patch.script

to the media folder on the single node.

Verify SHA256 checksum#

To verify SHA256 checksum for the patch, run the following command on the node the script was downloaded to:

  • Command : system checksum media/21.4-PB1-Delta-Bundle-patch.script

  • Expected: 7b7236543d538e882f92183dd165f0154941b7df8c31fe1be88815918a5eb30f

Pre-Installation, Version Check#

The release version should be 21.4:

  • Log in on the GUI and check the information contained in the menu About > Version > Release. The release version should be 21.4

Pre-Installation, Security and Health Steps#

  1. Verify that the primary database node is the active primary node at the time of upgrade.

    On the single node, run:

    database config

    This is to ensure that the node on which the installation will be initiated, has the:

    1. stateStr parameter set to PRIMARY

    2. highest priority number (highest priority number could vary depending on cluster layout).

    Example output

    <ip address>:27020:
priority: <number>
stateStr: PRIMARY
storageEngine: WiredTiger

  2. Validate the system health.

    On the single node, run:

    app status

  3. Verify network connectivity, disk status, NTP and that there are no pending Security Updates.

    On the single node, run:

    diag disk

    If there is any sign of the paths below are over 80% full, a clean-up is needed to avoid risk of for example 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)

    On the single node, run:

    security check

    If there are pending Security Updates, then run:

    security update

    Then reboot:

    system reboot

    Since all services will be stopped, this takes some time.

  4. Shutdown servers and take snapshots from VMWare.

    Run:

    system shutdown

Patch Installation#

On the single node, run:

app install media/21.4-PB1-Delta-Bundle-patch.script

Note

Before the patch installation starts, the user is prompted to:

  • Continue with the installation.

    Append the --force parameter to remove this prompt.

  • Delete or keep the patch script in the media directory after installation.

    Append the delete-on-success parameter with a yes|no value to the command to remove this prompt.

To remove all prompts, use the command and parameters:

app install media/21.4-PB1-Delta-Bundle-patch.script delete-on-success yes --force

Post-Upgrade, Security and Health Steps#

Verify Security Updates, network connectivity, disk status and NTP.

On the single node, run:

  • app status

  • diag disk

  • security check

If there are pending Security Updates, then run security update.

On the single node, run:

  • security update

Reboot.

On the single node, run:

  • system reboot

Since all services will be stopped, this takes some time.

Post-Checks#

Generic System Tests:

  • Ensure all services are running on all nodes using app status.

  • Log in to Administration Portal, go to About > Version > Patch Bundle and ensure that the Patch Bundle number 1 is displayed.

  • Log in to the Administration Portal of all the nodes using an administrator account.

  • Log in to the Self-service Portal of all the nodes using a Self-service account.

  • Log in to the Business Admin Portal on all nodes using an administrator account with a Role configured for access to the Business Admin Portal and verify functionality. (For Role Configuration, please refer to the Business Admin Portal Quickstart Guide).

Post-upgrade steps for Microsoft Environments#

Note

  • Upon upgrade to release 21.4-PB1, communication between VOSS Automate and the Windows PowerShell Proxy will be encrypted by default using HTTPS, as recommended by Microsoft. The port used for secure communication is TCP 5986 instead of TCP 5985 which is used for insecure HTTP . To revert back to using insecure HTTP communication post upgrade, a new driver parameter: winrm_transport can be manually added to the data/MSTeamsOnline instance with a value of plaintext. Reverting back to insecure communication is only recommended as a temporary measure while the PowerShell Proxy is being configured for secure communication.

  • Refer to the Best Practices Guide for important changes related to Quick Import setting on MS Data syncs and the section on “Limiting ‘Update User’ Workflows for MS Data Syncs”.

  • If the below full sync was done after the initial 21.4 upgrade, then it is NOT needed again after upgrading to 21.4 PB1. (These steps do NOT have to be carried out in a maintenance window)

  1. Do a full MS Teams sync.

    This is needed to pull in the data from Teams for the updates drivers and schemas due to the PowerShell 4 changes. This applies specifically to changes on CSOnlineUser as well as new policies, emergency, etc.

    If you have custom MTLs or syncs, review these for inclusion of new elements supporting in this release. For details on new elements, refer to the Upgrade Notes for VOSS Automate 21.4 Patch Bundle 1.

    Alternatively, use no MTL for a full sync.

    Important

    This sync should be run on all tenants in the system.

  1. For Microsoft-only environments:

    If you have a Microsoft-only environment and in particular an inventory containing numbers in the non-”\+” format, an inventory rebuild may be needed. Contact VOSS to verify and assist in carrying out this step.