summaryrefslogtreecommitdiff
path: root/hot/software-config/elements/heat-config-apply-config/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'hot/software-config/elements/heat-config-apply-config/README.rst')
-rw-r--r--hot/software-config/elements/heat-config-apply-config/README.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/hot/software-config/elements/heat-config-apply-config/README.rst b/hot/software-config/elements/heat-config-apply-config/README.rst
new file mode 100644
index 0000000..444d36a
--- /dev/null
+++ b/hot/software-config/elements/heat-config-apply-config/README.rst
@@ -0,0 +1,14 @@
+A hook which invokes os-apply-config.
+
+The intent is for this element (hook script) to be used in place of the one in
+tripleo-image-elements which relies on an external signal handling
+shell script at the end of the os-refresh-config run (99-refresh-completed).
+This version will run os-apply-config and return a signal immediately. Because
+it uses the heat-hook mechanisms it also supports a broader set of signal
+handling capabilities... which 99-refresh-completed doesn't fully support.
+
+It is worth noting that this hook runs os-apply-config against all the
+accumulated metadata, not just data supplied to an individual hook.
+
+To use this hook set group: to 'apply-config' instead of 'os-apply-config'
+in your Heat software configuration resources.