SD-WAN Versa Collector Deployment and Configuration Guide

This document describes the steps to deploy and configure the SD-WAN Versa collector.

To perform SD-WAN collector installation process, you will need to SSH into your machines using non-root credentials for the user sevone. Before continuing, you will need to SSH into each machine that you plan to run SD-WAN collector on and change the default password for this user. This applies whether you are using a SD-WAN appliance or have deployed an .ova. You will need to do this for all nodes (control plane and all agent nodes). This is important for security reasons.

1. SSH into your SD-WAN collector machine and log in as sevone.
2. At the Password prompt, enter sevone.
3. Execute the following command:

   passwd

4. At the prompt New password, enter a new password for the sevone user.
5. At the prompt Retype new password, enter the new password again.
6. Repeat the steps above for each machine that you plan to run SD-WAN collector on.

Execute the following command to install sevone-cli using Command Line Interface.

sudo rpm -Uvh /opt/SevOne/upgrade/utilities/sevone-cli-*.rpm

As a security measure, fresh installations do not ship with pre-generated SSH keys. Execute the following command to generate unique SSH keys for your cluster.

sevone-cli cluster setup-keys

1. Please refer to SD-WAN Versa Collector Pre-Deployment Guide to deploy a single SD-WAN Versa node.
2. Using ssh, log into the SD-WAN Versa collector control plane node as sevone.

   ssh sevone@<SD-WAN collector 'control plane' node IP address or hostname>

   Example

   ssh sevone@10.49.13.154

3. Change the hostname. For details, please refer to SD-WAN Versa Collector Use-Cases Guide > section Use-Cases > subsection Change Hostname.
   Important: Please make sure to set the hostname for all k3s nodes in lowercase when deploying the collector.

1. For a multi-node setup, repeat the steps in SD-WAN Versa Collector Pre-Deployment Guide for each additional node in your cluster. Every SD-WAN collector node ships as a running single-node Kubernetes cluster.
2. Using ssh, log into each node and change the hostname. In order to create a multi-node cluster, you must designate one of the nodes to be your control plane node. For details on how to change the hostname, please refer to SD-WAN Versa Collector Use-Cases Guide > section Use-Cases > subsection Change Hostname.
   Important:

   • Please make sure to set the hostname for all k3s nodes in lowercase when deploying or upgrading the collector.
   • If you have created cluster or added agent nodes using the hostname method, please skip to step 7.
   • If you want to create cluster or add agent nodes using the IP address method, please perform steps 3, 4, 5, and 6.

   Example

   Important: The hostnames and IP addresses mentioned in this table are used in the examples for the steps below. Please make sure to replace the hostnames and IP addresses with your machine's hostnames and IP addresses.

   Hostname	IP Address	Role
   sdwan-node01	10.49.13.154	control plane
   sdwan-node02	10.49.13.155	agent1
   sdwan-node03	10.49.13.156	agent2

3. Using ssh, log into SD-WAN collector control plane node as sevone.

   ssh sevone@<SD-WAN collector 'control plane' node IP address or hostname>

   Example

   ssh sevone@10.49.13.154

4. Stop / reset the running cluster.
   Important: Please perform this step on control plane node and all agent nodes you want to add.

   sevone-cli cluster down

5. Log into SD-WAN collector control plane node as sevone and add nodes by executing the following command.

   sevone-cli cluster worker add <IP address for node>

   Important:

   • Please add agent nodes using the IP address only.
   • When adding a new agent node to your cluster, repeat step 5 every time.
   • Please do not run sevone-cli cluster worker remove command when there is no k3s cluster running.
6. The following spins up your Kubernetes cluster.

   sevone-cli cluster up

   Important: If you want to add more nodes to your cluster, execute the following commands in the same order as shown below.

   sevone-cli cluster down

   command on control plane node every time.

   1. sevone-cli cluster worker add <IP address for node>

      command.

   2. sevone-cli cluster up

      command.
   Important: The message FAILED - RETRYING: Wait for kubernetes node to be up means that kubernetes node is trying to come up and it may take a long time. If all retries are exhausted and kubernetes node is unable to come up, the command will fail automatically. Please contact IBM SevOne Support for help.
