Manual Chapter : Upgrading iWorkflow

Applies To:

Show Versions Show Versions

F5 iWorkflow

  • 2.3.0
Manual Chapter

About upgrading iWorkflow

You can upgrade an iWorkflow™ system under the following conditions:

  • When you are running an iWorkflow standalone instance and you want to upgrade to a newer iWorkflow version.
  • When you are running an iWorkflow cluster and you want to upgrade to a newer iWorkflow version.

To upgrade iWorkflow standalone systems and clusters to new versions, make sure that you have:

  • Adequate disk space available to complete the installation.
  • Administrator rights on the iWorkflow system.
  • A recent user configuration set (UCS) backup of the iWorkflow system copied to a remote secure server for storage.
  • An iWorkflow release ISO file that is copied to the /shared/images directory.
  • Managed devices that are healthy.

Additional considerations when upgrading:

  • You can expect a service disruption to the management plane.
  • You should not expect a disruption to the data plane of the BIG-IP® systems that iWorkflow is managing.

Upgrading a standalone system

About upgrading a standalone system

During the upgrade process, the iWorkflow™ administrative interface is unavailable, but that does not impact the devices managed by iWorkflow. In most cases, after the iWorkflow upgrade is complete, you will need to update the representational state transfer (REST) framework on all managed BIG-IP® devices.

When installing new iWorkflow software images, you must run the software installation from an active boot location, and specify an inactive clean boot location as the target install location. This action is a result of the software installation copying the running configuration and license from the current boot location to the target install location.

It is possible to upgrade iWorkflow without importing the running configuration. For more information, see K13438: Controlling configuration import when performing software installations (11.x - 12.x) at support.f5.com.

Upgrading a standalone system

Before you start, make sure that you are running an iWorkflow™ standalone instance.
You upgrade a standalone system when you want to upgrade to a newer iWorkflow version.
Note: During the upgrade process, iWorkflow is not able to make changes, updates, or additions to any of the managed BIG-IP® systems.
  1. Log in to the iWorkflow command line.
  2. Run the command tmsh to access the tmsh utility.
  3. Run the command show /sys software to check the status of the currently installed iWorkflow software.

    The output displays something similar to the following example:

                                  
    
    ------------------------------------------------------------------------
    Sys::Software Status      
    Volume     Product            Version      Build     Active  Status    
                                                                
    ------------------------------------------------------------------------
    HD1.1      iWorkflow          2.0.0        0.0.9631  yes      complete   
    HD1.2           none          none         none      no       complete
    
    
                               
    
    Note: If the output displays only one volume, you can create a new volume during the installation process.
  4. Run the command install /sys software image <iworkflow-image.iso> volume <inactive volume> to install iWorkflow onto an existing inactive volume.
    <inactive volume> is the name of an inactive volume. For example, install /sys software image iworkflow.iso volume HD1.2.
  5. Optional: Run the command install /sys software image <iworkflow-image.iso> create-volume volume <new volume> reboot to automatically reboot after creating a new volume and installing iWorkflow into the new location.
    <new volume> is the name of a new volume. For example, install sys software image iWorkflow.iso create-volume volume HD1.3 reboot.
  6. Run the command quit to exit the tmsh utility.
    Note: If there is an upgrade failure, reboot to the previously active volume on which the previous iWorkflow version was installed, and if required, restore the backup to get the storage state back.
  7. After the installation is complete, if you did not use the reboot switch in your tmsh install command, you can manually reboot into the new volume by running the command: tmsh reboot volume <new iWorkflow volume>.
    <new workflow volume> is the name of the new volume. For example, tmsh reboot volume HD1.2.
  8. Once the system completes the installation and reboots into the new active volume, log in to the iWorkflow command line to review the status. Review the managed BIG-IP devices and confirm that the representational state transfer (REST) framework versions are current. Rediscover any BIG-IP devices that are unhealthy to force the REST framework update.
    Note: You can monitor the installation process by running the command: watch tmsh show /sys software. By default, the watch command automatically refreshes every two seconds.

    The output displays something similar to the following example:

                                  
    
     Every 2.0s: tmsh show /sys software                                    Fri Sep 13 11:14:08
     2016
    ------------------------------------------------------------------------
    Sys::Software Status      
    Volume     Product      Version  Build     Active                 Status    
                                                                
    ------------------------------------------------------------------------
    HD1.1      iWorkflow    2.0.0    0.0.9631  yes                   complete   
    HD1.2      iWorkflow    2.0.1    0.0.9855  no       installing 10.000 pct
    
    
                               
    
In most cases, after the iWorkflow upgrade is complete, you will need to update the REST framework on all managed BIG-IP devices by rediscovering the BIG-IP system. You can do this using the Discover Device button. For more information, see the Add a device section of the iWorkflow Ops guide at devcentral.f5.com.

Upgrading a cluster

Breaking a cluster

