docs for group metadata

bundlewrap · Apr 16, 2014 · aeda69c · aeda69c
1 parent 68ac132
commit aeda69c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/doc/groups.py.rst b/doc/groups.py.rst
@@ -69,6 +69,13 @@ A tuple or list of node names that belong to this group.
 
 |
 
+``metadata``
+------------
+
+A dictionary of arbitrary data that will be accessible from each node's ``node.metadata``. For each node, Blockwart will merge the metadata of all of the node's groups first, then merge in the metadata from the node itself. You should not put conflicting metadata (i.e. dicts that share keys) in groups because there is no control over which group's metadata will be merged in last. You can, of course, put some metadata in a group and then default override it at the node level.
+
+|
+
 ``subgroups``
 -------------
 

diff --git a/doc/nodes.py.rst b/doc/nodes.py.rst
@@ -97,7 +97,7 @@ A string used as a DNS name when connecting to this node. May also be an IP addr
 ``metadata``
 ------------
 
-This can be a dictionary of arbitrary data. You can access it from your templates as ``node.metadata``. Use this to attach custom data (such as a list of IP addresses that should be configured on the target node) to the node.
+This can be a dictionary of arbitrary data. You can access it from your templates as ``node.metadata``. Use this to attach custom data (such as a list of IP addresses that should be configured on the target node) to the node. Note that you can also define metadata at the :ref:`group level <item_group>`, but node metadata has higher priority.
 
 |