Installing a Netris Controller

You can install the Netris controller almost on any 64-bit Linux host. Netris Controller may or may not be on the same network as the managed network nodes are. In fact if there are multiple Netris managed deployments there’s no need for an individual controller for each deployment.

It doesn’t matter where you host the Netris controller. What matters is that 1) the Netris controller needs to be accessible over the Internet. 2) You can access the web console. 3) Nodes that are going to be managed by Netris have access to the Netris controller through their management network interface.

Linux host requirements

  • RAM: 8 GB

  • CPU: 4 Cores

  • Disk: 50GB

  • OS: Linux 64-bit

DNS record

In the example below, the host has a public IP address 54.183.23.201. While it is OK for users and nodes to refer to the Netris Controller through an IP address, it is recommended to use a DNS record (this way it will be easier to potentially move Netris Controller somewhere with a different IP address).

Below is an example using Cloudflare DNS service (may use any DNS service).

../_images/dns-record-netrisctl.png

Ensure that newly created domain name resolves to the right IP address of the machine that will host the Netris Controller.

host netrisctl.netris.dev
netrisctl.netris.dev has address 54.183.23.201

Install Netris Controller software and dependencies

curl -sfL https://get.netris.io | sh -s -- --ctl-hostname netris.example.com --ctl-ssl-issuer letsencrypt

Note

The Netris Controller installer will create a K3s cluster and then will deploy Netris Controller on top of it using Helm Chart. The “–ctl-ssl-issuer” will instruct the installer to generate a Let’s Encrypt SSL certificate and the “–ctl-hostname” will hint for what domain name the certificate must be generated. That’s why it is important to create the DNS record before this step. Detailed info here: doc.

../_images/netris-controller-installed.png

Once the installation process is finished, you will be able to access your newly installed Netris Controller web console using netris/newNet0ps credentials.

Security Matters

Change the default password

Setting → My Account → Change Password

../_images/change-password.png

Add new admin user

Accounts → Users → +Add

../_images/create-new-admin-user.png

Restrict incoming TCP requests to the list below:

TCP Port

Service

22

SSH

80

HTTP

443

Netris Web Console

2003

Streaming Telemetry (Collectd)

3033

Netris Monitoring (Telescope)

50051

Netris Agent (gRPC)