SD-Wan Collector Widgets for Data Insight Installation / Upgrade Guide

SevOne Documentation

All documentation is available from the IBM SevOne Support customer portal.

© Copyright International Business Machines Corporation 2023.

All right, title, and interest in and to the software and documentation are and shall remain the exclusive property of IBM and its respective licensors. No part of this document may be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the written consent of IBM.

IN NO EVENT SHALL IBM, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF IBM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND IBM DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.

IBM, the IBM logo, and SevOne are trademarks or registered trademarks of International Business Machines Corporation, in the United States and/or other countries. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on ibm.com/trademark.

About

This document includes steps for installing the widgets available with the SD-WAN 6.6 collector in SevOne Data Insight.

Terminology usage...
 In this guide if there is,
  • [any reference to master] OR
  • [[if a CLI command (for NMS or Kubernetes or Redis) contains master] AND/OR
  •  [its output contains master]],
   it means leader or control plane.
And, if there is any reference to slave, it means follower or Agent.

Prerequisites

In order to deploy the SD-WAN Solution widgets, you will need the following:

  • For SevOne Data Insight versions compatible with this release, please refer to Release Notes SD-WAN Collector > Resources & Requirements > section Compatibility Matrix.
  • sevone access to the SevOne Data Insight machine
  • SevOne SD-WAN Collector installed on your SevOne NMS appliance or cluster
  • The widget tar file provided to you by IBM SevOne Production or IBM SevOne Support

Installation

Execute the following steps to install SD-WAN widgets in SevOne Data Insight.

Prior to executing the steps below, SevOne Data Insight must already be provisioned.

  1. Using ssh, login to SevOne Data Insight appliance as sevone.

    $ ssh sevone@<SevOne Data Insight IP address or hostname>

  2. Go to /home/sevone folder.

    $ cd /home/sevone

  3. Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone directory.

    1. signature-tools- -build.<###>.tgz
      For example, signature-tools-2.0.1-build.1.tgz
    2. signature-tools- -build.<###>.tgz.sha256.txt
      For example, signature-tools-2.0.1-build.1.tgz.sha256.txt

  4. Execute the following commands to verify the checksum of the code signing tool before extracting it.

    $ (cat $(ls -Art signature-tools-*.tgz.sha256.txt | \
tail -n 1) | sha256sum --check)

$ sudo tar xvfz $(ls -Art signature-tools-*.tgz | \
tail -n 1) -C /

  5. Make a directory. For example, sdwan-6.6 .

    Example

    $ mkdir sdwan-6.6

  6. Go to folder sdwan-6.6 .

    $ cd sdwan-6.6

  7. Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone/sdwan-6.6 directory.

    1. sdwan-widgets-v6.6.0-build.5.tar.gz
    2. sdwan-widgets-v6.6.0-build.5.tar.gz.sha256.txt

  8. Extract the widget tar file.

    $ tar xvf <sdwan-widgets-6.6-tar-package>

  9. Run deploy.sh script.

    Example

    $ ./deploy.sh /home/sevone/sdwan-6.6/sdwan-widgets-v6.6.0-build.5.tar.gz

    If your password contains any special characters, please run the deployment script using the following command. You must enclose the password in double quotes.

    Example

    $ ./deploy.sh /home/sevone/sdwan-6.6/sdwan-widgets-v6.6.0-build.5.tar.gz --password "abc#$def"

    To know more options that are available for deploy.sh script, you may use the --help or -h option.

    $ ./deploy.sh --help

deploy.sh -- A one click widget packet installer

Usage:
./deploy.sh <YOUR_WIDGET_PACKAGE_FILE.tar> [--force] [--user <DI_USERNAME>] [--password <DI_PASSWORD>] [--tenant <DI_TENANT_NAME>] [--host <DI_HOST_NAME>] [--import-ootb-reports] [--datasource-name <DATASOURCE_NAME>]

    Alternate Method: Commands to install each widget individually

    $ ./install.sh <widget-tar-file-name>.tgz --user <DI_USERNAME> \
--password <DI_PASSWORD> --tenant <DI_TENANT> \
--host <DI_HOST (without http/https) or localhost>
    Insert the correct values at the prompts.

  10. Once the script has been successfully executed, the following widgets are installed.

    • SD-WAN Alarm (Deprecated)
    • SD-WAN Flow (Deprecated)
    • Geo Topology
    • Interface Queue Widget (Deprecated)
    • Key Performance Indicators (KPI) (Deprecated)
    • Network Topology
    • Site-to-Site Traffic
    • Device Summary (Deprecated)
    • Tenants (Deprecated)

Upgrade

