Prepare for NetQ On-premises Installation

This topic describes the preparation steps needed before installing the NetQ components on your premises. Refer to Prepare for NetQ Could Installation for preparations for cloud deployments.

There are three key steps in the preparation for on-premises installation:

  1. Decide whether you want to install the NetQ Platform on:

    • a virtual machine (VM) on hardware that you provide, or
    • the Cumulus NetQ Appliance.
  2. Review the VM requirements if you have chosen that option.

  3. Obtain the NetQ Platform image and setup the VM or appliance.

Requirements for VMs

If you choose to deploy NetQ on your own hardware, the following minimum hardware and software requirements must be met for the VM to operate correctly.

Virtual Machine Requirements

The NetQ Platform requires a VM with the following system resources allocated:

Resource

Minimum Requirement

ProcessorEight (8) virtual CPUs
Memory64 GB RAM
Local disk storage256 GB SSD
(Note: This must be an SSD; use of other storage options can lead to system instability and are not supported.)
Network interface speed1 Gb NIC
Hypervisor
  • VMware ESXi™ 6.5 or later (OVA image) for servers running Cumulus Linux, CentOS, Ubuntu and RedHat operating systems
  • KVM/QCOW (QEMU Copy on Write) image for servers running CentOS, Ubuntu and RedHat operating systems

Required Open Ports

You must also open the following ports on your NetQ Platform (or platforms if you are planning to deploy a server cluster).

For external connections:

PortProtocolComponent Access
8443TCPAdmin UI
443TCPNetQ UI
31980TCPNetQ Agent communication
32708TCPAPI Gateway
22TCPSSH

For internal cluster communication:

PortProtocolComponent Access
8080TCPAdmin API
5000TCPDocker registry
8472UDPFlannel port for VXLAN
6443TCPKubernetes API server
10250TCPkubelet health probe
2379TCPetcd
2380TCPetcd
7072TCPKafka JMX monitoring
9092TCPKafka client
7071TCPCassandra JMX monitoring
7000TCPCassandra cluster communication
9042TCPCassandra client
7073TCPZookeeper JMX
2888TCPZookeeper cluster communication
3888TCPZookeeper cluster communication
2181TCPZookeeper client

Port 32666 is no longer used for the NetQ UI.

Prepare Your KVM VM and Obtain the NetQ Platform

Follow the preparation instructions below, based on whether you intend to deploy a single server platform or a three-server cluster.

KVM Single-Server Deployment

Two steps are needed, one to download the NetQ Platform and one to configure the VM.

Download the KVM NetQ Platform Image

IMPORTANT: Confirm that your server hardware meets the requirements identified in Virtual Machine Requirements.

  1. On the Cumulus Downloads page, select NetQ from the Product list.

  2. Click 2.4 from the Version list, and then select 2.4.1 from the submenu.

  3. Select KVM from the HyperVisor/Platform list.

  4. Scroll down to view the image, and click Download.

