Add Fuel glossary

Change-Id: I2adf7ba5d4567ee149f93fe0413f1449d0407881

glossary/d.rst

@@ -0,0 +1,18 @@
+.. _d:
+
+=
+D
+=
+
+.. toctree::
+   :maxdepth: 3
+
+   d/deployment-graph.rst
+   d/deployment-graph-hierarchy.rst
+   d/deployment-graph-rendering.rst
+   d/deployment-group.rst
+   d/deployment-group-fault-tolerance.rst
+   d/deployment-pipeline.rst
+   d/deployment-role.rst
+   d/deployment-task.rst
+   d/discovery.rst

glossary/d/deployment-graph-hierarchy.rst

@@ -0,0 +1,11 @@
+.. _deployment-graph-hierarchy:
+
+Deployment graph hierarchy
+--------------------------
+
+A sequence in which Fuel processes the deployment graph classes.
+The hierarchy of deployment graph classes includes the following levels:
+
+* ``release``
+* ``plugin``
+* ``cluster``

glossary/d/deployment-graph-rendering.rst

@@ -0,0 +1,9 @@
+.. deployment-graph-rendering:
+
+Deployment graph rendering
+--------------------------
+
+The process of compilation of the deployment graph.
+The process comprises the assignment of deployment tasks to nodes,
+computation of the deployment tasks parameters, and resolution of
+the deployment tasks dependencies.

glossary/d/deployment-graph.rst

@@ -0,0 +1,13 @@
+.. _deployment-graph:
+
+Deployment graph
+----------------
+
+A collection of deployment tasks with their parameters and dependencies
+resolved according to the settings of the current deployment.
+
+Fuel renders each graph from a three-level hierarchical representation of its
+class. For example, for basic deployment, the deployment graph class is
+``default``. Fuel builds the deployment graph with respect to the existing
+graphs of the default class for plugins as well as for a cluster-specific
+graph.

glossary/d/deployment-group-fault-tolerance.rst

@@ -0,0 +1,8 @@
+.. deployment-group-fault-tolerance:
+
+Deployment group fault tolerance
+--------------------------------
+
+An absolute or relative value for the number of nodes of a deployment group
+that can fail. The value is useful for the deployment to succeed when a limited
+amount of non-critical nodes fails to deploy.

glossary/d/deployment-group.rst

@@ -0,0 +1,10 @@
+.. deployment-group:
+
+Deployment group
+----------------
+
+A low-level grouping entity which works as an association between
+roles and deployment tasks. Fuel associates each group simultaneously with
+a role and a set of tasks. One role may be associated with more than one
+deployment group and one deployment group may be associated with several
+deployment tasks.

glossary/d/deployment-pipeline.rst

@@ -0,0 +1,25 @@
+.. _deployment-pipeline:
+
+Deployment pipeline
+-------------------
+
+A sequence of data transformations from user-friendly instructions
+to the low-level data representation in the form of deployment input
+data and deployment graph.
+
+The deployment pipeline workflow:
+
+#. Fuel manipulates the input data provided by the user. Data examples:
+
+   * Cluster attributes
+   * OpenStack release version
+   * Networking settings
+   * Huge Pages allocation
+
+#. Fuel converts the data using a set of serializers.
+
+#. Using the converted data, Fuel builds a deployment graph.
+
+#. Fuel passes the deployment graph to a task executor.
+
+#. The task executor carries out the deployment tasks based on the input data.

glossary/d/deployment-role.rst

@@ -0,0 +1,8 @@
+.. deployment-role:
+
+Deployment role
+---------------
+
+A high-level entity representing the node's profile; for example, a set of
+services provided by a node. The examples of a node's profile are
+``controller``, ``compute``, ``load-balancer``, ``zabbix``.

glossary/d/deployment-task.rst

@@ -0,0 +1,11 @@
+.. _deployment-task:
+
+Deployment task
+---------------
+
+A unit of execution on a node responsible for the configuration and
+installation of a particular piece; for example, keystone, database,
+bonding configuration, and so on.
+
+Each deployment task has a set of parameters which specify how and when Fuel
+executes the task.

glossary/d/discovery.rst

@@ -0,0 +1,10 @@
+.. discovery:
+
+Discovery
+---------
+
+The process of discovering a newly booted node for the Fuel purposes of
+provisioning and deployment.
+
+During discovery, the node registers in the Fuel Nailgun service and receives
+an identifier required for the deployment and provisioning phase.

glossary/e.rst

