Installation Pre-requisites

Installation Overview

ONES Installation follows the below steps in the order sequence of:

• License Readiness

• Preparing and Installing ONES Application machine

• Installing ONES Agents on SONiC Switches for Orchestrator and Telemetry

• Enabling OpenConfig on non-SONiC Switches for Telemetry

License Readiness

The installer allows a default capability for managing 8 devices without a license. Beyond this, the following license key is required for proceeding with the Installation;

• ONES Application License (As per device count)

Trail license support feature

• Telemetry Visibility (Monitor, inventory, analytics)

• Add/remove Non-SONiC devices via YAML or CSV

• Support (Zendesk)- Ability to open a ticket with inventory dump

• Syslog access, Console/SSH access for device

To obtain a license, contact [e-mail] providing the below details;

• License Duration - In Years (1-5)

• Devices Count - 8, 32, 64, 128, 256, 512 or 1024

• ONES installation ID

• Email ID: (For Account creation)

Users can get the ONES installation ID on the ONES-UI Login page after the installation

System Hardware Requirements – ONES Application

In the current release, ONES can support managing up to 1024 devices. For ONES Application Installation, the system hardware requirements vary based on the number of devices to manage;

Devices	Processor and Cores	RAM	Storage
8/16/32/64	x86/x64 based, 4-core CPU	16GB	160GB/320GB/640GB/1.2 TB
128	INTEL(E5-1607 v2)/AMD, 4 cores	32GB	3 TB or more
256	x86/x64 based 8-core CPU	64GB	6 TB or more
512	INTEL(E5-1607 v2)/AMD, 16 cores or higher	64GB	12 TB or more
1024	INTEL(E5-1607 v2)/AMD, 32 cores or higher	128GB	20 TB or more

If user wants to use 8 devices, the recommendation is to use 64GB storage, because the default backup count is 1, and max can be configured 3

And if storage gets full, the controller will stop working or behave in wrong way

System Software Requirements - ONES Application

OS	Libraries
Ubuntu 18.0 or later	docker, docker-compose python3, python3-pip paramiko scp

Task	Command	Validation
Ubuntu Server	Installer file (Version 18 or higher)	lsb_release -a
Update to latest packages	sudo apt-get update	NA​
Install Docker	sudo apt-get install docker.io	​docker ps​
Install Docker-compose	sudo apt-get install docker-compose	docker-compose version​
Install Python3	sudo apt-get install python3	python3 –-version
Install Python3-pip	sudo apt-get install python3-pip	pip3 –-version
Install Paramiko	sudo apt-get install python3-paramiko	​pip show paramiko
Install SCP-Client	sudo pip3 install scp	pip show scp

ONES Application package will take care of this prerequisite at the time of installation, Package verify the availability of the dependencies first then execute the application scripts

Note* Script do not take care about the update to latest version of ubuntu

Customer Firewall Configuration (Ports to be opened)

ONES Service	Port Numbers
ONES Web GUI	443
Switch Access over SSH	22
ONES Monitoring	50052
gNMI Gateway (Telemetry)	9339
ONES Telemetry Database	5432
ONES Orchestrator	8787
ONES Orchestrator Database	2345
pty-server	8885
API-Server	8080
stream-processer	8093
ksqldb-server	8088
kafka-connect	8083
schema-registry	8081
broker	29092, 9101, 9092
Zookeeper	2181
ONES Collector	50053

These port numbers should be available to use and all ports must be allowed in the firewall if the Database server and devices are in the different DMZ zone

sudo iptables -L // This command can be used to verify the used ports

Network Switch (Managed Node) Configuration Requirement

• SSH is enabled

• Network Reachability from ONES Application

• OpenConfig feature is enabled (for non-SONiC Switches)

Browser Requirements for ONES Web User Interface access

• Google Chrome version 107 or later

• Mozilla Firefox version 106 or later