X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=sample-env-generator%2FREADME.rst;h=32e94f9864911e4f8dcd823bd68cb4536b231f1a;hb=b4fc0c9c52858cc331f120558df29e61ea2b1251;hp=71e9810a025d2c1c6c503b941ef229d81e78d66c;hpb=cb0ae4a630f69bc8d2899f02f1e5ee98daa48ffc;p=apex-tripleo-heat-templates.git

diff --git a/sample-env-generator/README.rst b/sample-env-generator/README.rst
index 71e9810a..32e94f98 100644
--- a/sample-env-generator/README.rst
+++ b/sample-env-generator/README.rst
@@ -19,10 +19,15 @@ target to do this::
           ``tripleo-heat-templates`` project.
 
 If a new sample environment is needed, it should be added to the
-``sample-env-generator/sample-environments.yaml`` file.  The existing
-entries in the file can be used as examples, and a more detailed
+appropriate file in the ``sample-env-generator/`` directory.  The existing
+entries in the files can be used as examples, and a more detailed
 explanation of the different available keys is below:
 
+Top-level:
+- **environments**: This is the top-level key in the file.  All other keys
+  below should appear in a list of dictionaries that define environments.
+
+Environment-specific:
 - **name**: the output file will be this name + .yaml, in the
   ``environments`` directory.
 - **title**: a human-readable title for the environment.
@@ -52,6 +57,12 @@ explanation of the different available keys is below:
 - **resource_registry**: Many environments also need to pass
   resource_registry entries when they are used.  This can be used
   to specify that in the configuration file.
+- **children**: For environments that share a lot of common values but may
+  need minor variations for different use cases, sample environment entries
+  can be nested.  ``children`` takes a list of environments with the same
+  structure as the top-level ``environments`` key.  The main difference is
+  that all keys are optional, and any that are omitted will be inherited from
+  the parent environment definition.
 
 Some behavioral notes: