SD-WAN Viptela Collector Pre-Deployment 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 describes the steps to deploy SD-WAN Viptela collector with the OVA image (.ova) on your own Linux machines using VMware.

When you are using the SD-WAN Viptela collector .ova on your own Linux servers, SevOne recommends three nodes - one control plane node and two agent nodes.

Please contact IBM SevOne Support for any concerns.

For a POV lab environment, a single-node deployment can be used.
Please do not run sevone-cli command from a subdirectory under /opt/SevOne/upgrade and /var/log/pods. It can be run from any directory except for from subdirectories under /opt/SevOne/upgrade and /var/log/pods.
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 or worker, it means follower or agent.

Requirements

IP Range Conflicts

If the SD-WAN collector Virtual Machine that you are provisioning conflicts with any of the default IP ranges listed below, you will need to customize your deployment. Please contact IBM SevOne Support before continuing.

For IP Range Conflicts, please refer to SD-WAN Viptela Collector Use-Cases Guide > section Use-Cases > subsection Handle IP Conflicts for both fresh provisioning and existing clusters.
IP Address IP Range Description
192.168.80.0/20 192.168.80.0.0 - 192.168.95.255 Pod IP addresses (Docker)
192.168.96.0/20 192.168.96.0 - 192.168.111.255 Service IP addresses (Weavenet)
192.168.96.10 n/a Cluster DNS (Kubernetes Services)
- must be in Service's range

SD-WAN .ova Requirements

The following requirements apply to each Viptela node.

CPU 8 CPU(s)
Memory 32 GB
Hard Disk 250 GB
Network Adapter Single network interface

Deploy OVA

To deploy the SD-WAN collector .ova, deploy it on each Linux machine you plan to install SD-WAN collector on. For details, please refer to Deploy an OVF or OVA Template (docs.vmware.com).

Save OVA

  1. SD-WAN collector .ova file can be downloaded 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 .ova file.
  2. Save the .ova to a folder on your server.

Deploy on AWS

AWS Instance Types for SD-WAN

License AWS Instance Type Primary Disk (GiB) Data Disk (GiB)
SD-WAN Solution
  • m5.2xlarge
  • m6i.2xlarge
 250 n/a

Download the OVA images 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 NMS, *_CentOS_v<6.x.x>-ami.ova and for SD-WAN, sevone_solutions_sdwan_viptela-v<6.x.x>-build.<xx>.ova, you may create your own AMIs.

Please refer to SevOne Data Platform Deployment on Amazon Web Services guide for details on how to perform the deployment.

The root disk should be 250 GiB for SD-WAN as shown in AWS Instance Types for SD-WAN table above.

Please refer to SD-WAN Viptela Collector Deployment / Configuration Guide for details to access the new instance via SSH.

Deploy on Azure

Azure Instance Types for SD-WAN

License Azure Instance Type Primary Disk (GiB) Data Disk (GiB)
SD-WAN Solution Standard_D8s_v3 250 n/a

Download the OVA / VHD images 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 NMS, *_CentOS_v<6.x.x>-ami.ova and for SD-WAN, sevone_solutions_sdwan_viptela-v<6.x.x>-build.<xx>.vhd.gz, you may create your own AMIs.

Please refer to SevOne Data Platform Deployment on Microsoft Azure guide for details on how to perform the deployment.

The root disk should be 250 GiB for SD-WAN as shown in Azure Instance Types for SD-WAN table above.

Please refer to SD-WAN Viptela Collector Deployment / Configuration Guide for details to access the new instance via SSH.

SevOne recommends you to discover each new appliance from SevOne NMS using the SNMP community strings.

Configure Network Settings

Perform the following steps to configure the network settings manually.

  1. Execute the following commands to display the NetworkManager TUI.

    IMPORTANT
    A working DNS configuration is a requirement for any SD-WAN collector deployment. Otherwise, SD-WAN collector will not work.

    Please refer to SD-WAN Viptela Collector Troubleshooting Guide > Troubleshooting > section Domain Name Resolution (DNS) not working for details. 
    $ sudo -i
$ nmtui

  2. At the prompt [sudo] password for sevone:, enter the password for the sevone user.

    nmtui

  3. Select Edit a connection.

    nmtui Select Interface

  4. Select the Ethernet interface (not the Docker Bridge).

  5. Select <Edit...>.

    nmtui Edit Connection

  6. Go to IPv4 CONFIGURATION and change <Automatic> to <Manual>.

  7. Select <Show> for IPv4 CONFIGURATION.

    nmtui Edit Connection Show IPv4

  8. Configure the following settings for IPv4 CONFIGURATION as well as any other settings relevant to your network.

    1. Addresses
    2. Gateway
    3. DNS servers
    4. Search domains

  9. Confirm that the following options are selected.

    1. Automatically connect
    2. Available to all users

  10. Click OK.

Set Chrony (NTP Servers) and SNMP

  1. Copy chrony.example.conf and snmpd.example.conf files.

    $ sudo cp /etc/chrony.example.conf /etc/chrony.conf

$ sudo cp /etc/snmp/snmpd.example.conf /etc/snmp/snmpd.conf

  2. Using a text editor of your choice, edit /etc/chrony.conf and/or /etc/snmp/snmpd.conf files to customize your configuration settings.

  3. Change the hostname. For details, please refer to SD-WAN Viptela Collector Use-Cases Guide > Use-Cases > section Change Hostname.

    • To change the hostname of a node, you must first teardown your Kubernetes cluster by running $ sevone-cli cluster down command.
    • The hostnames set below are examples only and are used as examples in the SD-WAN guides. Please set your own hostnames in your environment.

  4. On the control plane node, update /etc/ansible/hosts with your new hostname.

    Example

    $ vi /etc/ansible/hosts

[server]
sdwan-node01 ansible_connection=local

[agent]

  5. If you have agent nodes, update their hostnames as well.

    Example

    [server]
sdwan-node01 ansible_connection=local

[agent]
sdwan-node02 ansible_user=sevone ansible_host=10.123.45.68
sdwan-node03 ansible_user=sevone ansible_host=10.123.45.69

  6. Spins up your Kubernetes cluster for the configuration settings to take effect.

    $ sevone-cli playbook up
    The message FAILED - RETRYING: Wait for k3s server to be up means that k3s is trying to come up and it may take a long time. If all retries are exhausted and k3s is unable to come up, the command will fail automatically. Please contact IBM SevOne Support for help.

    Viptela Collector

    Example

    $ kubectl get pods

NAME                                                READY   STATUS      RESTARTS    AGE
solutions-sdwan-viptela-redis-master-0              1/1     Running     0           6d3h
solutions-sdwan-viptela-redis-replicas-0            1/1     Running     0           6d3h
solutions-sdwan-viptela-upgrade-kpbdd               0/1     Completed   0           15m
solutions-sdwan-viptela-aug-5496ccccbd-7txnt        1/1     Running     0           15m
solutions-sdwan-viptela-create-keys-2-rcbpc         0/1     Completed   0           15m
solutions-sdwan-viptela-collector-8795594c9-2v7gr   1/1     Running     0           15m

    Example

    $ kubectl get nodes  

NAME               STATUS   ROLES                  AGE   VERSION
sdwan-viptela-01   Ready    control-plane,master   16m   v1.27.1+k3s1
SevOne recommends you to discover each new appliance from SevOne NMS using the SNMP community strings.
A Single Node is now ready for you to deploy the SD-WAN collector.