From daa560111c9c080f9fbbc05d5854d4382a9b6edd Mon Sep 17 00:00:00 2001 From: Jean-Emile DARTOIS <jean-emile.dartois@b-com.com> Date: Tue, 8 Dec 2015 10:58:14 +0100 Subject: [PATCH] Update the glossary to lay down Watcher terminology The Primitive used by the applier is not defined in the glossary. This patchset start to fix this gap Change-Id: Ie3fe153fc4c396da5c83425ccdd540910ad33e49 --- doc/source/dev/glossary.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/doc/source/dev/glossary.rst b/doc/source/dev/glossary.rst index c57765449..d5c38c1a6 100644 --- a/doc/source/dev/glossary.rst +++ b/doc/source/dev/glossary.rst @@ -41,7 +41,8 @@ of the OpenStack :ref:`Cluster <cluster_definition>` such as: - Changing the current state of an hypervisor (enable or disable) with Nova In most cases, an :ref:`Action <action_definition>` triggers some concrete -commands on an existing OpenStack module (Nova, Neutron, Cinder, Ironic, etc.). +commands on an existing OpenStack module (Nova, Neutron, Cinder, Ironic, etc.) +via a :ref:`Primitive <primitive_definition>`. An :ref:`Action <action_definition>` has a life-cycle and its current state may be one of the following: @@ -521,6 +522,24 @@ specific domain. Please, read `the official OpenStack definition of a Project <http://docs.openstack.org/glossary/content/glossary.html>`_. + +.. _primitive_definition + +Primitive +========= + +A :ref:`Primitive <primitive_definition>` is the component that carries out a +certain type of atomic :ref:`Actions <action_definition>` on a given +:ref:`Managed resource <managed_resource_definition>` (nova, swift, neutron, +glance,..). A :ref:`Primitive <primitive_definition>` is a part of the +:ref:`Watcher Applier <watcher_applier_definition>` module. + +For example, there can be a :ref:`Primitive <primitive_definition>` which is +responsible for creating a snapshot of a given instance on a Nova compute node. +This :ref:`Primitive <primitive_definition>` knows exactly how to send +the appropriate commands to Nova for this type of +:ref:`Actions <action_definition>`. + .. _sla_definition: SLA