On this page:

You are viewing documentation for CNI version: v1.0

CNI v1.0 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest release, v1.1, or the current documentation.

tuning plugin

plugins/meta/tuning/README.md

Overview

This plugin can change some system controls (sysctls) and several interface attributes (promiscuous mode, all-multicast mode, MTU and MAC address) in the network namespace. It does not create any network interfaces and therefore does not bring connectivity by itself. It is only useful when used in addition to other plugins.

System Controls Operation

The following network configuration file

{
  "name": "mytuning",
  "type": "tuning",
  "sysctl": {
          "net.core.somaxconn": "500"
  }
}

will set /proc/sys/net/core/somaxconn to 500. Other sysctls can be modified as long as they belong to the network namespace (/proc/sys/net/*).

A successful result would simply be:

{ }

Network sysctls documentation

Some network sysctls are documented in the Linux sources:

Interface Attribute Operation

The following configuration example will change all the supported attributes on the interface determined by CNI_IFNAME :

{
  "name": "mytuning",
  "type": "tuning",
  "mac": "c2:b0:57:49:47:f1",
  "mtu": 1454,
  "promisc": true,
  "allmulti": true
}

Interface attribute configuration reference

  • mac (string, optional): MAC address (i.e. hardware address) of interface
  • mtu (integer, optional): MTU of interface
  • promisc (bool, optional): Change the promiscuous mode of interface
  • allmulti (bool, optional): Change the all-multicast mode of interface. If enabled, all multicast packets on the network will be received by the interface.

Supported arguments

The following CNI_ARGS are supported:

  • MAC: request a specific MAC address for the interface

    (example: CNI_ARGS=“IgnoreUnknown=true;MAC=c2:11:22:33:44:55”)

Note: You may add IgnoreUnknown=true to allow loose CNI argument verification (see CNI’s issue #560 ).

The plugin also support following capability argument .

  • mac: Pass MAC addresses for CNI interface

The following args conventions are supported:

  • mac (string, optional): MAC address (i.e. hardware address) of interface
  • mtu (integer, optional): MTU of interface
  • promisc (bool, optional): Change the promiscuous mode of interface
  • allmulti (bool, optional): Change the all-multicast mode of interface
  • sysctl (object, optional): Change system controls