7. Verify that your control plane and agent node(s) are Ready and have been added to the Kubernetes cluster.

   
   kubectl get nodes
   
   Output:
   NAME                             STATUS   ROLES                 AGE     VERSION
   <your 'control plane' hostname>  Ready    control-plane,master  19h     v1.28.10+k3s1
   <your 'agent1' hostname>         Ready    <none>                19h     v1.28.10+k3s1
   <your 'agent2' hostname>         Ready    <none>                19h     v1.28.10+k3s1
   ...
   <your 'agent<n>' hostname>       Ready    <none>                19h     v1.28.10+k3s1
   

   Example

   
   kubectl get nodes
   
   Output:
   
   NAME           STATUS   ROLES                  AGE      VERSION
   sdwan-node01   Ready    control-plane,master   19h      v1.28.10+k3s1
   sdwan-node02   Ready    <none>                 19h      v1.28.10+k3s1
   sdwan-node03   Ready    <none>                 19h      v1.28.10+k3s1
   

   Important: You are now ready to configure your SD-WAN collector.

1. Using ssh, log into SD-WAN Versa collector control plane node as sevone.

   ssh sevone@<SD-WAN collector 'control plane' node IP address or hostname>

   Example

   ssh sevone@10.49.13.154

2. Copy SSH keys to SevOne NMS and install GUI.

   ssh-copy-id support@<SevOne NMS IP Address> && sevone-cli solutions guii

   Example

   ssh-copy-id support@10.49.15.58 && sevone-cli solutions guii

   Note: Please provide the SSH password when prompted.

   Example: The command returns the following

   
   ╒══════════════════════════════════════════════════════════════╕
   │ SEVONE GUI INSTALLER                                         │
   ╞══════════════════════════════════════════════════════════════╡
   │ Please open https://10.49.13.154:3000 in your web browser to │
   │ access the GUI Installer.                                    │
   ├──────────────────────────────────────────────────────────────┤
   │ Your credentials are:                                        │
   │ - Username: admin                                            │
   │ - Password: cfE)M&H~F/                                       │
   ├──────────────────────────────────────────────────────────────┤
   │ If you ever lose your credentials, they're stored in:        │
   │ /etc/sevone-guii/creds                                       │
   ╘══════════════════════════════════════════════════════════════╛
   

   You are now ready to install using the Graphical User Interface Installer.

3. Using a web browser of your choice, enter the URL the setup script has returned. For example, https://10.49.13.154:3000.
   Note: You will also need the credentials (Username and Password) that the setup script returns. These credentials are also stored in /etc/sevone-guii/creds file.
   
   Example

   
   cat /etc/sevone-guii/creds | jq
   
   Output
   {
     "password": "cfE)M&H~F/",
     "tokenSecret": "tIGpQReiQzgPlIMDiBUlVHBPGRPhlPlv",
     "username": "admin"
   }
   

4. Click Update Cluster to install SD-WAN Versa Collector.
5. Enter the credentials returned to perform the Self-Service Upgrade. For example, Username: admin and Password: cfE)M&H~F/.
   
   Note: To use the Graphical User Interface installer in dark theme, click next to SevOne logo.
   
   For help on what each upgrade step does, click button in the upper-right corner.
   Important: All the screenshots below are based on the example being used to write this document. Your total number of tasks passed (ok) , skipped , failed , ignored , unreachable , or unexecuted will vary based on your setup. The tasks failed must be addressed as ansible has not ignored them.
6. Enter username & password and then click Login. The graphical user interface installer checks the Current Version and allows you to proceed with the installation.
   Note: Example
   Current Version is on SD-WAN Versa Collector 7.1.0+54.
   You can proceed with redeploy/install.
   Note: During the Self-Service Upgrade, if you experience network connectivity issue or the upgrade has been halted for any reason, the self-service upgrade will resume from the step where it left off after the issue is resolved. However, if you are at the Deploy step and the self-service upgrade has been halted for any reason, self-service upgrade will show a message requesting you to contact IBM SevOne Support.
   
   To resume with the Self-Service Upgrade, using a web browser of your choice, re-enter the URL the setup script has returned. For example, https://10.49.13.154:3000.
