[Kimchi-devel] [PATCH 5/6] Add documentation on how to enable federation on Kimchi

[Aline Manera]

README-federation.md is specific for the federation feature.
It explains how to install openSLP and enable federation on Kimchi.

Signed-off-by: Aline Manera <alinefm at linux.vnet.ibm.com>
---
 docs/README-federation.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 docs/README-federation.md

diff --git a/docs/README-federation.md b/docs/README-federation.md
new file mode 100644
index 0000000..fdf4aed
--- /dev/null
+++ b/docs/README-federation.md
@@ -0,0 +1,27 @@
+Kimchi Project - Federation Feature
+===================================
+
+Federation feature is a mechanism to discover Kimchi peers in the same network.
+It uses openSLP tool (http://www.openslp.org/) to register and find the Kimchi
+servers.
+
+By default this feature is disabled on Kimchi as it is not critical for KVM
+virtualization and requires additional software installation.
+
+To enable it, do the following:
+
+1) Install openslp and openslp-server packages
+2) openSLP uses port 427 (UDP) and port 427 (TCP) so make sure to open those
+   ports in your firewall configuration
+3) Start slpd service and make sure it is up while running Kimchi
+4) Enable federation on Kimchi by editing the /etc/kimchi/kimchi.conf file:
+
+   federation = on
+
+5) Then restart Kimchi service
+
+The Kimchi server will be registered on openSLP on server starting up and will
+be found by other Kimchi peers (with federation feature enabled) in the same
+network.
+
+Enjoy!
-- 
1.9.3