Skip to content

Type Alias: ContainerdNetworkInfo ​

ContainerdNetworkInfo = object

A network containers can join (Containerd.listNetworks, Containerd.getNetwork): host and none, and the CNI networks of the component's CNI configuration directory (the nerdctl ones, as nerdctl network ls lists them, and the other configuration lists there).

Properties ​

driver ​

driver: string

Its main CNI plugin ('bridge', 'macvlan', 'ipvlan'…); 'host' and 'none' for those networks.


enableIPv6 ​

enableIPv6: boolean

Whether it has an IPv6 subnet.


file? ​

optional file?: string

The path of its CNI configuration list (/etc/cni/net.d/nerdctl-backend.conflist); undefined for host and none.


gateways ​

gateways: string[]

The gateways of its subnets ('10.4.1.1').


id ​

id: string

Its ID: 'host' and 'none' for those, the 64 hexadecimal digits nerdctl gives a CNI network.


internal ​

internal: boolean

Whether it is cut from the outside: a bridge network without the host's gateway and masquerading, and none.


labels ​

labels: Record<string, string>

Its labels (the ones given to NetworkCreateOptions.labels, and the nerdctl/… ones).


name ​

name: string

Its name, the one the containers give in ContainerCreateOptions.networks.


reserved ​

reserved: boolean

Whether the component cannot remove it: host, none, the default nerdctl network (bridge), and the CNI configurations not written by nerdctl or the component (their files not named nerdctl-*.conflist).


subnets ​

subnets: string[]

Its subnets in CIDR notation ('10.4.1.0/24', 'fd00:4:10::/64'), [] for host and none.

Released under the MIT License.