Paragon Insights Installation Requirements
For Paragon Insights (formerly HealthBot) to install successfully, the following hardware and software components are required on the host machine.
Paragon Insights Hardware Requirements
You can install Paragon Insights on either a physical or a virtual machine.
Proof-of-concept (POC) system—supports up to two device groups and three devices per device group:
RAM: 20 GB
Disk space: 100 GB available on the
/var/partitionFree disk space must be at least 20% of total disk space at all times.
CPU cores: 8
Production system (minimum system requirements):
RAM: 32 GB
Disk space: 250 GB SSD available on the
/var/partitionFree disk space must be at least 20% of total disk space at all times.
Recommended minimum IOPS for the disk(s): 1000
CPU cores: 16
Paragon Insights is a cloud-native application that leverages a microservices-based architecture that allows scale-out and multinode deployment. Depending on your specific requirements and use case, you can add more nodes to the Kubernetes cluster.
See the scaling tool at https://apps.juniper.net/hb-sizing/ for more information on server configurations for a given use case.
Paragon Insights Software Requirements
Paragon Insights installs on Ubuntu, RedHat Enterprise Linux (RHEL), and CentOS versions of Linux.
For Ubuntu:
Ubuntu version 16.04.01 (Xenial Xerus) or 18.04.04 (Bionic Beaver)
For single and multi-node installation, the kernel version must be 4.4.19 or greater.
We recommend installing Ubuntu as one large disk partition.
If multiple partitions are used, Paragon Insights data is written to the
/var/local/healthbot/directory and Paragon Insights log files are written to/var/lib/docker/containers.
For RHEL:
Offline Installation
For releases earlier than Paragon Insights Release 4.0.0: RHEL version 7, Release 7.5 or later
For Paragon Insights Release 4.0.0 and later: RHEL version 7, Release 7.5 or later; RHEL version 8, Release 8.3 or later
The following system utilities must be installed manually if they are not already present:
tar, bash, ln, ssh-keygen, curl, vi, wget, openssl, openssh-server, and rsync
Enter the following configuration line in the file
/etc/sysctl.conf:vm.max_map_count=262144. Reboot of the server may be required to make this setting take effect.
For CentOS:
Offline Installation
For releases earlier than Paragon Insights Release 4.0.0: CentOS version 7, Release 7.3 or later
For Paragon Insights Release 4.0.0 and later: CentOS version 7, Release 7.3 or later; CentOS version 8, Release 8.3 or later
For single and multi-node installation, the kernel version must be 4.4.19 or greater.
With Paragon Insights Release 4.0.0, for CentOS 8 server and RHEL 8, kernel upgrade is not required.
The following system utilities must be installed manually if they are not already present:
tar, bash, ln, ssh-keygen, curl, vi, wget, openssl, openssh-server, and rsync
Enter the following configuration line in the file
/etc/sysctl.conf:vm.max_map_count=262144. Reboot of the server may be required to make this setting take effect.On a scaled production server, we recommend that you configure the OS settings in the following two files:
cat/etc/security/limits.conf# End of file * hard nofile 1048576 * soft nofile 1048576 root hard nofile 1048576 root soft nofile 1048576 influxdb hard nofile 1048576 influxdb soft nofile 1048576
cat/etc/sysctl.conffs.file-max = 2097152 vm.max_map_count=262144 fs.inotify.max_user_watches=524288 fs.inotify.max_user_instances=512
Note Reboot of the server may be required to make this setting take effect.
Web Browser Requirements
Paragon Insights is supported on the following 64-bit web browsers:
Table 1: Supported Web Browsers
Browser | Supported Version(s) (Macintosh) | Supported Version(s) (Windows) |
|---|---|---|
Chrome | 90 and later | 90 and later |
Firefox | 83 and later | 83 and later |
Safari | 14.0.3 and later | - |
Network Requirements
For Kubernetes-based installations, including multi-node installations:
All nodes must run NTP or other time-synchronization at all times.
An Internet connection is required for all nodes during the initial Ubuntu (.deb) or CentOS/RedHat (.rpm) software extraction process. This is not a requirement for the healthbot setup portion of the installation
One static IP address per node.
(Optional) A hostname that resolves to the corresponding IP address.
Ensure that internet protocol version 6 (IPv6) is enabled.
An SSH server must be running on all nodes.
All nodes must be in the same subnet
For a multi-master installation,
The number of master nodes that you specify must always be an odd number.
You need a virtual IP address to configure high availability (HA) between the master nodes. This virtual IP address must be different from the virtual IP address that you specify to access various Paragon Insights services.
All master nodes must be in same subnet. Ensure that you place the master nodes on different racks so that there is no impact if there are power outages
You need to determine the number of master nodes before you start the installation process.
For a multi-node installation, a virtual (unused) IP address in the same subnet as the nodes is needed. This is the address on which the Web GUI is accessed.
A common SSH user name and password is needed for all nodes. The healthbot setup command (discussed later) must be run as this user.
Docker version 18.09.3 or later is required
The command: sysctl -w net.bridge.bridge-nf-call-iptables=1 must be run on all nodes.
You can add the net.bridge.bridge-nf-call-iptables=1 to the file
/etc/sysctl.confto ensure that it persists across reboots of the server.
Open the following firewall ports, as appropriate:
JTI (native GPB), for telemetry collection - per your source and destination port settings
gRPC (OpenConfig), for telemetry collection - TCP port 32767
NETCONF/SSH, for telemetry collection - TCP port 830
SNMP, for telemetry collection - UDP port 161
Syslog messages - UDP port 514
NetFlow, for telemetry collection – UDP port of your choice.
Must be different for each NetFlow host.
Note Default ports are listed above; adjust as needed if you use non-default ports.
Network Device Requirements
Junos Devices
Paragon Insights collects data from devices running Junos OS using multiple data collection methods, called sensors. Each sensor type requires a certain Junos OS version, and configuration added to the devices, to enable a connection to the Paragon Insights server.
Native GPB
Junos OS Version: 15.1 or later
Required configuration—configure a sensor profile for each relevant related rule in Paragon Insights:
##Streaming Server Profile set services analytics streaming-server COLLECTOR-1 remote-address <HealthBot-server-address> set services analytics streaming-server COLLECTOR-1 remote-port 22000 ##Export Profile set services analytics export-profile EXP-PROF-1 local-address <local-router-IP> set services analytics export-profile EXP-PROF-1 local-port 22001 set services analytics export-profile EXP-PROF-1 reporting-rate 30 set services analytics export-profile EXP-PROF-1 format gpb set services analytics export-profile EXP-PROF-1 transport udp ##Sensor Profile set services analytics sensor SENSOR-1 server-name COLLECTOR-1 set services analytics sensor SENSOR-1 export-name EXP-PROF-1 set services analytics sensor SENSOR-1 resource <resource> # example /junos/system/linecard/interface/
See Configuring a Junos Telemetry Interface Sensor for more information.
NetFlow (IPFIX)
Junos OS Version: 14.1R1 or later for MX Series Routers. For complete Junos version and platform support information, see:
Required configuration—
Configure a NetFlow v9 or IPFIX template
Apply the template to enable traffic sampling
Associate the sampling instance with the FPC
Specify which traffic interface to sample
The following samples are for an IPFIX configuration. Lines that start with “##” are comments and are used to point out details in the configuration.
IPFIX Template Configuration
set services flow-monitoring version-ipfix template IPv4-TEMPLATE
ipv4-template Apply IPFIX Template to Enable Traffic Sampling
set forwarding-options sampling instance IPFIX-IPv4-INSTANCE
input rate 10 set forwarding-options sampling instance IPFIX-IPv4-INSTANCE
family inet output flow-server 10.102.70.200 port 2055 set forwarding-options sampling instance IPFIX-IPv4-INSTANCE
family inet output flow-server 10.102.70.200 version-ipfix template
IPv4-TEMPLATE set forwarding-options sampling instance IPFIX-IPv4-INSTANCE
family inet output inline-jflow source-address 198.51.100.1 ## 10.102.70.200 = Paragon Insights server
## port 2055; use this value in Paragon Insights GUI (device group config)
## inline-jflow = Enable inline flow monitoring for traffic from the designated address
## 198.51.100.1 = traffic interface that does the exporting; use this value in Paragon Insights GUI (device config)
Associate Sampling Instance with the FPC
set chassis fpc 0 sampling-instance IPFIX-IPv4-INSTANCESpecify the Traffic Interface to Sample and Direction of Sampled Traffic
set interfaces ge-0/0/0 unit 0 family inet sampling input set interfaces ge-0/0/0 unit 0 family inet sampling output OpenConfig
Junos OS Version: 16.1 or later
The OpenConfig sensor requires that the Junos device have the OpenConfig and network agent packages installed. These packages are built into Junos OS Releases 18.2X75, 18.3, and later. For releases between 16.1 and 18.2X75 or 18.3, you must install the packages.
To verify whether you have these packages, enter the following command:
user@host> show version | match "Junos:|openconfig|na telemetry"Junos: 19.2R1.8 JUNOS na telemetry [19.2R1.8] JUNOS Openconfig [19.2R1.8]
See Understanding OpenConfig and gRPC on Junos Telemetry Interface for more information.
Network agent is not supported on PPC platforms (MX104, MX80, and so on)
Required configuration:
set system services extension-service request-response grpc clear-text
iAgent (NETCONF)
Junos OS Version: 11.4 or later
Required configuration:
set system services netconf ssh
SNMP
Junos OS Version: Any release
Required configuration:
set snmp community public
Syslog
Junos OS Version: Any release
Required configuration:
set system syslog host 10.10.10.1 any anyset system syslog host 10.10.10.1 allow-duplicatesset system syslog host 10.10.10.1 structured-data## 10.10.10.1 = Paragon Insights server
Structured syslog is highly recommended because it avoids text parsing by the Paragon Insights server.
Cisco Device Support
Paragon Insights can collect telemetry data from Cisco IOS XR devices. To use these devices with Paragon Insights, you must configure the grpc server and the openconfig-interfaces sensors. Paragon Insights does not automatically configure these for you.
The following example shows a sensor group sg1 created for gRPC dial-in configuration with the YANG model for interfaces. An hbot_interfaces subscription associates the sg1 sensor group with an interval of 10 seconds to stream data.
The following reference configuration is loaded on a device running Cisco IOS XR software version 6.3.2.
! grpc port 32767 ! telemetry model-driven sensor-group sg1 sensor-path openconfig-interfaces:interfaces/interface ! subscription hbot_interfaces_ sensor-group-id sg1 sample-interval 10000 ! ! ssh server v2 end
Multi-Node Installation
Starting with release 3.0.0 Paragon Insights uses Kubernetes for all HA/multi-node installations. In order to install Paragon Insights on more than one server, you must install using Kubernetes. All of the needed configuration for the clusters is performed by Kubernetes. During the setup phase of the installation process, you must identify the Kubernetes master node(s) and worker node(s).
Starting with Release 4.0.0, while installing Paragon Insights you can choose to have multiple master nodes. While running the healthbot setup command, you are prompted to specify hostnames or IP addresses of the master nodes. If you choose to have multiple master nodes, you must also specify the virtual IP address that is required for configuring high availability (HA) between the master nodes. If you are using the silent installer, in the configuration file you can specify the virtual IP address in the master_virtual_ip field.
Starting from Release 4.0.0, while installing Paragon Insights you can specify multiple virtual IP addresses (unused) so that you can connect to various services in Paragon Insights and thereby monitor devices that are in different subnets. If you are using the silent installer, in the configuration file you can specify multiple virtual IP addresses in the load_balancer_ip field.
The following example shows the installation command for an Ubuntu server.
$ sudo apt-get install -y /<path-to-deb-file>/healthbot-<version>.deb$ sudo apt-get install -y ./healthbot-3.2.0-17-4.0.0_release-CD.deb Reading package lists... Done Building dependency tree Reading state information... Done Note, selecting 'healthbot' instead of './healthbot-3.2.0-17-4.0.0_release-CD.deb' The following packages were automatically installed and are no longer required: augeas-lenses facter hiera libaugeas0 ruby-augeas ruby-deep-merge ruby-json ruby-nokogiri ruby-rgen ruby-safe-yaml ruby-selinux ruby-shadow virt-what Use 'sudo apt autoremove' to remove them. The following NEW packages will be installed: healthbot 0 upgraded, 1 newly installed, 0 to remove and 2 not upgraded. Need to get 0 B/6,388 MB of archives. After this operation, 15.9 GB of additional disk space will be used. Get:1 /var/volume/healthbot/build/CD/4.0.0_release/17/healthbot-3.2.0-17-4.0.0_release-CD.deb healthbot all 3.2.0-17 [6,388 MB] Selecting previously unselected package healthbot. (Reading database ... 161452 files and directories currently installed.) Preparing to unpack .../healthbot-3.2.0-17-4.0.0_release-CD.deb ... Unpacking healthbot (3.2.0-17) ... Setting up healthbot (3.2.0-17) ...