From fdeffed03ed2ec10033b55b87feb76bba793ea13 Mon Sep 17 00:00:00 2001
From: Bertrand Lallau <bertrand.lallau@thalesgroup.com>
Date: Tue, 13 Jun 2017 15:56:22 +0200
Subject: [PATCH] Add Skydive startup guide documentation
Just a simple startup guide for Skydive
Change-Id: I79c175c592fba9d078cee9b1b948597ec60bc68c
---
doc/index.rst | 1 +
doc/skydive-guide.rst | 37 +++++++++++++++++++++++++++++++++++++
2 files changed, 38 insertions(+)
create mode 100644 doc/skydive-guide.rst
diff --git a/doc/index.rst b/doc/index.rst
index 86f96684f..bb062223b 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -72,6 +72,7 @@ Services
kuryr-guide
zun-guide
osprofiler-guide
+ skydive-guide
Developer Docs
==============
diff --git a/doc/skydive-guide.rst b/doc/skydive-guide.rst
new file mode 100644
index 000000000..4e4f201f7
--- /dev/null
+++ b/doc/skydive-guide.rst
@@ -0,0 +1,37 @@
+.. _skydive-guide:
+
+================
+Skydive in Kolla
+================
+
+Overview
+========
+Skydive is an open source real-time network topology and protocols analyzer.
+It aims to provide a comprehensive way of understanding what is happening in
+the network infrastructure.
+Skydive agents collect topology information and flows and forward them to a
+central agent for further analysis.
+All the information is stored in an Elasticsearch database.
+
+Configuration on Kolla deployment
+---------------------------------
+
+Enable Skydive in ``/etc/kolla/globals.yml``
+
+.. code-block:: console
+
+ enable_skydive: "yes"
+ enable_elasticsearch: "yes"
+
+Verify operation
+----------------
+
+After successful deployment, Skydive can be accessed using a browser on
+``<kolla_external_vip_address>:8085``.
+
+The default username is ``admin``, the password can be located under
+``<keystone_admin_password>`` in ``/etc/kolla/passwords.yml``.
+
+For more information about how Skydive works, see
+`Skydive – An open source real-time network topology and protocols analyzer
+<https://github.com/skydive-project/skydive/>`__.
--
GitLab