Performing online upgrade by using the installation toolkit

Use the following procedure to do an online upgrade of IBM Storage Scale by using the installation toolkit.

Download the new IBM Storage Scale self-extracting package by using the substeps and then place it on the installer node.
1. Go to the IBM Storage Scale page on Fix Central, select the new package, and then click Continue.
2. Choose the download option Download using Download Director to download the new spectrumscale package and place it in the wanted location on the install node.
  Note: If you use Download using your browser (HTTPS), do not click the down arrow to the left of the package name. Instead, right-click on the package name and select the Save Link As option. If you click the download arrow, the browser might hang.
Extract the new IBM Storage Scale self-extracting package by using the package name.
/tmp/Spectrum_Scale_Standard-5.2.3.x_x86_64-Linux_install

This step creates a new directory structure (/usr/lpp/mmfs/5.2.3.x/).
Accept the license agreement.
After the self-extracting package extraction is done, several next steps and instructions are displayed on the screen.
- Cluster installation and protocol deployment
- Upgrading an existing cluster by using the installation toolkit
- Adding nodes to an existing cluster by using the installation toolkit
- Adding NSDs or file systems to an existing cluster by using the installation toolkit
Depending on your setup, do one of the following sets of steps to obtain the current cluster configuration through the cluster definition file:
- If you are upgrading an IBM Storage Scale cluster that is created by using the installation toolkit, do these steps to upgrade by using the installation toolkit.
  Note: If you used the installation toolkit for the initial installation and deployment, it is assumed that the prerequisites are already in place.
  1. If you want to change the installer node before the upgrade, issue the spectrumscale setup -s InstallNodeIP command to set up the new installer node.
  2. From the installer directory of the target version that you are upgrading to, populate the cluster definition file with the current cluster state by issuing the ./spectrumscale config populate command. For more information, see Populating cluster definition file with current cluster state using the installation toolkit and Limitations of config populate option of the installation toolkit.
    If the command fails, update the cluster definition file with the cluster state change operations that were done after the initial installation and deployment by using the ./spectrumscale commands. These cluster state change operations include:
    - Node-related changes such as adding nodes
    - NSD-related changes such as adding or modifying NSDs
    - File system changes such as creating or modifying file systems
    - Protocols-related changes such as enabling or disabling protocols
- If you are upgrading a manually created IBM Storage Scale cluster, do these steps to upgrade by using the installation toolkit.
  1. Ensure that the prerequisite steps for using the installation toolkit are completed. For more information, see Preparing to use the installation toolkit.
  2. Configure your cluster definition file as explained in the following topics:
    - Setting up the installer node
    - Defining the cluster topology for the installation toolkit
  3. From the installer directory of the target version that you are upgrading to, populate the cluster definition file with the current cluster state by issuing the ./spectrumscale config populate command. For more information, see Populating cluster definition file with current cluster state using the installation toolkit and Limitations of config populate option of the installation toolkit.
    If the config populate command fails, update the cluster definition file with the cluster state change operations that were done after the initial installation and deployment by using the ./spectrumscale commands. These cluster state change operations include:
    - Node-related changes such as adding nodes
    - NSD-related changes such as adding or modifying NSDs
    - File system changes such as creating or modifying file systems
    - Protocols-related changes such as enabling or disabling protocols
Ensure that the cluster definition file is accurate and reflects the current state of your IBM Storage Scale cluster.

If you want to upgrade IBM Storage Scale on IBM Storage Archive Enterprise Edition (EE) nodes by using the installation toolkit, you must do some additional steps to manage IBM Spectrum Archive components. For more information, see Upgrading IBM Storage Scale on IBM Storage Archive Enterprise Edition (EE) nodes by using the installation toolkit.
Run the upgrade precheck by using the ./spectrumscale upgrade precheck command.
Important: It is highly recommended to run the upgrade precheck while you are planning to upgrade. Doing this step gives you adequate time to address any issues that are flagged during the upgrade precheck.
For any cluster with existing performance monitoring collectors, the upgrade prechecks might find that a reconfiguration is needed. To enable the installation toolkit to do the reconfiguration, issue the following command:
```
./spectrumscale config perfmon -r on
```
To keep your existing algorithms, issue the following command:
```
./spectrumscale config perfmon -r off
```
To do an offline upgrade based on the findings in the precheck results, do the steps in Designating nodes as offline in the upgrade configuration.
Run the upgrade process by using the ./spectrumscale upgrade run command.
Accept the warnings for system impact and interruption during the upgrade.
Note: On Ubuntu nodes, if the call home capability is enabled, after upgrading the call home packages to version 5.0.1 or later, issue the following commands from one of the nodes that is a part of a call home group.
```
mmcallhome capability disable
mmcallhome capability enable accept
```
After the upgrade is completed, the installation toolkit automatically runs the upgrade post checks. You can manually run the upgrade post checks by issuing the ./spectrumscale upgrade postcheck command.
If the fresh upgrade is not successful, do an upgrade rerun as needed. For more information, see Upgrade rerun after an upgrade failure.
After the upgrade process is done, complete the upgrade to the new code level to take advantage of the new functions. For more information, see Completing the upgrade to a new level of IBM Storage Scale.
Do the protocols authentication configuration that is required after you upgrade protocol nodes. For more information, see Protocol authentication configuration changes during upgrade.