Before you start, make sure that you are running an iWorkflow™ cluster.
You break a cluster by using a lead peer to evict the two sibling peers.
Note: During the upgrade process, iWorkflow is not able to make changes, updates, or additions to any of the managed BIG-IP® systems.
  1. Log in to the iWorkflow administrative user interface with your administrator user name and password. For example: https://10.10.99.5/ui/login.
  2. At the top of the screen, click System settings.
  3. From the iWorkflow Cluster panel, select an iWorkflow server.
  4. Click Remove to break the iWorkflow cluster.
    Note: When you remove an iWorkflow cluster member from the cluster, iWorkflow removes all cluster state details from that device and resets it to the default state. The management IP and license details are not impacted by an update.
    Note: If you want to perform this procedure using a REST call from the command line, see K49398482: Managing F5 iWorkflow clusters at support.f5.com.

Upgrading a standalone system

Before you start, make sure you have broken the iWorkflow™ cluster, and that there is only a single standalone iWorkflow instance running and managing the BIG-IP® system.
You upgrade a standalone system when you want to upgrade to a newer iWorkflow version.
  1. Log in to the iWorkflow command line.
  2. Run the command tmsh to access the tmsh utility.
  3. Run the command show /sys software to check the status of the currently installed iWorkflow software.

    The output displays something similar to the following example:

                                  
    
    ------------------------------------------------------------------------
    Sys::Software Status      
    Volume     Product            Version      Build     Active  Status    
                                                                
    ------------------------------------------------------------------------
    HD1.1      iWorkflow          2.0.0        0.0.9631  yes      complete   
    HD1.2           none          none         none      no       complete
    
    
                               
    
    Note: If the output displays only one volume, you can create a new volume during the installation process.
  4. Run the command install /sys software image <iworkflow-image.iso> volume <inactive volume> to install iWorkflow onto an existing inactive volume.
    <inactive volume> is the name of an inactive volume. For example, install /sys software image iworkflow.iso volume HD1.2.
  5. Optional: Run the command install /sys software hotfix <iworkflow-image.iso> create-volume volume <new volume> reboot to automatically reboot after creating a new volume and installing iWorkflow into the new location.
    <new volume> is the name of a new volume. For example, install sys software image iWorkflow.iso create-volume volume HD1.3 reboot.
  6. Run the command quit to exit the tmsh utility.
    Note: If there is an upgrade failure, reboot to the previously active volume on which the previous iWorkflow version was installed, and if required, restore the backup to get the storage state back.
  7. After the installation is complete, if you did not use the reboot switch in your tmsh install command, you can manually reboot into the new volume by running the command: tmsh reboot volume <new iWorkflow volume>.
    <new workflow volume> is the name of the new volume. For example, tmsh reboot volume HD1.2.
  8. Once the system completes the installation and reboots into the new active volume, log in to the iWorkflow command line to review the status. Review the managed BIG-IP devices and confirm that the REST framework versions are current. Rediscover any BIG-IP devices that are unhealthy to force the REST framework update.
    Note: You can monitor the installation process by running the command: watch tmsh show /sys software. By default, the watch command automatically refreshes every two seconds.

    The output displays something similar to the following example:

                                  
    
     Every 2.0s: tmsh show /sys software                                    Fri Sep 13 11:14:08
     2016
    ------------------------------------------------------------------------
    Sys::Software Status      
    Volume     Product      Version  Build     Active                 Status    
                                                                
    ------------------------------------------------------------------------
    HD1.1      iWorkflow    2.0.0    0.0.9631  yes                   complete   
    HD1.2      iWorkflow    2.0.1    0.0.9855  no       installing 10.000 pct
    
    
                               
    
In most cases, after the iWorkflow upgrade is complete, you will need to update the REST framework on all managed BIG-IP devices by rediscovering the BIG-IP system. You can do this using the Discover Device button. For more information, see the Add a device section of the iWorkflow Ops guide at devcentral.f5.com.

Recreating a cluster

Before you start, make sure you have upgraded all three F5® iWorkflow™ nodes.
You recreate the cluster by using the lead peer to add the sibling peers to the cluster.
Note: The iWorkflow peer leader is the preferred cluster member for managing the iWorkflow cluster and BIG-IP® systems. You can use any of the cluster members for this purpose, but F5 recommends that once you have a cluster running you select one member of the cluster for administration and maintain that host until it is no longer preferred.
  1. Log in to the iWorkflow administrative user interface with your administrator user name and password. For example: https://10.10.99.5/ui/login.
    Note: This is the only iWorkflow instance with knowledge of a BIG-IP system.
  2. At the top of the screen, click System settings.
  3. From the iWorkflow Cluster panel, in the iWorkflow Cluster header, click the plus (+) icon.
  4. In the New iWorkflow Cluster Member panel, type the IP address, Admin Username, and Password.
  5. Click Add.
  6. Click OK.
  7. Repeat this procedure until all three iWorkflow cluster members are returned to the cluster.
    Note: If you want to perform this procedure using a REST call from the command line, see K49398482: Managing F5 iWorkflow clusters at support.f5.com.