Configure the KVM VM

  1. Open your hypervisor and set up your VM.

    You can use this example for reference or use your own hypervisor instructions.

    KVM Example Configuration

    This example shows the VM setup process for a system with Libvirt and KVM/QEMU installed.

    1. Confirm that the SHA256 checksum matches the one posted on the Cumulus Downloads website to ensure the image download has not been corrupted.

      $ sha256sum ./Downloads/cumulus-netq-server-2.4.1-ts-amd64-qemu.qcow2
      $ 6fff5f2ac62930799b4e8cc7811abb6840b247e2c9e76ea9ccba03f991f42424  ./Downloads/cumulus-netq-server-2.4.1-ts-amd64-qemu.qcow2
      
    2. Copy the QCOW2 image to a directory where you want to run it.

      Copy, instead of moving, the original QCOW2 image that was downloaded to avoid re-downloading it again later should you need to perform this process again.

      $ sudo mkdir /vms
      $ sudo cp ./Downloads/cumulus-netq-server-2.4.1-ts-amd64-qemu.qcow2 /vms/ts.qcow2
      
    3. Create the VM.

      For a Direct VM, where the VM uses a MACVLAN interface to sit on the host interface for its connectivity:

      $ virt-install --name=netq_ts --vcpus=8 --memory=65536 --os-type=linux --os-variant=debian7 --disk path=/vms/ts.qcow2,format=qcow2,bus=virtio,cache=none --network=type=direct,source=eth0,model=virtio -import --noautoconsole
      

      Replace the disk path value with the location where the QCOW2 image is to reside. Replace network model value (eth0 in the above example) with the name of the interface where the VM is connected to the external network.

      Or, for a Bridged VM, where the VM attaches to a bridge which has already been setup to allow for external access:

      $ virt-install --name=netq_ts --vcpus=8 --memory=65536 --os-type=linux --os-variant=debian7 \ --disk path=/vms/ts.qcow2,format=qcow2,bus=virtio,cache=none --network=bridge=br0,model=virtio --import --noautoconsole
      

      Replace network bridge value (br0 in the above example) with the name of the (pre-existing) bridge interface where the VM is connected to the external network.

    4. Watch the boot process in another terminal window.

      $ virsh console netq_ts
      
    5. From the Console of the VM, check to see which IP address Eth0 has obtained via DHCP, or alternatively set a static IP address by viewing the /etc/netplan/01-ethernet.yaml Netplan configuration file:

      # This file describes the network interfaces available on your system
      # For more information, see netplan(5).
      network:
      version: 2
      renderer: networkd
      ethernets:
          eno0:
              dhcp4: no
              addresses: [192.168.1.222/24]
              gateway4: 192.168.1.1
              nameservers:
                  addresses: [8.8.8.8,8.8.4.4]
      

      This example show that the IP address is a static address. If this is desired, exit the file without changes. If you wanted the IP address to be determined by DHCP, edit the file as follows:

      network:
          version: 2
          renderer: networkd
          ethernets:
              eno0:
                  dhcp4: yes
      

      Apply the settings.

      $ sudo netplan apply
      

  2. Verify the platform is ready for installation. Fix any errors indicated before installing the NetQ software.

    cumulus@<hostname>:~$ sudo opta-check
    
  3. Run the Bootstrap CLI on the platform for the interface you defined above (eth0 or eth1 for example). This example uses the eth0 interface.

    cumulus@<hostname>:~$ netq bootstrap master interface eth0 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz
    

    Allow about five minutes for this to complete, and only then continue to the next step.

    If this step fails for any reason, you can run netq bootstrap reset and then try again.

You are now ready to install the Cumulus NetQ software. Refer to Install NetQ Using the Admin UI (recommended) or Install NetQ Using the NetQ CLI.

KVM Three-Server Cluster

To prepare a three-server cluster is similar to preparing a single server configuration. For the master server, follow the instructions for the single server, then continue here:

  1. Copy the file you downloaded for the single server to the other two servers.

  2. On each worker node, open your hypervisor and setup the VM in the same manner as for the single server.

    Make a note of the private IP addresses you assign to the master and two worker nodes. They are needed for the installation steps.

  3. Verify the server is ready for installation. Fix any errors indicated before installing the NetQ software.

    cumulus@<hostname>:~$ sudo opta-check
    
  4. Run the Bootstrap CLI on each worker node for the interface you defined above (eth0 or eth1 for example). This example uses the eth0 interface.

    cumulus@<hostname>:~$ netq bootstrap worker interface eth0 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz
    

    Allow about five minutes for this to complete, and only then continue to the next step.

    If this step fails for any reason, run netq bootstrap reset and then try again.

You are now ready to install the Cumulus NetQ software. Refer to Install NetQ Using the Admin UI (recommended) or Install NetQ Using the NetQ CLI.

Prepare Your VMware VM and Obtain NetQ Platform

Follow the preparation instructions below, based on whether you intend to deploy a single server platform or a three-server cluster.

VMware Single-Server Arrangement

Two steps are needed, one to download the NetQ Platform and one to configure the VM.

Download the VMware NetQ Platform Image

IMPORTANT: Confirm that your server hardware meets the requirements identified in Hardware Requirements.

  1. On the Cumulus Downloads page, select NetQ from the Product list.

  2. Click 2.4 from the Version list, and then select 2.4.1 from the submenu.

  3. Select VMware from the HyperVisor/Platform list.

  4. Scroll down to view the image, and click Download.

