summaryrefslogtreecommitdiff
path: root/contrib/cni/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/cni/README.md')
-rw-r--r--contrib/cni/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/contrib/cni/README.md b/contrib/cni/README.md
new file mode 100644
index 000000000..78e22fd36
--- /dev/null
+++ b/contrib/cni/README.md
@@ -0,0 +1,16 @@
+## `contrib/cni` ##
+
+There are a wide variety of different [CNI][cni] network configurations. This
+directory just contains some example configurations that can be used as the
+basis for your own configurations (distributions should package these files in
+example directories).
+
+To use these configurations, place them in `/etc/cni/net.d` (or the directory
+specified by `crio.network.network_dir` in your `crio.conf`).
+
+In addition, you need to install the [CNI plugins][cni] necessary into
+`/opt/cni/bin` (or the directory specified by `crio.network.plugin_dir`). The
+two plugins necessary for the example CNI configurations are `loopback` and
+`bridge`.
+
+[cni]: https://github.com/containernetworking/plugins