7. Click the Continue to Configure button to configure SD-WAN Versa solution. Using GUI, you can configure only basic settings for your collector. To configure the advanced settings, please refer to section Configure .
   Important: To configure advanced settings, you must click Save button.
   
   1. From Configuration drop-down, choose a configuration file from the list. The default configuration file is solutions-sdwan-versa_custom_guii.yaml . Provide inputs for all mandatory fields.
      Important: Once you provide inputs for all mandatory fields, error messages will no longer appear.
      
   2. Show advanced config - Select the check box to show advanced configuration variables. For more details, please refer to SD-WAN Versa Collector Advanced Use-Cases Guide > section Advanced Configuration Settings.
   3. Collector Service
      • Credentials (All values must be base64-encoded format)
        • Controller Credentials
          • Username - The username for Versa Director credentials with admin-level read privilege.
          • Password - The password for Versa Director.
        • NMS Credentials
          • NMS API Credentials
            • Username - The SevOne NMS user name for an administrator-level account.
            • Password - The SevOne NMS password.
          • SSH Credentials
            • Username - The SevOne NMS user name for ssh access to the appliance. It is recommend to set to support in base64-encoded format.
            • Password - The SevOne NMS password for support user.
        • DI Credentials
          • DI API Credentials
            • Username - The SevOne Data Insight user name for an adminstrator-level account.
            • Password - The SevOne Data Insight password.
        • Syslog Receiver Port - The port on which the collector listens for non-flow syslog data sent by Versa Analytics.
   4. Collector Configuration
      • MSP Name - The Managed Service Provider (MSP) name for this instance. MSP is a grouping of one or more tenants.
   5. Log
      • Log Level - Defines the log-level for the collector. Value can be info, debug, warning, or error.
   6. Jaeger
      • Disabled - Select the check box to disable Jaeger tracing.
   7. Load Reports
      • Disabled - Set the check box to not import TopN views and OOTB reports.
   8. Vendor Controller Settings
      • Versa Director Settings
        • Versa Director API URL - The API URL of Versa Director.
        • Insecure TLS - Select the check box to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
   9. NMS
      • NMS API Settings
        • NMS API IP / Hostname - The hostname or IP address for SOA and REST API endpoints. i.e., targeted SevOne NMS.
        • Insecure TLS - Select the check box to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
      • DI
        • DI API Settings - The hostname or IP address for targeted SevOne Data Insight.
        • Insecure TLS - Select the check box to enable insecure TLS connection by skipping certification verification. This is necessary for servers with self-signed server certificates.
        • Tenant - Tenant name for this SevOne Data Insight instance. This is an internal name used to keep settings and cached data segregated by tenant. Default value is SevOne.
   10. Flow Augmentor Service Settings
       • Enable - Select the check box to enable Flow Augmentor installation.
       • Flow Receiver Port - The port on which Flow Augmentor listens for inbound flows. The port number can range from 9000 - 33000.
   11. Flow Augmentor Configuration
       • Flow Augmentor Sender Configuration
         • Flow Augmentor Sender Buffer Size - Sender output buffer size in number of packets.
         • DNC IP - IP address of the DNC, where the augmented flows are sent.
         • Port No - Port of DNC, where the the augmented flows are sent.
8. Click Save. Configuration is saved in /opt/SevOne/chartconfs/solutions-sdwan-versa_custom_guii.yaml.
   Important: Once the configuration is saved, click Continue button to upgrade SOA.
9. Click Continue button to Upgrade SOA.
   Note: SOA version
   SOA must be on the latest version on all appliances in SevOne NMS cluster.
   
   If your peers are on SevOne NMS 7.x or above, skip the following command. However, if your peers are on SevOne NMS 6.x,

   • Command Line Interface (CLI) must be used to upgrade SOA on all peers as the graphical user interface (GUI) only upgrades SOA for the NMS appliance you are connected to.
   • Add flag --all-peers if you want to install SOA on all peers in the cluster.

   
    sevone-cli soa upgrade \
   /opt/SevOne/upgrade/utilities/SevOne-soa-*.rpm \
   <enter SevOne NMS IP address> --all-peers
   

   
10. You are now ready to upgrade SOA. Click Run Upgrade SOA button. This can take a few minutes to run.
11. Click the Continue button to Pre-Check.
    Note: Pre-Check step runs various checks to ensure that SD-WAN Versa collector cluster is healthy before the deployment.
    
