From 82ceafa7bc89726503c58b9ba72faf8ff600a8fe Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Tue, 6 Nov 2018 09:34:46 -0500 Subject: [PATCH] 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 --- doc/source/users/rendering.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/source/users/rendering.rst b/doc/source/users/rendering.rst index cd92db2f..a1746fc6 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: Substitution provides an "open" data sharing model in which any source 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` --------------- Layering provides a "restricted" data inheritance model intended to help 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` ------------------ Replacement builds on top of layering to provide yet another mechanism 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/