From: Kuralamudhan Ramakrishnan <kuralamudhan.ramakrishnan@intel.com>
Date: Tue, 22 Sep 2020 20:20:46 +0000 (-0700)
Subject: adding configuration.md
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=acfbeec4da4e9f600c97ea83a7cdb14721a72f89;p=ovn4nfv-k8s-plugin.git

adding configuration.md

Signed-off-by: Kuralamudhan Ramakrishnan <kuralamudhan.ramakrishnan@intel.com>
Change-Id: Ia591e36d5e4e8a030579fea54f686cfacf184585
---

diff --git a/doc/configuration.md b/doc/configuration.md
new file mode 100644
index 0000000..db1a91d
--- /dev/null
+++ b/doc/configuration.md
@@ -0,0 +1,20 @@
+#OVN4NFV Configuration Reference
+
+ovn4nfv is not having any cni configuration. All the configuration are encapsulated within ovn4nfv-cni - `build/bin/entrypoint`
+
+ovn4nfv-cni daemonset creates following cni configuration file `/etc/cni/net.d/00-network.conf` in each node
+```
+{
+  "name": "ovn4nfv-k8s-plugin",
+  "type": "ovn4nfvk8s-cni",
+  "cniVersion": "0.3.1"
+}
+```
+ovn4nfv cni-server use incluster-communication and cni shim uses the out-of-cluster
+communication using the auto generated kubeconfig in each node.
+
+#logging
+
+Log is enabled by default and log file - `/var/log/openvswitch/ovn4k8s.log`
+
+ovn log and openvswitch log can be find in the `/var/log/openvswitch` & `/var/log/ovn`