Configure the VMware VM

  1. Open your hypervisor and set up your VM.

    You can use this examples for reference or use your own hypervisor instructions.

    VMware Example Configuration

    This example shows the VM setup process using an OVA file with VMware ESXi.

    1. Enter the address of the hardware in your browser.

    2. Log in to VMware using credentials with root access.

    3. Click Storage in the Navigator to verify you have an SSD installed.

    4. Click Create/Register VM at the top of the right pane.

    5. Select Deploy a virtual machine from an OVF or OVA file, and click Next.

    6. Provide a name for the VM, for example Cumulus NetQ.

    7. Drag and drop the NetQ Platform image file you downloaded in Step 2 above.

    8. Click Next.

    9. Select the storage type and data store for the image to use, then click Next. In this example, only one is available.

    10. Accept the default deployment options or modify them according to your network needs. Click Next when you are finished.

    11. Review the configuration summary. Click Back to change any of the settings, or click Finish to continue with the creation of the VM.

      The progress of the request is shown in the Recent Tasks window at the bottom of the application. This may take some time, so continue with your other work until the upload finishes.

    12. Once completed, view the full details of the VM and hardware.

  2. Verify the platform is ready for installation. Fix any errors indicated before installing the NetQ software.

    cumulus@<hostname>:~$ sudo opta-check
    
  3. Run the Bootstrap CLI on the platform for the interface you defined above (eth0 or eth1 for example). This example uses the eth0 interface.

    cumulus@<hostname>:~$ netq bootstrap master interface eth0 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz
    

    Allow about five minutes for this to complete, and only then continue to the next step.

    If this step fails for any reason, you can run netq bootstrap reset and then try again.

You are now ready to install the Cumulus NetQ software. Refer to Install NetQ Using the Admin UI (recommended) or Install NetQ Using the NetQ CLI.

VMware Three-Server Cluster

To prepare a three-server cluster is similar to preparing a single server configuration. For the master server, follow the instructions for the single server, then continue here:

  1. Copy the file you downloaded for the single server to the other two servers.

  2. On each worker node, open your hypervisor and setup the VM in the same manner as for the single server.

    Make a note of the private IP addresses you assign to the master and two worker nodes. They are needed for the installation steps.

  3. Verify the platform is ready for installation. Fix any errors indicated before installing the NetQ software.

    cumulus@<hostname>:~$ sudo opta-check
    
  4. Run the Bootstrap CLI on each worker node for the interface you defined above (eth0 or eth1 for example). This example uses the eth0 interface.

    cumulus@<hostname>:~$ netq bootstrap worker interface eth0 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz
    

    Allow about five minutes for this to complete, and only then continue to the next step.

    If this step fails for any reason, you can run netq bootstrap reset and then try again.

You are now ready to install the Cumulus NetQ software. Refer to Install NetQ Using the Admin UI (recommended) or Install NetQ Using the NetQ CLI.

Prepare Your Cumulus NetQ Appliance

Follow the preparation instructions below, based on whether you intend to deploy a single server platform or a three-server cluster.

Single NetQ Appliance

To prepare your single NetQ Appliance:

Inside the box that was shipped to you, you’ll find:

  • Your Cumulus NetQ Appliance (a Supermicro 6019P-WTR server)
  • Hardware accessories, such as power cables and rack mounting gear (note that network cables and optics ship separately)
  • Information regarding your order

For more detail about hardware specifications (including LED layouts and FRUs like the power supply or fans, and accessories like included cables) or safety and environmental information, refer to the user manual and quick reference guide.

Install the Appliance

After you unbox the appliance:

  1. Mount the appliance in the rack.
  2. Connect it to power following the procedures described in your appliance’s user manual.
  3. Connect the Ethernet cable to the 1G management port (eth0).
  4. Power on the appliance.
NetQ Appliance connections

NetQ Appliance connections

If your network runs DHCP, you can configure Cumulus NetQ over the network. If DHCP is not enabled, then you configure the appliance using the console cable provided.

Configure the Password, Hostname and IP Address

Change the password using the passwd command:

$ passwd 
Changing password for <user>.
(current) UNIX password: 
Enter new UNIX password: 
Retype new UNIX password: 
passwd: password updated successfully

By default, DHCP is used to acquire the hostname and IP address. However, you can manually specify the hostname with the following command:

sudo hostnamectl set-hostname <newHostNameHere>

You can also configure these items using the Ubuntu Netplan configuration tool. For example, to set your network interface eth0 to a static IP address of 192.168.1.222 with gateway 192.168.1.1 and DNS server as 8.8.8.8 and 8.8.4.4:

