diff --git a/doc/source/conf.py b/doc/source/conf.py index f472764b7..94df31175 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -63,7 +63,7 @@ exclude_patterns = [ # included in the toctree themselves, so tell Sphinx to ignore # them when scanning for input files. 'man/footer.rst', - 'man/general_options.rst', + 'man/general-options.rst', ] # If true, '()' will be appended to :func: etc. cross-reference text. diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index e037e856c..a3c069bcf 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -262,7 +262,7 @@ specific domain. Please, read `the official OpenStack definition of a Project `_. -.. _primitive_definition: +.. _sla_definition: SLA === diff --git a/watcher/api/controllers/v1/action.py b/watcher/api/controllers/v1/action.py index 9a23ba120..e643ee7d8 100644 --- a/watcher/api/controllers/v1/action.py +++ b/watcher/api/controllers/v1/action.py @@ -30,8 +30,7 @@ of the OpenStack :ref:`Cluster ` such as: - Changing the current state of an hypervisor (enable or disable) with Nova In most cases, an :ref:`Action ` triggers some concrete -commands on an existing OpenStack module (Nova, Neutron, Cinder, Ironic, etc.) -via a :ref:`Primitive `. +commands on an existing OpenStack module (Nova, Neutron, Cinder, Ironic, etc.). An :ref:`Action ` has a life-cycle and its current state may be one of the following: diff --git a/watcher/applier/actions/base.py b/watcher/applier/actions/base.py index 86f930c04..facf47911 100644 --- a/watcher/applier/actions/base.py +++ b/watcher/applier/actions/base.py @@ -17,19 +17,6 @@ # limitations under the License. # -""" -A :ref:`Primitive ` is the component that carries out a -certain type of atomic :ref:`Actions ` on a given -:ref:`Managed resource ` (nova, swift, neutron, -glance,..). A :ref:`Primitive ` is a part of the -:ref:`Watcher Applier ` module. - -For example, there can be a :ref:`Primitive ` which is -responsible for creating a snapshot of a given instance on a Nova compute node. -This :ref:`Primitive ` knows exactly how to send -the appropriate commands to Nova for this type of -:ref:`Actions `. -""" import abc diff --git a/watcher/applier/base.py b/watcher/applier/base.py index 55f2187a5..daa409714 100644 --- a/watcher/applier/base.py +++ b/watcher/applier/base.py @@ -22,7 +22,7 @@ This component is in charge of executing the :ref:`Action Plan ` built by the :ref:`Watcher Decision Engine `. -See :doc:`architecture` for more details on this component. +See: :doc:`../architecture` for more details on this component. """ import abc diff --git a/watcher/decision_engine/manager.py b/watcher/decision_engine/manager.py index 13078a750..941d4351b 100644 --- a/watcher/decision_engine/manager.py +++ b/watcher/decision_engine/manager.py @@ -34,7 +34,7 @@ of :ref:`Actions ` which are scheduled in time by the :ref:`Watcher Planner ` (i.e., it generates an :ref:`Action Plan `). -See :doc:`architecture` for more details on this component. +See :doc:`../architecture` for more details on this component. """ from oslo_config import cfg diff --git a/watcher/decision_engine/planner/base.py b/watcher/decision_engine/planner/base.py index 1504617ae..e628f62c2 100644 --- a/watcher/decision_engine/planner/base.py +++ b/watcher/decision_engine/planner/base.py @@ -37,7 +37,7 @@ congestion which may decrease the :ref:`SLA ` for It is also important to schedule :ref:`Actions ` in order to avoid security issues such as denial of service on core OpenStack services. -See :doc:`architecture` for more details on this component. +See :doc:`../architecture` for more details on this component. """ import abc