airship
/
deckhand
Code Issues Proposed changes

docs: Add use cases for each of the mutation operations 

This patch set adds use cases for each of the mutation
operations used by Deckhand:

* substitution
* layering
* replacement

To help document authors decide which operations they should use.

Change-Id: I8bc470c7ddc2f3c0aa9d4372a2323fa84632e369
This commit is contained in:
Felipe Monteiro 2018-11-06 09:34:46 -05:00
parent 947810ada5
commit 82ceafa7bc
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/source/users/rendering.rst
View File

@ -32,16 +32,40 @@ The following algorithms are involved during the rendering process:
Substitution provides an "open" data sharing model in which any source Substitution provides an "open" data sharing model in which any source
document can be used to substitute data into any destination document. document can be used to substitute data into any destination document.
Use Cases
^^^^^^^^^
* Sharing of data between specific documents no matter their ``schema``.
* Data sharing using pattern matching.
* Fine-grained sharing of specific sections of data.
:ref:`layering` :ref:`layering`
--------------- ---------------
Layering provides a "restricted" data inheritance model intended to help Layering provides a "restricted" data inheritance model intended to help
reduce duplication in configuration. reduce duplication in configuration.
Use Cases
^^^^^^^^^
* Sharing of data between documents with the same ``schema``.
* Deep merging of objects and lists.
* Layer order with multiple layers, resulting in a larger hierarchy of
documents.
* Source document for data sharing can be identified via labels, allowing for
different documents to be used as the source for sharing, depending on
:ref:`parent-selection`.
:ref:`replacement` :ref:`replacement`
------------------ ------------------
Replacement builds on top of layering to provide yet another mechanism Replacement builds on top of layering to provide yet another mechanism
for reducing data duplication. for reducing data duplication.
Use Cases
^^^^^^^^^
* Same as layering, but with a need to replace higher-layer documents with
lower-layer documents for specific site deployments.
.. _Barbican: https://docs.openstack.org/barbican/latest/api/ .. _Barbican: https://docs.openstack.org/barbican/latest/api/