Skip to content

Usage

Installation

There are different ways to install components on a server, VPS, etc.

1. Automatic installation

shell
curl -sSLH "X-Key: _placeholder_key_" https://cloudnetip.com/api/nodes/connect | sudo sh -
shell
wget -qO- --header="X-Key: _placeholder_key_" https://cloudnetip.com/api/nodes/connect | sh
  • The command downloads the shell script and executes it through the sh shell
  • The script checks if Docker Engine is installed; if not, it installs the latest version
  • The script checks if Netip components are installed and installs or updates them if necessary

Replace the key

Don't forget to replace the placeholder _placeholder_key_ with your key

Source code of the shell script

Check the source code of the script https://cloudnetip.com/api/nodes/connect

shell

2. Using cloud-init

Runcmd

This is a section in CloudInit that takes a list of commands and executes them sequentially after other system initialization processes are completed

Replace the key

Don't forget to replace the placeholder no-set-key with your key

yaml
Script execution logs

Installing components

shell
tail -f /var/log/cloud-init-netip.log

Output cloud-init log

shell
tail -f /var/log/cloud-init-output.log

3. Manual installation

Execute the script manually in the terminal

Docker Engine >= 20.0 is required to be installed

Replace the key

Don't forget to replace the placeholder no-set-key with your key

Show the one-liner script
shell

Component settings

Limiters

To limit the component launch parameters, simply add a header
X-Off: GPU Metrics or multiple headers like X-Off: Disk Indicators,Host Network to the installation URL:

shell
curl -H "X-Off: GPU Metrics,Disk Indicators,Host Network,NVMe Collector" \
  https://cloudnetip.com/api/nodes/connect
  1. GPU Metrics - disables access to and collection of GPU information
  2. Disk Indicators - disables access to and collection of all disk and filesystem information
  3. Host Network - disables the parent network
  4. NVMe Collector - disables access to and collection of NVMe disk information. The --cap-add SYS_ADMIN parameter is used only if NVMe disks are detected during installation; otherwise, it is not applied.

Configure firewall for netip.network component

Do not use firewall

If the X-Fwg header is not specified, the firewall is not applied. Afterwards, you need to manually add the node to groups in the Cloudnetip system.

  • add groups using the installer

Add a header in curl: -H "X-Fwg: Default,My custom group"

  • add groups manually

You can also add several groups during the first installation
of the component: -e FIREWALL_GROUPS='Default, My custom group'

Important

If the netip-network component was already installed on the node earlier,
automatic addition to the Default and My custom group groups will not occur.
You must add them manually in the Cloudnetip management system.

Updating components

Similarly to the installation, it will perform an update when run through the terminal

shell
curl -sSLH "X-Key: _placeholder_key_" https://cloudnetip.com/api/nodes/connect | sudo sh -
shell
wget -qO- --header="X-Key: _placeholder_key_" https://cloudnetip.com/api/nodes/connect | sh

Removing components

All components will be stopped and removed

shell
curl -sSL https://cloudnetip.com/api/nodes/connect?purge | sudo sh -
shell
wget -qO- https://cloudnetip.com/api/nodes/connect?purge | sh