diff --git a/doc/index.rst b/doc/index.rst index 86f96684fb..bb062223b2 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 0000000000..4e4f201f75 --- /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 +``:8085``. + +The default username is ``admin``, the password can be located under +```` in ``/etc/kolla/passwords.yml``. + +For more information about how Skydive works, see +`Skydive – An open source real-time network topology and protocols analyzer +`__.