@@ -0,0 +1,10 @@
+.. _e:
+
+=
+E
+=
+
+.. toctree::
+   :maxdepth: 3
+
+   e/environment-release.rst

glossary/e/environment-release.rst

@@ -0,0 +1,12 @@
+.. environment-release:
+
+.. index:: environment, release, Fuel, MOS, MOM, MCP
+
+Environment release
+-------------------
+
+A set of pre-configured parameters applied to an OpenStack environment
+from the ``Release`` template.
+The ``Release`` template specifies a set of common attributes such as a
+repository list, default list of roles, default node partitioning, networks
+allocation, and so on.

glossary/glossary.rst

@@ -0,0 +1,18 @@
+.. _glossary:
+
+Glossary
+========
+
+This glossary is a collection of terms related to OpenStack and Fuel.
+The glossary is intended to assist in consistency in usage
+of terminology in the Fuel documentation.
+
+.. toctree::
+   :maxdepth: 2
+
+   d.rst
+   e.rst
+   i.rst
+   n.rst
+   p.rst
+   s.rst

glossary/i.rst

@@ -0,0 +1,10 @@
+.. _i:
+
+=
+I
+=
+
+.. toctree::
+   :maxdepth: 3
+
+   i/inventory.rst

glossary/i/inventory.rst

@@ -0,0 +1,10 @@
+.. inventory:
+
+Inventory
+---------
+
+The process of collecting specific node data; such as hardware
+specification, rack location in the data-center, and so on.
+
+Fuel Nailgun uses the collected data to calculate the values of
+serialized attributes; such as partitioning schema.

glossary/n.rst

@@ -0,0 +1,11 @@
+.. _n:
+
+=
+N
+=
+
+.. toctree::
+   :maxdepth: 3
+
+   n/nailgun-extension.rst
+   n/nailgun-supertask.rst

glossary/n/nailgun-extension.rst

@@ -0,0 +1,13 @@
+.. nailgun-extension:
+
+Nailgun extension
+-----------------
+
+An isolated piece of code that you keep in a separate repository and
+plug in and out. The Nailgun extension can introduce additional
+API handlers, callbacks and embeds itself into the attributes serialization
+pipeline.
+
+You can use the extensions to integrate into the deployment pipeline
+third-party services, such as LDAP or your own configuration management
+database.

glossary/n/nailgun-supertask.rst

@@ -0,0 +1,15 @@
+.. _nailgun-supertask:
+
+Nailgun supertask
+-----------------
+
+An entity of operations with the cluster. The operations can contain several
+other transactions, such as provisioning, deployment, network verification,
+and so on.
+
+Each cluster operation represents a Nailgun transaction.
+Each transaction may consist of several instances of a deployment pipeline
+invocation: data conversion and graph execution.
+
+.. note:: The transactions cannot be completely rolled back.
+          The transactions are not true transactions in terms of ACID.

glossary/p.rst

@@ -0,0 +1,10 @@
+.. _p:
+
+=
+P
+=
+
+.. toctree::
+   :maxdepth: 3
+
+   p/provisioning.rst

glossary/p/provisioning.rst

@@ -0,0 +1,11 @@
+.. provisioning:
+
+Provisioning
+------------
+
+The process of setting up a node into a minimal viable state with a
+pre-installed operating system and required supporting components.
+This process includes partitioning, installation of base system, and
+preconfiguration of a minimal amount of services and settings that Fuel
+requires to be able to manage this node after rebooting it into the
+installed system.

glossary/s.rst

@@ -0,0 +1,10 @@
+.. _s:
+
+=
+S
+=
+
+.. toctree::
+   :maxdepth: 3
+
+   s/serialized-attributes.rst

glossary/s/serialized-attributes.rst

@@ -0,0 +1,17 @@
+.. serialized-attributes:
+
+Serialized attributes
+---------------------
+
+A large hash of attributes used as input data for deployment tasks.
+
+Fuel derives the serialized attributes from the user-provided high-level
+input.
+
+Input examples:
+
+* Common cluster attributes
+* Per-node attributes
+* Networking configuration
+* Node data collected during the inventory phase
+* Any third-party configuration

index.rst

@@ -48,4 +48,14 @@ Learn how to develop and work with Fuel plugins
 .. toctree::
    :maxdepth: 1
 
-   plugindocs/fuel-plugin-sdk-guide
+   plugindocs/fuel-plugin-sdk-guide
+
+Glossary
+~~~~~~~~
+
+Fuel documentation glossary
+
+.. toctree::
+   :maxdepth: 1
+
+   glossary/glossary.rst