Skip to content

Added capabilities section information to CNI readme file #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2019
Merged

Added capabilities section information to CNI readme file #328

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/cni.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/> <pre>[<br/> { "hostPort": 8080, "containerPort": 80, "protocol": "tcp" },<br /> { "hostPort": 8000, "containerPort": 8001, "protocol": "udp" }<br />]<br /></pre> | 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). <pre>{ <br> "searches" : [ "internal.yoyodyne.net", "corp.tyrell.net" ] <br> "servers": [ "8.8.8.8", "10.0.0.10" ] <br />} </pre> | 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.

Expand Down