From 5d40367bef3eb37ccf51f9fca74a42cb5c59d26f Mon Sep 17 00:00:00 2001 From: Ifat Afek Date: Tue, 25 Jul 2017 07:55:28 +0000 Subject: [PATCH] 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 --- doc/source/contributor/.gitkeep | 0 .../{ => contributor}/add-new-datasource.rst | 0 .../alarm-severity-config.rst | 0 doc/source/contributor/configuration.rst | 14 +++++ .../contributor/devstack-installation.rst | 21 ++++++++ .../host_high_memory_consumption.yaml | 0 .../images/add_aodh_alarm_flow.png | Bin .../images/add_aodh_alarm_graph.png | Bin .../images/add_nova_instance_flow.png | Bin .../images/add_nova_instance_graph.png | Bin .../images/complex_rca_graph.png | Bin .../images/low_level_design.png | Bin .../images/nagios_causes_deduced_flow.png | Bin .../images/nagios_causes_deduced_graph.png | Bin .../{ => contributor}/images/rca_flow.png | Bin .../{ => contributor}/images/rca_graph.png | Bin .../images/vitrage-ha-vision.png | Bin .../images/vitrage_graph_architecture.png | Bin doc/source/contributor/index.rst | 5 ++ .../{ => contributor}/nagios-config.rst | 0 .../nagios-devstack-installation.rst | 0 .../not_operator_support.rst | 0 .../notifier-snmp-plugin.rst | 0 .../resource-state-config.rst | 0 .../{ => contributor}/scenario-evaluator.rst | 0 .../{ => contributor}/static-config.rst | 0 .../static-physical-config.rst | 0 .../template_validation_status_code.rst | 0 .../{ => contributor}/templates-loading.rst | 0 doc/source/{ => contributor}/vitrage-api.rst | 0 .../{ => contributor}/vitrage-first_steps.rst | 0 .../vitrage-graph-design.rst | 0 .../vitrage-ha-and-history-vision.rst | 0 .../vitrage-template-format.rst | 0 .../{ => contributor}/vitrage-use-cases.rst | 0 .../{ => contributor}/zabbix_vitrage.rst | 0 doc/source/index.rst | 33 +++++++----- doc/source/installation-and-configuration.rst | 50 ------------------ .../tests/api/alarms/base.py | 2 +- 39 files changed, 62 insertions(+), 63 deletions(-) delete mode 100644 doc/source/contributor/.gitkeep rename doc/source/{ => contributor}/add-new-datasource.rst (100%) rename doc/source/{ => contributor}/alarm-severity-config.rst (100%) create mode 100644 doc/source/contributor/configuration.rst create mode 100644 doc/source/contributor/devstack-installation.rst rename doc/source/{ => contributor}/host_high_memory_consumption.yaml (100%) rename doc/source/{ => contributor}/images/add_aodh_alarm_flow.png (100%) rename doc/source/{ => contributor}/images/add_aodh_alarm_graph.png (100%) rename doc/source/{ => contributor}/images/add_nova_instance_flow.png (100%) rename doc/source/{ => contributor}/images/add_nova_instance_graph.png (100%) rename doc/source/{ => contributor}/images/complex_rca_graph.png (100%) rename doc/source/{ => contributor}/images/low_level_design.png (100%) rename doc/source/{ => contributor}/images/nagios_causes_deduced_flow.png (100%) rename doc/source/{ => contributor}/images/nagios_causes_deduced_graph.png (100%) rename doc/source/{ => contributor}/images/rca_flow.png (100%) rename doc/source/{ => contributor}/images/rca_graph.png (100%) rename doc/source/{ => contributor}/images/vitrage-ha-vision.png (100%) rename doc/source/{ => contributor}/images/vitrage_graph_architecture.png (100%) create mode 100644 doc/source/contributor/index.rst rename doc/source/{ => contributor}/nagios-config.rst (100%) rename doc/source/{ => contributor}/nagios-devstack-installation.rst (100%) rename doc/source/{ => contributor}/not_operator_support.rst (100%) rename doc/source/{ => contributor}/notifier-snmp-plugin.rst (100%) rename doc/source/{ => contributor}/resource-state-config.rst (100%) rename doc/source/{ => contributor}/scenario-evaluator.rst (100%) rename doc/source/{ => contributor}/static-config.rst (100%) rename doc/source/{ => contributor}/static-physical-config.rst (100%) rename doc/source/{ => contributor}/template_validation_status_code.rst (100%) rename doc/source/{ => contributor}/templates-loading.rst (100%) rename doc/source/{ => contributor}/vitrage-api.rst (100%) rename doc/source/{ => contributor}/vitrage-first_steps.rst (100%) rename doc/source/{ => contributor}/vitrage-graph-design.rst (100%) rename doc/source/{ => contributor}/vitrage-ha-and-history-vision.rst (100%) rename doc/source/{ => contributor}/vitrage-template-format.rst (100%) rename doc/source/{ => contributor}/vitrage-use-cases.rst (100%) rename doc/source/{ => contributor}/zabbix_vitrage.rst (100%) delete mode 100644 doc/source/installation-and-configuration.rst diff --git a/doc/source/contributor/.gitkeep b/doc/source/contributor/.gitkeep deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/source/add-new-datasource.rst b/doc/source/contributor/add-new-datasource.rst similarity index 100% rename from doc/source/add-new-datasource.rst rename to doc/source/contributor/add-new-datasource.rst diff --git a/doc/source/alarm-severity-config.rst b/doc/source/contributor/alarm-severity-config.rst similarity index 100% rename from doc/source/alarm-severity-config.rst rename to doc/source/contributor/alarm-severity-config.rst diff --git a/doc/source/contributor/configuration.rst b/doc/source/contributor/configuration.rst new file mode 100644 index 000000000..acad1d1a3 --- /dev/null +++ b/doc/source/contributor/configuration.rst @@ -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 diff --git a/doc/source/contributor/devstack-installation.rst b/doc/source/contributor/devstack-installation.rst new file mode 100644 index 000000000..107800330 --- /dev/null +++ b/doc/source/contributor/devstack-installation.rst @@ -0,0 +1,21 @@ +===================== +Devstack Installation +===================== + +Vitrage Devstack Installation +============================= + +* `Enabling Vitrage in devstack `_ + +* `Enabling Vitrage in horizon `_ + +External Monitor Installation +============================= + +To install Nagios or Zabbix external monitors: + +.. toctree:: + :maxdepth: 1 + + nagios-devstack-installation + zabbix_vitrage diff --git a/doc/source/host_high_memory_consumption.yaml b/doc/source/contributor/host_high_memory_consumption.yaml similarity index 100% rename from doc/source/host_high_memory_consumption.yaml rename to doc/source/contributor/host_high_memory_consumption.yaml diff --git a/doc/source/images/add_aodh_alarm_flow.png b/doc/source/contributor/images/add_aodh_alarm_flow.png similarity index 100% rename from doc/source/images/add_aodh_alarm_flow.png rename to doc/source/contributor/images/add_aodh_alarm_flow.png diff --git a/doc/source/images/add_aodh_alarm_graph.png b/doc/source/contributor/images/add_aodh_alarm_graph.png similarity index 100% rename from doc/source/images/add_aodh_alarm_graph.png rename to doc/source/contributor/images/add_aodh_alarm_graph.png diff --git a/doc/source/images/add_nova_instance_flow.png b/doc/source/contributor/images/add_nova_instance_flow.png similarity index 100% rename from doc/source/images/add_nova_instance_flow.png rename to doc/source/contributor/images/add_nova_instance_flow.png diff --git a/doc/source/images/add_nova_instance_graph.png b/doc/source/contributor/images/add_nova_instance_graph.png similarity index 100% rename from doc/source/images/add_nova_instance_graph.png rename to doc/source/contributor/images/add_nova_instance_graph.png diff --git a/doc/source/images/complex_rca_graph.png b/doc/source/contributor/images/complex_rca_graph.png similarity index 100% rename from doc/source/images/complex_rca_graph.png rename to doc/source/contributor/images/complex_rca_graph.png diff --git a/doc/source/images/low_level_design.png b/doc/source/contributor/images/low_level_design.png similarity index 100% rename from doc/source/images/low_level_design.png rename to doc/source/contributor/images/low_level_design.png diff --git a/doc/source/images/nagios_causes_deduced_flow.png b/doc/source/contributor/images/nagios_causes_deduced_flow.png similarity index 100% rename from doc/source/images/nagios_causes_deduced_flow.png rename to doc/source/contributor/images/nagios_causes_deduced_flow.png diff --git a/doc/source/images/nagios_causes_deduced_graph.png b/doc/source/contributor/images/nagios_causes_deduced_graph.png similarity index 100% rename from doc/source/images/nagios_causes_deduced_graph.png rename to doc/source/contributor/images/nagios_causes_deduced_graph.png diff --git a/doc/source/images/rca_flow.png b/doc/source/contributor/images/rca_flow.png similarity index 100% rename from doc/source/images/rca_flow.png rename to doc/source/contributor/images/rca_flow.png diff --git a/doc/source/images/rca_graph.png b/doc/source/contributor/images/rca_graph.png similarity index 100% rename from doc/source/images/rca_graph.png rename to doc/source/contributor/images/rca_graph.png diff --git a/doc/source/images/vitrage-ha-vision.png b/doc/source/contributor/images/vitrage-ha-vision.png similarity index 100% rename from doc/source/images/vitrage-ha-vision.png rename to doc/source/contributor/images/vitrage-ha-vision.png diff --git a/doc/source/images/vitrage_graph_architecture.png b/doc/source/contributor/images/vitrage_graph_architecture.png similarity index 100% rename from doc/source/images/vitrage_graph_architecture.png rename to doc/source/contributor/images/vitrage_graph_architecture.png diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..12f2c8f0f --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,5 @@ +Developer's Reference +===================== + +.. toctree:: + :maxdepth: 1 diff --git a/doc/source/nagios-config.rst b/doc/source/contributor/nagios-config.rst similarity index 100% rename from doc/source/nagios-config.rst rename to doc/source/contributor/nagios-config.rst diff --git a/doc/source/nagios-devstack-installation.rst b/doc/source/contributor/nagios-devstack-installation.rst similarity index 100% rename from doc/source/nagios-devstack-installation.rst rename to doc/source/contributor/nagios-devstack-installation.rst diff --git a/doc/source/not_operator_support.rst b/doc/source/contributor/not_operator_support.rst similarity index 100% rename from doc/source/not_operator_support.rst rename to doc/source/contributor/not_operator_support.rst diff --git a/doc/source/notifier-snmp-plugin.rst b/doc/source/contributor/notifier-snmp-plugin.rst similarity index 100% rename from doc/source/notifier-snmp-plugin.rst rename to doc/source/contributor/notifier-snmp-plugin.rst diff --git a/doc/source/resource-state-config.rst b/doc/source/contributor/resource-state-config.rst similarity index 100% rename from doc/source/resource-state-config.rst rename to doc/source/contributor/resource-state-config.rst diff --git a/doc/source/scenario-evaluator.rst b/doc/source/contributor/scenario-evaluator.rst similarity index 100% rename from doc/source/scenario-evaluator.rst rename to doc/source/contributor/scenario-evaluator.rst diff --git a/doc/source/static-config.rst b/doc/source/contributor/static-config.rst similarity index 100% rename from doc/source/static-config.rst rename to doc/source/contributor/static-config.rst diff --git a/doc/source/static-physical-config.rst b/doc/source/contributor/static-physical-config.rst similarity index 100% rename from doc/source/static-physical-config.rst rename to doc/source/contributor/static-physical-config.rst diff --git a/doc/source/template_validation_status_code.rst b/doc/source/contributor/template_validation_status_code.rst similarity index 100% rename from doc/source/template_validation_status_code.rst rename to doc/source/contributor/template_validation_status_code.rst diff --git a/doc/source/templates-loading.rst b/doc/source/contributor/templates-loading.rst similarity index 100% rename from doc/source/templates-loading.rst rename to doc/source/contributor/templates-loading.rst diff --git a/doc/source/vitrage-api.rst b/doc/source/contributor/vitrage-api.rst similarity index 100% rename from doc/source/vitrage-api.rst rename to doc/source/contributor/vitrage-api.rst diff --git a/doc/source/vitrage-first_steps.rst b/doc/source/contributor/vitrage-first_steps.rst similarity index 100% rename from doc/source/vitrage-first_steps.rst rename to doc/source/contributor/vitrage-first_steps.rst diff --git a/doc/source/vitrage-graph-design.rst b/doc/source/contributor/vitrage-graph-design.rst similarity index 100% rename from doc/source/vitrage-graph-design.rst rename to doc/source/contributor/vitrage-graph-design.rst diff --git a/doc/source/vitrage-ha-and-history-vision.rst b/doc/source/contributor/vitrage-ha-and-history-vision.rst similarity index 100% rename from doc/source/vitrage-ha-and-history-vision.rst rename to doc/source/contributor/vitrage-ha-and-history-vision.rst diff --git a/doc/source/vitrage-template-format.rst b/doc/source/contributor/vitrage-template-format.rst similarity index 100% rename from doc/source/vitrage-template-format.rst rename to doc/source/contributor/vitrage-template-format.rst diff --git a/doc/source/vitrage-use-cases.rst b/doc/source/contributor/vitrage-use-cases.rst similarity index 100% rename from doc/source/vitrage-use-cases.rst rename to doc/source/contributor/vitrage-use-cases.rst diff --git a/doc/source/zabbix_vitrage.rst b/doc/source/contributor/zabbix_vitrage.rst similarity index 100% rename from doc/source/zabbix_vitrage.rst rename to doc/source/contributor/zabbix_vitrage.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 49577f493..460ec4870 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 diff --git a/doc/source/installation-and-configuration.rst b/doc/source/installation-and-configuration.rst deleted file mode 100644 index 7325b2c1e..000000000 --- a/doc/source/installation-and-configuration.rst +++ /dev/null @@ -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 `_ - -* `Enabling Vitrage in horizon `_ - ---------------------------------------------------- -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 diff --git a/vitrage_tempest_tests/tests/api/alarms/base.py b/vitrage_tempest_tests/tests/api/alarms/base.py index a71c3fb18..234a875ed 100644 --- a/vitrage_tempest_tests/tests/api/alarms/base.py +++ b/vitrage_tempest_tests/tests/api/alarms/base.py @@ -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):