To upgrade the existing SD-WAN widgets on SevOne Data Insight, execute the following commands.

  1. Using ssh, login to SevOne Data Insight appliance as sevone.

    $ ssh sevone@<SevOne Data Insight IP address or hostname>

  2. Go to /home/sevone folder.

    $ cd /home/sevone

  3. Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone directory.

    1. signature-tools- -build.<###>.tgz
      For example, signature-tools-2.0.1-build.1.tgz
    2. signature-tools- -build.<###>.tgz.sha256.txt
      For example, signature-tools-2.0.1-build.1.tgz.sha256.txt

  4. Execute the following commands to verify the checksum of the code signing tool before extracting it.

    $ (cat $(ls -Art signature-tools-*.tgz.sha256.txt | \
tail -n 1) | sha256sum --check)

$ sudo tar xvfz $(ls -Art signature-tools-*.tgz | \
tail -n 1) -C /

  5. Make a directory. For example, sdwan-6.6.

    Example

    $ mkdir sdwan-6.6

  6. Go to folder sdwan-6.6.

    $ cd sdwan-6.6

  7. Download the following (latest) files from IBM Passport Advantage (https://www.ibm.com/software/passportadvantage/pao_download_software.html) via Passport Advantage Online. However, if you are on a legacy / flexible SevOne contract and do not have access to IBM Passport Advantage but have an active Support contract, please contact IBM SevOne Support for the latest files. You must place these files in /home/sevone/sdwan-6.6 directory.

    1. sdwan-widgets-v6.6.0-build.5.tar.gz
    2. sdwan-widgets-v6.6.0-build.5.tar.gz.sha256.txt

  8. Extract the widget tar file.

    $ tar xvf <sdwan-widgets-6.6-tar-package>

  9. Run deploy.sh script.

    From SD-WAN >= 2.9 to SD-WAN 6.5

    $ ./deploy.sh /home/sevone/sdwan-6.6/sdwan-widgets-v6.6.0-build.5.tar.gz

    From SD-WAN < 2.9 to SD-WAN 6.5

    $ ./deploy.sh /home/sevone/sdwan-6.6/sdwan-widgets-v6.6.0-build.5.tar.gz --force

    If your password contains any special characters, please run the deployment script using the following command. You must enclose the password in double quotes.

    Example

    $ ./deploy.sh /home/sevone/sdwan-6.6/sdwan-widgets-v6.6.0-build.5.tar.gz --force --password "abc#$def"

    To know more options that are available for deploy.sh script, you may use the --help or -h option.

    $ ./deploy.sh --help

deploy.sh -- A one click widget packet installer

Usage:
./deploy.sh <YOUR_WIDGET_PACKAGE_FILE.tar> [--force] [--user <DI_USERNAME>] [--password <DI_PASSWORD>] [--tenant <DI_TENANT_NAME>] [--host <DI_HOST_NAME>] [--import-ootb-reports] [--datasource-name <DATASOURCE_NAME>]
    Insert the correct values at the prompts.

  10. Once the script has been successfully executed, the following widgets are installed.

    • SD-WAN Alarm (Deprecated)
    • SD-WAN Flow (Deprecated)
    • Geo Topology
    • Interface Queue Widget (Deprecated)
    • Key Performance Indicators (KPI) (Deprecated)
    • Network Topology
    • Site-to-Site Traffic
    • Device Summary (Deprecated)
    • Tenants (Deprecated)

Post-Deployment

After completing the installation steps above, confirm that SD-WAN widgets are now available from SevOne Data Insight.

  1. Log in to SevOne Data Insight. If you are already logged in, refresh the page. It may take a couple minutes for the page to reload.

  2. In the left navigation bar, click Create to access the list of widget types to create a report from. Or, if you select Reports, you can click Create Report in the upper-right corner to access the list of widget types to create a report from.

  3. In the right panel, Select a Widget section now includes the following SD-WAN widgets:

    • SD-WAN Alarm (Deprecated)
    • SD-WAN Flow (Deprecated)
    • Geo Topology
    • Interface Queue Widget (Deprecated)
    • Key Performance Indicators (KPI) (Deprecated)
    • Network Topology
    • Site-to-Site Traffic
    • Device Summary (Deprecated)
    • Tenants (Deprecated)

  4. Click the info icon available for the SD-WAN widgets in the Select a Widget section. You will notice that the version of widgets is now changed to 6.6.0. To check the version of individual widgets, execute the following command on your SevOne Data Insight machine.

    Example

    $ sevone-cli exec wdkserver -- cat /opt/widget-server/data/wuploads/sdwan-alarm/widget.json | jq .version