Skip to content

Commit

Permalink
Documentation: Added documentation for cnitool.
Browse files Browse the repository at this point in the history
Added documentation to simplify the usage of `cnitool` and the
settings expected to be used with `cnitool`.
  • Loading branch information
Avinash Sridharan committed Apr 5, 2017
1 parent d427963 commit 382686e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Documentation/cnitool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Overview
The `cnitool` is a utility that can be used to test a CNI plugin
without the need for a container runtime. The `cnitool` takes a
`network name` and a `network namespace` and a command to `ADD` or
`DEL`,.i.e, attach or detach containers from a network. The `cnitool`
relies on the following environment variables to operate properly:
* `NETCONFPATH`: This environment variable needs to be set to a
directory. It defaults to `/etc/cni/net.d`. The `cnitool` searches
for CNI configuration files in this directory with the extension
`*.conf` or `*.json`. It loads all the CNI configuration files in
this directory and if it finds a CNI configuration with the `network
name` given to the cnitool it returns the corresponding CNI
configuration, else it returns `nil`.

* `CNI_PATH`: For a given CNI configuration `cnitool` will search for
the corresponding CNI plugin in this path.

0 comments on commit 382686e

Please sign in to comment.