Doc Migration: move the developer guide documents under the "contributor" folder
Changed files: - index.rst - contributor/index.rst - installation-and-configuration - split to devstack-installation.rst and configuration.rst Change-Id: I4683a213e2a530d2088c4f232b9c2508fc25ba68
Ifat Afek
14
doc/source/contributor/configuration.rst
Normal file
@ -0,0 +1,14 @@
|
||||
=====================
|
||||
Vitrage configuration
|
||||
=====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
nagios-config
|
||||
static-config
|
||||
static-physical-config
|
||||
resource-state-config
|
||||
alarm-severity-config
|
||||
zabbix_vitrage
|
||||
notifier-snmp-plugin
|
||||
21
doc/source/contributor/devstack-installation.rst
Normal file
@ -0,0 +1,21 @@
|
||||
=====================
|
||||
Devstack Installation
|
||||
=====================
|
||||
|
||||
Vitrage Devstack Installation
|
||||
=============================
|
||||
|
||||
* `Enabling Vitrage in devstack <https://github.com/openstack/vitrage/blob/master/devstack/README.rst>`_
|
||||
|
||||
* `Enabling Vitrage in horizon <https://github.com/openstack/vitrage-dashboard/blob/master/README.rst>`_
|
||||
|
||||
External Monitor Installation
|
||||
=============================
|
||||
|
||||
To install Nagios or Zabbix external monitors:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
nagios-devstack-installation
|
||||
zabbix_vitrage
|
||||
|
Before Width: | Height: | Size: 200 KiB After Width: | Height: | Size: 200 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 217 KiB After Width: | Height: | Size: 217 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 229 KiB After Width: | Height: | Size: 229 KiB |
|
Before Width: | Height: | Size: 212 KiB After Width: | Height: | Size: 212 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 193 KiB After Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 263 KiB After Width: | Height: | Size: 263 KiB |
5
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,5 @@
|
||||
Developer's Reference
|
||||
=====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@ -26,7 +26,7 @@ High Level Functionality
|
||||
High Level Architecture
|
||||
-----------------------
|
||||
|
||||
.. image:: ./images/vitrage_graph_architecture.png
|
||||
.. image:: ./contributor/images/vitrage_graph_architecture.png
|
||||
:width: 100%
|
||||
:align: center
|
||||
|
||||
@ -62,13 +62,22 @@ Installation Guide
|
||||
Developer Guide
|
||||
---------------
|
||||
|
||||
.. # NOTE(ifat-afek): Hide files we don't want to see in the table of contents.
|
||||
# sphinx build fails if a file is not included in the toctree.
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
contributor/index
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
vitrage-first_steps
|
||||
vitrage-api
|
||||
vitrage-template-format
|
||||
installation-and-configuration
|
||||
contributor/vitrage-first_steps
|
||||
contributor/vitrage-api
|
||||
contributor/vitrage-template-format
|
||||
contributor/devstack-installation
|
||||
contributor/configuration
|
||||
profiler-config
|
||||
|
||||
Design Documents
|
||||
----------------
|
||||
@ -76,10 +85,10 @@ Design Documents
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
vitrage-graph-design
|
||||
scenario-evaluator
|
||||
vitrage-use-cases
|
||||
add-new-datasource
|
||||
not_operator_support
|
||||
templates-loading
|
||||
vitrage-ha-and-history-vision
|
||||
contributor/vitrage-graph-design
|
||||
contributor/scenario-evaluator
|
||||
contributor/vitrage-use-cases
|
||||
contributor/add-new-datasource
|
||||
contributor/not_operator_support
|
||||
contributor/templates-loading
|
||||
contributor/vitrage-ha-and-history-vision
|
||||
|
||||
@ -1,50 +0,0 @@
|
||||
==============================
|
||||
Installation and configuration
|
||||
==============================
|
||||
|
||||
Vitrage Installation
|
||||
====================
|
||||
|
||||
To Install Vitrage, use **either** devstack installation or manual installation
|
||||
|
||||
--------------------------
|
||||
Enable Vitrage in Devstack
|
||||
--------------------------
|
||||
|
||||
* `Enabling Vitrage in devstack <https://github.com/openstack/vitrage/blob/master/devstack/README.rst>`_
|
||||
|
||||
* `Enabling Vitrage in horizon <https://github.com/openstack/vitrage-dashboard/blob/master/README.rst>`_
|
||||
|
||||
---------------------------------------------------
|
||||
Manual Installation of Vitrage (not using Devstack)
|
||||
---------------------------------------------------
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
install/index
|
||||
|
||||
External Monitor Installation
|
||||
=============================
|
||||
|
||||
To install Nagios or Zabbix external monitors:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
nagios-devstack-installation
|
||||
zabbix_vitrage
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
nagios-config
|
||||
static-config
|
||||
static-physical-config
|
||||
resource-state-config
|
||||
alarm-severity-config
|
||||
zabbix_vitrage
|
||||
notifier-snmp-plugin
|
||||
profiler-config
|
||||
@ -52,7 +52,7 @@ class BaseAlarmsTest(BaseApiTest):
|
||||
self._wait_for_status(20,
|
||||
self._check_num_alarms,
|
||||
num_alarms=0)
|
||||
time.sleep(25)
|
||||
time.sleep(120)
|
||||
|
||||
@staticmethod
|
||||
def _aodh_request(resource_id=None, name=None):
|
||||
|
||||