summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelipe Monteiro <felipe.monteiro@att.com>2018-11-06 09:34:46 -0500
committerFelipe Monteiro <felipe.monteiro@att.com>2018-11-06 09:37:35 -0500
commit82ceafa7bc89726503c58b9ba72faf8ff600a8fe (patch)
tree8827de008814abf4372f078f973c964bf5669ac2
parent947810ada5fb2f92e28b9eac6f6ebf8dedb460f1 (diff)
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
Notes
Notes (review): Code-Review+2: Roman Gorshunov <roman.gorshunov@att.com> Code-Review+1: Drew Walters <drewwalters96@gmail.com> Code-Review+2: Bryan Strassner <strassner.bryan@gmail.com> Workflow+1: Bryan Strassner <strassner.bryan@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Fri, 22 Feb 2019 23:20:28 +0000 Reviewed-on: https://review.openstack.org/615892 Project: openstack/airship-deckhand Branch: refs/heads/master
-rw-r--r--doc/source/users/rendering.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/source/users/rendering.rst b/doc/source/users/rendering.rst
index cd92db2..a1746fc 100644
--- a/doc/source/users/rendering.rst
+++ b/doc/source/users/rendering.rst
@@ -32,16 +32,40 @@ The following algorithms are involved during the rendering process:
32Substitution provides an "open" data sharing model in which any source 32Substitution provides an "open" data sharing model in which any source
33document can be used to substitute data into any destination document. 33document can be used to substitute data into any destination document.
34 34
35Use Cases
36^^^^^^^^^
37
38* Sharing of data between specific documents no matter their ``schema``.
39* Data sharing using pattern matching.
40* Fine-grained sharing of specific sections of data.
41
35:ref:`layering` 42:ref:`layering`
36--------------- 43---------------
37 44
38Layering provides a "restricted" data inheritance model intended to help 45Layering provides a "restricted" data inheritance model intended to help
39reduce duplication in configuration. 46reduce duplication in configuration.
40 47
48Use Cases
49^^^^^^^^^
50
51* Sharing of data between documents with the same ``schema``.
52* Deep merging of objects and lists.
53* Layer order with multiple layers, resulting in a larger hierarchy of
54 documents.
55* Source document for data sharing can be identified via labels, allowing for
56 different documents to be used as the source for sharing, depending on
57 :ref:`parent-selection`.
58
41:ref:`replacement` 59:ref:`replacement`
42------------------ 60------------------
43 61
44Replacement builds on top of layering to provide yet another mechanism 62Replacement builds on top of layering to provide yet another mechanism
45for reducing data duplication. 63for reducing data duplication.
46 64
65Use Cases
66^^^^^^^^^
67
68* Same as layering, but with a need to replace higher-layer documents with
69 lower-layer documents for specific site deployments.
70
47.. _Barbican: https://docs.openstack.org/barbican/latest/api/ 71.. _Barbican: https://docs.openstack.org/barbican/latest/api/