cloud-init-dev team mailing list archive

[Dan Watkins <daniel.watkins@xxxxxxxxxxxxx>]

Dan Watkins has proposed merging lp:~daniel-thewatkins/cloud-init/merging-doc-clarification into lp:cloud-init.

Requested reviews:
  Patricia Gaughen (gaughen)
  cloud init development team (cloud-init-dev)

For more details, see:
https://code.launchpad.net/~daniel-thewatkins/cloud-init/merging-doc-clarification/+merge/295822
-- 
Your team cloud init development team is requested to review the proposed merge of lp:~daniel-thewatkins/cloud-init/merging-doc-clarification into lp:cloud-init.

=== modified file 'doc/merging.rst'
--- doc/merging.rst	2013-04-02 18:51:54 +0000
+++ doc/merging.rst	2016-05-26 11:24:31 +0000
@@ -1,15 +1,16 @@
 Overview
 --------
 
-This was done because it has been a common feature request that there be a
-way to specify how cloud-config yaml "dictionaries" are merged together when
-there are multiple yamls to merge together (say when performing an #include).
+This was implemented because it has been a common feature request that there be
+a way to specify how cloud-config yaml "dictionaries" provided as user-data are
+merged together when there are multiple yamls to merge together (say when
+performing an #include).
 
 Since previously the merging algorithm was very simple and would only overwrite
 and not append lists, or strings, and so on it was decided to create a new and
 improved way to merge dictionaries (and there contained objects) together in a
-way that is customizable, thus allowing for users who provide cloud-config data
-to determine exactly how there objects will be merged.
+way that is customizable, thus allowing for users who provide cloud-config
+user-data to determine exactly how there objects will be merged.
 
 For example.
 
@@ -19,13 +20,13 @@
    run_cmd:
      - bash1
      - bash2
-   
+
    #cloud-config (2)
    run_cmd:
      - bash3
      - bash4
 
-The previous way of merging the following 2 objects would result in a final 
+The previous way of merging the following 2 objects would result in a final
 cloud-config object that contains the following.
 
 .. code-block:: yaml
@@ -56,7 +57,7 @@
 Since the above merging algorithm may not always be the desired merging
 algorithm (like how the previous merging algorithm was not always the preferred
 one) the concept of customizing how merging can be done was introduced through
-a new concept call 'merge classes'. 
+a new concept call 'merge classes'.
 
 A merge class is a class defintion which provides functions that can be used
 to merge a given type with another given type.
@@ -69,7 +70,7 @@
        def __init__(self, merger, opts):
            self._merger = merger
            self._overwrite = 'overwrite' in opts
-   
+
        # This merging algorithm will attempt to merge with
        # another dictionary, on encountering any other type of object
        # it will not merge with said object, but will instead return
@@ -129,12 +130,12 @@
    definition are the following (in order), 'merge_how', 'merge_type'.
 
 String format
-********
+*************
 
 The string format that is expected is the following.
 
 ::
-    
+
    classname1(option1,option2)+classname2(option3,option4)....
 
 The class name there will be connected to class names used when looking for the
@@ -144,11 +145,11 @@
 For example, the default string that is used when none is provided is the following:
 
 ::
-    
+
    list()+dict()+str()
 
 Dictionary format
-********
+*****************
 
 In cases where a dictionary can be used to specify the same information as the
 string format (ie option #2 of above) it can be used, for example.
@@ -171,7 +172,7 @@
 The answer is that when merging, a stack of 'merging classes' is kept, the
 first one on that stack is the default merging classes, this set of mergers
 will be used when the first cloud-config is merged with the initial empty
-cloud-config dictionary. If the cloud-config that was just merged provided a 
+cloud-config dictionary. If the cloud-config that was just merged provided a
 set of merging classes (via the above formats) then those merging classes will
 be pushed onto the stack. Now if there is a second cloud-config to be merged then
 the merging classes from the cloud-config before the first will be used (not the
@@ -181,8 +182,13 @@
 Other uses
 ----------
 
-The default merging algorithm for merging 'conf.d' yaml files (which form a initial
-yaml config for cloud-init) was also changed to use this mechanism so its full
+In addition to being used for merging user-data sections, the default merging
+algorithm for merging 'conf.d' yaml files (which form an initial yaml config
+for cloud-init) was also changed to use this mechanism so its full
 benefits (and customization) can also be used there as well. Other places that
-used the previous merging are also similar now extensible (metadata merging for
-example).
+used the previous merging are also, similarly, now extensible (metadata
+merging, for example).
+
+Note, however, that merge algorithms are not used *across* types of
+configuration.  As was previously the case, merged user-data will still
+overwrite conf.d configuration.

=== modified file 'doc/rtd/topics/merging.rst'
--- doc/rtd/topics/merging.rst	2013-03-08 23:57:05 +0000
+++ doc/rtd/topics/merging.rst	2016-05-26 11:24:31 +0000
@@ -1,5 +1,5 @@
-=========
-Merging
-=========
+==========================
+Merging User-Data Sections
+==========================
 
 .. include:: ../../merging.rst