summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2019-02-22 23:20:28 +0000
committerGerrit Code Review <review@openstack.org>2019-02-22 23:20:28 +0000
commit49ad9f38842f7f1ecb86d907d86d332f8186eb8c (patch)
tree89e771b318ef50aa6ae9bbb8fdbec872c0bd17f4
parentc81a88b9636975d26520486e0ea26d960e98e893 (diff)
parent82ceafa7bc89726503c58b9ba72faf8ff600a8fe (diff)
Merge "docs: Add use cases for each of the mutation operations"
-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/