12. You are now ready to run the pre-check. Click the Run Pre-Check button.
    Note: To view the logs for a task, click for the task you need the details for. The pop-up has Copy to clipboard button which allows you to copy all the contents in the pop-up and paste it into a file.
13. Click the Continue button to Deploy.
14. Click the Run Deploy button to run the upgrade. This can take a few minutes to run.
15. Click the Continue button to Post Check.
    
16. Click the Run Post-Check button to run the post-check. This can take a few minutes to run.
17. Click the Continue button.
    Important: This indicates that the installation has completed successfully. It typically takes around 30-40 minutes for the data to become visible in SevOne NMS.

The collector configuration is defined in YAML format. Each setting may be one of the following.

How are variable names in the tables below written in YAML file?

collectorService:
  # Listen for inbound Versa syslogs on this port.
  # Receiver port must be unique per tenant.
  syslogReceiverPort: 50001

  secrets:
    controller:
      # Versa Director credentials.
      username: <base64_username>
      password: <base64_password>
    nms:
      ssh:
        # NMS ssh credentials.
        username: <base64_username>
        password: <base64_password>
      api:
        # NMS API credentials.
        username: <base64_username>
        password: <base64_password>
    di:
      # DI API credentials list.
      api:
        - username: <base64_username>
          password: <base64_password>

collectorConfig:
  # MSP name.  Short and descriptive name for the collector that becomes part
  # of the generated NMS configuration, such as the "<MSP>::SDWAN" device
  # group that contains all collected devices.
  #
  # IMPORTANT: This value MUST match the applicable parent organization name in
  # the Versa Director's Configuration page, listed on the left side.
  #
  # Must be unique per tenant.
  msp_name: <name>

  log:
    # Log level may be info or debug.  Change to debug only if required by SevOne Support.
    level: info

  jaeger:
    # Enable Jaeger only if required by SevOne Support.
    disabled: true
  
  load_reports:
    # Disable 'load_reports' only if Top N Views and OOTB reports are not required.
    disabled: false

  vendor:
    director_api:
      # URL to Versa Director API.
      url: https://<Versa_Director_server>:9182
      insecure_tls_connection: true

  nms:
    api:
      # NMS server name or IP address.
      host: <NMS_server>
      insecure_tls_connection: true
  
  di:
    api:
      - host: <DI_server>  # DI server name or IP address.
        tenant: <DI_tenant>  # DI tenant (default: SevOne)
        insecure_tls_connection: true

Check the pods - must be Running or Completed.

kubectl get pods

Output:

NAME                                                 READY   STATUS      RESTARTS      AGE
solutions-sdwan-versa-create-keys-1-xzrt9            0/1     Completed   0             14h
solutions-sdwan-versa-collector-c55fbfbd-2jzs5       1/1     Running     0             14h
solutions-sdwan-versa-redis-master-0                 1/1     Running     0             14h
solutions-sdwan-versa-aug-decoder-c4c9d5dd4-pj7k5    1/1     Running     0             14h
solutions-sdwan-versa-redis-replicas-0               1/1     Running     0             14h

kubectl get services

Output:

NAME                                   TYPE           CLUSTER-IP        EXTERNAL-IP   PORT(S)           AGE
kubernetes                             ClusterIP      192.168.96.1      <none>         443/TCP           14h
solutions-sdwan-versa-redis-headless   ClusterIP      None              <none>         6379/TCP          14h
solutions-sdwan-versa-redis-master     ClusterIP      192.168.107.167   <none>         6379/TCP          14h
solutions-sdwan-versa-redis-replicas   ClusterIP      192.168.111.17    <none>         6379/TCP          14h
solutions-sdwan-versa                  LoadBalancer   192.168.105.197   10.49.13.154   50001:10881/UDP   14h
solutions-sdwan-versa-flowservice      LoadBalancer   192.168.102.2     10.49.13.154   9992:11540/UDP    14h

