Add bmc_use_cache environment

doc/source/deploy/environment-index.rst

@@ -61,6 +61,16 @@ Base Configuration Options
 
 **Description:** Basic configuration options needed for all OVB environments
 
+Enable Instance Status Caching in BMC
+-------------------------------------
+
+**File:** environments/bmc-use-cache.yaml
+
+**Description:** Enable caching of instance status in the BMC.  This should reduce load on
+the host cloud, but at the cost of potential inconsistency if the state
+of a baremetal instance is changed without using the BMC.
+
+
 Boot Undercloud and Baremetal Instances from Volume
 ---------------------------------------------------
 

environments/bmc-use-cache.yaml

@@ -0,0 +1,18 @@
+# *******************************************************************
+# This file was created automatically by the sample environment
+# generator. Developers should use `tox -e genconfig` to update it.
+# Users are recommended to make changes to a copy of the file instead
+# of the original, if any customizations are needed.
+# *******************************************************************
+# title: Enable Instance Status Caching in BMC
+# description: |
+#   Enable caching of instance status in the BMC.  This should reduce load on
+#   the host cloud, but at the cost of potential inconsistency if the state
+#   of a baremetal instance is changed without using the BMC.
+parameter_defaults:
+  # Enable instance status caching on the BMC.  This can reduce load on the
+  # host cloud, but if an instance's status is changed outside the BMC it may
+  # become out of sync.
+  # Type: boolean
+  bmc_use_cache: True
+

sample-env-generator/environments.yaml

@@ -159,3 +159,16 @@ environments:
     resource_registry:
       OS::OVB::UndercloudEnvironment: ../templates/undercloud-volume.yaml
       OS::OVB::ServerPair: ../templates/virtual-baremetal-servers-volume.yaml
+  -
+    name: bmc-use-cache
+    title: Enable Instance Status Caching in BMC
+    description: |
+      Enable caching of instance status in the BMC.  This should reduce load on
+      the host cloud, but at the cost of potential inconsistency if the state
+      of a baremetal instance is changed without using the BMC.
+    files:
+      templates/virtual-baremetal.yaml:
+        parameters:
+          - bmc_use_cache
+    sample_values:
+      bmc_use_cache: True