Install

rk is a single binary for Linux. There are two builds of every release:

Build	Platforms	User plane	Where to get it
Community	Linux amd64, arm64	kernel sockets (`USPACE`)	public, get.dflux.io
Full	Linux amd64	`USPACE`, plus the DPDK datapath	the customer portal, portal.dflux.io

Both builds run the same flows and accept the same configuration. The full build also carries the DPDK user-plane helper, and the DPDK datapath also needs a licence that grants it (see Licensing).

Install the community build

Shell

The installer:

reads the latest version from https://get.dflux.io/runik/latest, or uses the version you give it;
downloads the tarball for your architecture and the release's SHA256SUMS;
refuses to install if the checksum doesn't match;
installs rk into /usr/local/bin. If it can't write there, it uses sudo when sudo works without a password, and otherwise falls back to ~/.local/bin.

Install a specific version:

Shell

Choose the install directory with D3X_INSTALL_DIR:

Shell

The installer needs curl, tar, and sha256sum (or shasum).

Install the full build

Download rk-full_<version>_linux_amd64.tar.gz from the customer portal, check it against the SHA256SUMS published with it, and put rk on your PATH.

Check what you installed

Shell

text

The second line names the build. A full build shows flavor: full and the sha256 of the DPDK helper it carries.

Host requirements

Linux. NGAP runs over SCTP, which rk supports on Linux only. The SCTP kernel module must be available.
Privileges, only for some features:
- ICMP traffic (rk server uspace -protocol icmp) needs CAP_NET_RAW or root.
- Large socket buffers need CAP_NET_ADMIN. Without it, net.core.rmem_max and net.core.wmem_max cap the buffers and rk logs a warning.
- The DPDK datapath needs what DPDK needs on your host (hugepages, a NIC bound to a DPDK driver, root). rk doesn't set these up.