summaryrefslogtreecommitdiffstats
path: root/docs/clustering.md
diff options
context:
space:
mode:
authorMatthew Jones <matburt@redhat.com>2018-02-05 21:44:08 +0100
committerMatthew Jones <matburt@redhat.com>2018-02-05 21:44:26 +0100
commitc61efc0af8c38a9adcc773c1eed74ad1f3251977 (patch)
tree69b459118635861f296aef20e8e4b70f00f54c48 /docs/clustering.md
parentMerge pull request #1097 from rbywater/feature/preferipv4 (diff)
downloadawx-c61efc0af8c38a9adcc773c1eed74ad1f3251977.tar.xz
awx-c61efc0af8c38a9adcc773c1eed74ad1f3251977.zip
Add information on enabled flag
Diffstat (limited to '')
-rw-r--r--docs/clustering.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/clustering.md b/docs/clustering.md
index 9ab61bba56..fa53ee52c6 100644
--- a/docs/clustering.md
+++ b/docs/clustering.md
@@ -353,6 +353,13 @@ used to specify a preferred instance group on the job template or inventory,
but still allow the job to be submitted to any instance if those are out of
capacity.
+#### Instance Enable / Disable
+
+In order to support temporarily taking an `Instance` offline there is a boolean property `enabled` defined on each instance.
+
+When this property is disabled no jobs will be assigned to that `Instance`. Existing jobs will finish but no new work will be
+assigned.
+
## Acceptance Criteria
When verifying acceptance we should ensure the following statements are true