Edit the /etc/netplan/01-ethernet.yaml Netplan configuration file:

```
# This file describes the network interfaces available on your system
# For more information, see netplan(5).
network:
    version: 2
    renderer: networkd
    ethernets:
        eno0:
            dhcp4: no
            addresses: [192.168.1.222/24]
            gateway4: 192.168.1.1
            nameservers:
                addresses: [8.8.8.8,8.8.4.4]
```

Apply the settings.

$ sudo netplan apply

Verify NetQ Software and Appliance Readiness

Now that the appliance is up and running, verify that the software is available and the appliance is ready for installation.

  1. Verify that the needed packages are present and of the correct release, version 2.4.1 and update 26 or later.

    cumulus@<hostname>:~$ dpkg -l | grep netq
    

    For Ubuntu 18.04, you should see:

    ii  netq-agent   2.4.1-ub18.04u26~1581351889.c5ec3e5 amd64   Cumulus NetQ Telemetry Agent for Ubuntu
    ii  netq-apps    2.4.1-ub18.04u26~1581351889.c5ec3e5 amd64   Cumulus NetQ Fabric Validation Application for Ubuntu
    

    For Ubuntu 16.04, you should see:

    ii  netq-agent   2.4.1-ub16.04u26~1581350451.c5ec3e5 amd64   Cumulus NetQ Telemetry Agent for Ubuntu
    ii  netq-apps    2.4.1-ub16.04u26~1581350451.c5ec3e5 amd64   Cumulus NetQ Fabric Validation Application for Ubuntu
    
  2. Verify the installation images are present and of the correct release, version 2.4.1.

    cumulus@<hostname>:~$ cd /mnt/installables/
    cumulus@<hostname>:/mnt/installables$ ls
    NetQ-2.4.1.tgz  netq-bootstrap-2.4.1.tgz
    
  3. Run the following commands.

    sudo systemctl disable apt-{daily,daily-upgrade}.{service,timer}
    sudo systemctl stop apt-{daily,daily-upgrade}.{service,timer}
    sudo systemctl disable motd-news.{service,timer}
    sudo systemctl stop motd-news.{service,timer}
    
  4. Verify the appliance is ready for installation. Fix any errors indicated before installing the NetQ software.

    cumulus@<hostname>:~$ sudo opta-check
    
  5. Run the Bootstrap CLI on the appliance for the interface you defined above (eth0 or eth1 for example). This example uses the eth0 interface.

    cumulus@<hostname>:~$ netq bootstrap master interface eth0 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz
    

    Allow about five minutes for this to complete, and only then continue to the next step.

    If this step fails for any reason, you can run netq bootstrap reset and then try again.

You are now ready to install the Cumulus NetQ software. Refer to Install NetQ Using the Admin UI (recommended) or Install NetQ Using the NetQ CLI.

Three-Appliance Cluster

To prepare a three-appliance cluster is similar to preparing a single server. For the master appliance, follow the instructions for a single appliance, then return here to configure the worker appliances.

  1. Install the second NetQ Appliance using the same steps as a single NetQ Appliance.

  2. Configure the IP address, hostname, and password using the same steps as a single NetQ Appliance.

    Make a note of the private IP addresses you assign to the master and two worker nodes. They are needed for the installation steps.

  3. Copy the netq-bootstrap-2.4.1.tgz and NetQ-2.4.1.tgz files, downloaded for the single NetQ Appliance, to the /mnt/installables/ directory on the second NetQ Appliance and run the systemctl commands.

  4. Verify that the needed files are present and of the correct release.

  5. Verify the platform is ready for installation. Fix any errors indicated before installing the NetQ software.

    cumulus@<hostname>:~$ sudo opta-check
    
  6. Run the Bootstrap CLI on the appliance for the interface you defined above (eth0 or eth1 for example). This example uses the eth0 interface.

    cumulus@<hostname>:~$ netq bootstrap worker interface eth0 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz
    

    Allow about five minutes for this to complete, and only then continue to the next step.

    If this step fails for any reason, you can run netq bootstrap reset and then try again.

  7. Repeat these steps for the third NetQ Appliance.

You are now ready to install the Cumulus NetQ software. Refer to Install NetQ Using the Admin UI (recommended) or Install NetQ Using the NetQ CLI.