From 17b20de71f4ae84cb352c569f16630de9421f09f Mon Sep 17 00:00:00 2001 From: Brian Shumate Date: Wed, 3 May 2017 17:46:06 -0400 Subject: [PATCH 1/2] Docs: Update node-status page - Add details about Desired Status and Client Status for #264 --- .../docs/commands/node-status.html.md.erb | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/website/source/docs/commands/node-status.html.md.erb b/website/source/docs/commands/node-status.html.md.erb index b52e19317..5feec2e74 100644 --- a/website/source/docs/commands/node-status.html.md.erb +++ b/website/source/docs/commands/node-status.html.md.erb @@ -149,6 +149,25 @@ ed3665f5 8bf94335 example cache run running 24cfd201 8bf94335 example cache run running ``` +You will note that in the above examples, the **Allocations** output contains +columns labeled **Desired Status** and **Client status**. + +Desired Status represents the goal of the scheduler on the allocation with +the following valid statuses: + +- *run*: The allocation should run +- *stop*: The allocation should stop +- *evict*: The allocation was evicted and should stop + +Client Status represents the emergent state of the allocation and include +the following: + +- *pending*: The allocation is pending and will be running +- *running*: The allocation is currently running +- *complete*: The allocation was running and completed successfully +- *failed*: The allocation was running and completed with a non-zero exit code +- *lost*: The node that was running the allocation has failed or has been partitioned + Using `-stats` to see detailed to resource usage information on the node: ``` From 96fac816769f0c6327a025656dfc6a38cfe53f9b Mon Sep 17 00:00:00 2001 From: Brian Shumate Date: Wed, 3 May 2017 18:45:27 -0400 Subject: [PATCH 2/2] Remove evict --- website/source/docs/commands/node-status.html.md.erb | 1 - 1 file changed, 1 deletion(-) diff --git a/website/source/docs/commands/node-status.html.md.erb b/website/source/docs/commands/node-status.html.md.erb index 5feec2e74..8231fe8bd 100644 --- a/website/source/docs/commands/node-status.html.md.erb +++ b/website/source/docs/commands/node-status.html.md.erb @@ -157,7 +157,6 @@ the following valid statuses: - *run*: The allocation should run - *stop*: The allocation should stop -- *evict*: The allocation was evicted and should stop Client Status represents the emergent state of the allocation and include the following: