Documentation: Added documentation for `cnitool`.
authorAvinash Sridharan <avinash@mesosphere.com>
Thu, 30 Mar 2017 22:28:36 +0000 (22:28 +0000)
committerAvinash Sridharan <avinash@mesosphere.com>
Wed, 5 Apr 2017 21:40:24 +0000 (21:40 +0000)
Added documentation to simplify the usage of `cnitool` and the
settings expected to be used with `cnitool`.

Documentation/cnitool.md [new file with mode: 0644]

diff --git a/Documentation/cnitool.md b/Documentation/cnitool.md
new file mode 100644 (file)
index 0000000..a4bc7d3
--- /dev/null
@@ -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.