summaryrefslogtreecommitdiff
path: root/cni/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cni/README.md')
-rw-r--r--cni/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/cni/README.md b/cni/README.md
new file mode 100644
index 000000000..d35bc4111
--- /dev/null
+++ b/cni/README.md
@@ -0,0 +1,15 @@
+## `cni` ##
+
+There are a wide variety of different [CNI][cni] network configurations. This
+directory just contains an example configuration that can be used as the
+basis for your own configuration.
+
+To use this configuration, place it in `/etc/cni/net.d` (or the directory
+specified by `cni_config_dir` in your `libpod.conf`).
+
+In addition, you need to install the [CNI plugins][cni] necessary into
+`/opt/cni/bin` (or the directory specified by `cni_plugin_dir`). The
+two plugins necessary for the example CNI configurations are `portmap` and
+`bridge`.
+
+[cni]: https://github.com/containernetworking/plugins