Browse Source

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
changes/92/615892/3
Felipe Monteiro 6 months ago
parent
commit
82ceafa7bc
1 changed files with 24 additions and 0 deletions
  1. 24
    0
      doc/source/users/rendering.rst

+ 24
- 0
doc/source/users/rendering.rst View File

@@ -32,16 +32,40 @@ The following algorithms are involved during the rendering process:
32 32
 Substitution provides an "open" data sharing model in which any source
33 33
 document can be used to substitute data into any destination document.
34 34
 
35
+Use 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 42
 :ref:`layering`
36 43
 ---------------
37 44
 
38 45
 Layering provides a "restricted" data inheritance model intended to help
39 46
 reduce duplication in configuration.
40 47
 
48
+Use 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 59
 :ref:`replacement`
42 60
 ------------------
43 61
 
44 62
 Replacement builds on top of layering to provide yet another mechanism
45 63
 for reducing data duplication.
46 64
 
65
+Use 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 71
 .. _Barbican: https://docs.openstack.org/barbican/latest/api/

Loading…
Cancel
Save