summaryrefslogtreecommitdiff
path: root/libpod/network/cni/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'libpod/network/cni/README.md')
-rw-r--r--libpod/network/cni/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/libpod/network/cni/README.md b/libpod/network/cni/README.md
new file mode 100644
index 000000000..6f57feff5
--- /dev/null
+++ b/libpod/network/cni/README.md
@@ -0,0 +1,10 @@
+This package abstracts CNI from libpod.
+It implements the `ContainerNetwork` interface defined in [libpod/network/types/network.go](../types/network.go) for the CNI backend.
+
+
+## Testing
+Run the tests with:
+```
+go test -v -mod=vendor -cover ./libpod/network/cni/
+```
+Run the tests as root to also test setup/teardown. This will execute CNI and therefore the cni plugins have to be installed.