1. Obtain the node IP where the collector pod is running for SD-WAN Versa collector to check the logs.

   
   kubectl get pods -o wide
   
   Output:
   
   NAME                                                 READY   STATUS      RESTARTS      AGE   IP              NODE           NOMINATED NODE   READINESS GATES
   ssolutions-sdwan-versa-create-keys-1-xzrt9           0/1     Completed   0             14h   192.168.80.9    sdwan-node01   <none>           <none>
   solutions-sdwan-versa-collector-c55fbfbd-2jzs5       1/1     Running     0             14h   192.168.80.8    sdwan-node01   <none>           <none>
   solutions-sdwan-versa-redis-master-0                 1/1     Running     0             14h   192.168.80.12   sdwan-node01   <none>           <none>
   solutions-sdwan-versa-aug-decoder-c4c9d5dd4-pj7k5    1/1     Running     0             14h   10.49.13.154    sdwan-node01   <none>           <none>
   solutions-sdwan-versa-redis-replicas-0               1/1     Running     0             14h   192.168.80.13   sdwan-node01   <none>           <none>

   Important:

   • The pod name for SD-WAN Versa collector returned is solutions-sdwan-versa-collector-c55fbfbd-2jzs5.
   • The node IP for SD-WAN Versa collector returned is 192.168.80.8.
2. Check the logs for SD-WAN Versa collector, for example.
   1. Using ssh, log into SD-WAN Versa collector node as sevone.

      ssh sevone@<SD-WAN Versa collector node IP address>

      Example

      ssh sevone@10.49.13.154

   2. Change directory to /opt/SevOne/logs/sdwan-versa/<collector_name>/<build_version>.

      /opt/SevOne/logs/sdwan-versa/<collector_name>/<build_version>

      Example

      /opt/SevOne/logs/sdwan-versa/solutions-sdwan-versa/7.1.0-build.54

      You should see the following folders in this directory. The main folder displays all common logs, whereas agent-specific logs can be found within their respective folders.
      • ClearAlertsAgent
      • DeviceHealthStreamingAgent
      • InstallerAgent
      • MigrationAgent
      • CreateAlertsStreamingAgent
      • FlowAgent
      • FlowAugmentor
      • InterfaceQueueStreamingAgent
      • main
      • ObjectDescriptionAgent
      • DeviceDescriptionAgent
      • FlowInterfaceCacheAgent
      • InterfaceStatAgent
      • MetadataAgent
      • TunnelStatStreamingAgent
   3. Check logs for InstallerAgent. Similarly, you can check logs for all other agents.

      Example

      
      cat solutions-sdwan-versa_InstallerAgent_7.1.0-build.54.log
      
      Output:
      
      2024-10-16T00:00:44Z INF Sending SOA request... agent=InstallerAgent endpoint=/sevone.api.v3.Metadata/FlowAttributes requestId=2404
      2024-10-16T00:00:44Z INF Received SOA response agent=InstallerAgent elapsed=9.385009ms requestId=2404
      2024-10-16T00:00:44Z INF Sending SOA request... agent=InstallerAgent endpoint=/sevone.api.v3.Metadata/FlowViews requestId=2405
      2024-10-16T00:00:44Z INF Received SOA response agent=InstallerAgent elapsed=3.017292ms requestId=2405
      2024-10-16T00:00:44Z INF Load done agent=InstallerAgent
      2024-10-16T00:00:44Z INF Run agent done agent=InstallerAgent elapsed=44.233509526s
      2024-10-16T00:00:44Z INF Sending selfmon info to NMS  agent=InstallerAgent
      2024-10-16T00:00:44Z INF Sending SOA request... agent=InstallerAgent endpoint=/sevone.api.v3.Devices/Data requestId=2406
      2024-10-16T00:00:44Z INF Received SOA response agent=InstallerAgent elapsed=6.518768ms requestId=2406

      Note: If you see INF Run agent done agent=InstallerAgent, then you are ready for the build step. If the command does not return this log message, please contact IBM SevOne Support.
3. The build step prepares your SD-WAN Versa collector. It executes the conntrack command that clears out all entries from the conntrack table and restarts the collector pod.

   For single vDirector

   sevone-cli solutions run_buildstep --deployment_name=<deployment_name>

   Example

   sevone-cli solutions run_buildstep --deployment_name=solutions-sdwan-versa

   Note: The deployment name is the name of the application specified in the directory /etc/ansible/group_vars/all.

   For multi-vDirector (To delete two collector pods).

   sevone-cli solutions run_buildstep