diff --git a/docs/cni.md b/docs/cni.md index fd37ceeb52..641f39b2d6 100644 --- a/docs/cni.md +++ b/docs/cni.md @@ -74,6 +74,16 @@ You can create multiple network configuration files to connect containers to mul Network configuration files are processed in lexical order during container creation, and in the reverse-lexical order during container deletion. +## Dynamic Plugin specific fields (Capabilities / Runtime Configuration) +Plugins can request that the runtime insert dynamic configuration by explicitly listing their `capabilities` in the network configuration. Dynamic information (i.e. data that a runtime fills out) should be placed in a `runtimeConfig` section. See the [Capabilities](https://github.com/containernetworking/cni/blob/master/CONVENTIONS.md) section for more information about well known capabilities . + +`azure-vnet` CNI plugin currently supports following capabilities. + +| Capability | Purpose | Spec and Example | Supported Platform | +| ---------- | ------- | ---------------- | ------------------ | +| `portMappings` | Pass mapping from ports on the host to ports in the container network namespace. | A list of portmapping entries.
[
{ "hostPort": 8080, "containerPort": 80, "protocol": "tcp" },
{ "hostPort": 8000, "containerPort": 8001, "protocol": "udp" }
]
| Windows | +| `dns` | Dynamically configure dns according to runtime | Dictionary containing a list of `servers` (string entries), a list of `searches` (string entries), a list of `options` (string entries).
{ 
"searches" : [ "internal.yoyodyne.net", "corp.tyrell.net" ]
"servers": [ "8.8.8.8", "10.0.0.10" ]
}
| Windows | + ## Logs Logs generated by `azure-vnet` plugin are available in `/var/log/azure-vnet.log` on Linux and `c:\cni\azure-vnet.log` on Windows.