From 6ced13a6713a6cf3960e8c6ec61ccec4c9bb626e Mon Sep 17 00:00:00 2001
From: Aaron U'Ren <aauren@gmail.com>
Date: Sat, 27 Jan 2024 21:18:53 -0600
Subject: [PATCH] doc(cni): CNI requirements and install process

---
 README.md          |  5 +++--
 docs/user-guide.md | 10 ++++++++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4a1cd61ce4..790be2079f 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,9 @@ datastore to maintain in your cluster.
 kube-router's elegant design also means there is no dependency on another CNI
 plugin. The
 [official "bridge" plugin](https://github.com/containernetworking/plugins/tree/master/plugins/main/bridge)
-provided by the CNI project is all you need -- and chances are you already have
-it in your CNI binary directory!
+provided by the CNI project is all you need. While it is likely that you already have this plugin on your file system
+if you've installed Kubernetes, kube-router will install the plugins it needs for you in `/opt/cni/bin` if it sees
+you're missing them.
 
 Read more about the advantages and potential of BGP with Kubernetes:
 
diff --git a/docs/user-guide.md b/docs/user-guide.md
index 9fe9ae2b73..eac6c10fb9 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -169,6 +169,16 @@ kube-router --master=http://192.168.1.99:8080/` or `kube-router --kubeconfig=<pa
 wget -O /etc/cni/net.d/10-kuberouter.conf https://raw.githubusercontent.com/cloudnativelabs/kube-router/master/cni/10-kuberouter.conf`
 ```
 
+- Additionally, the aforementioned `bridge` and `host-local` CNI plugins need to exist for the container runtime to
+  reference if you have kube-router manage the pod-to-pod network. Additionally, if you use `hostPort`'s on any of your
+  pods, you'll need to install the `hostport` plugin. As of kube-router v2.1.X, these plugins will be installed to
+  `/opt/cni/bin` for you during the `initContainer` phase if kube-router finds them missing. Most container runtimes
+  will know to look for your plugins there by default, however, you may have to configure them if you are having
+  problems with your pods coming up.
+  - [containerd configuration](https://github.com/containerd/containerd/blob/c1d59e38ef222f5a80dde9d817bac1f98e2db78c/docs/cri/config.md?plain=1#L409)
+  - [cri-o configuration](https://github.com/cri-o/cri-o/blob/main/contrib/cni/README.md#plugin-directory)
+  - [cri-dockerd configuration](https://github.com/Mirantis/cri-dockerd/blob/519e39ceaa7f9e00319149b9d74b243466fa3963/config/options.go#L161)
+
 ## running as daemonset
 
 This is quickest way to deploy kube-router in Kubernetes (**dont forget to ensure the requirements above**).