Add Skydive startup guide documentation

Just a simple startup guide for Skydive

Change-Id: I79c175c592fba9d078cee9b1b948597ec60bc68c
This commit is contained in:
Bertrand Lallau 2017-06-13 15:56:22 +02:00 committed by Bertrand Lallau
parent 381c18975c
commit fdeffed03e
2 changed files with 38 additions and 0 deletions

View File

@ -72,6 +72,7 @@ Services
kuryr-guide
zun-guide
osprofiler-guide
skydive-guide
Developer Docs
==============

37
doc/skydive-guide.rst Normal file
View File

@ -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/>`__.