From 1bc63ab808c9b6dd280976e1ddf9e217d71d0eee Mon Sep 17 00:00:00 2001 From: Diptanu Choudhury Date: Sun, 7 Aug 2016 20:38:29 -0400 Subject: [PATCH 1/2] Added docs for job summaries --- .../source/docs/commands/status.html.md.erb | 12 +++++ website/source/docs/http/job.html.md | 47 +++++++++++++++++++ website/source/docs/http/system.html.md | 24 ++++++++++ 3 files changed, 83 insertions(+) diff --git a/website/source/docs/commands/status.html.md.erb b/website/source/docs/commands/status.html.md.erb index a075ff935..316ea308f 100644 --- a/website/source/docs/commands/status.html.md.erb +++ b/website/source/docs/commands/status.html.md.erb @@ -75,6 +75,10 @@ Datacenters = dc1 Status = running Periodic = false +Summary +Task Group Queued Starting Running Failed Complete Lost +cache 0 0 1 0 0 0 + Allocations ID Eval ID Node ID Task Group Desired Status 24cfd201 81efc2fa 8d0331e9 cache run running @@ -92,6 +96,10 @@ Datacenters = dc1 Status = running Periodic = false +Summary +Task Group Queued Starting Running Failed Complete Lost +cache 0 0 5 0 0 0 + Placement Failure Task Group "cache": * Resources exhausted on 1 nodes @@ -120,6 +128,10 @@ Datacenters = dc1 Status = running Periodic = false +Summary +Task Group Queued Starting Running Failed Complete Lost +cache 0 0 5 0 0 0 + Evaluations ID Priority Triggered By Status Placement Failures 69f34a37 50 job-register blocked N/A - In Progress diff --git a/website/source/docs/http/job.html.md b/website/source/docs/http/job.html.md index b3d024721..c8944ae0b 100644 --- a/website/source/docs/http/job.html.md +++ b/website/source/docs/http/job.html.md @@ -240,6 +240,53 @@ region is used; another region can be specified using the `?region=` query param +
+
Description
+
+ Query the summary of a job. +
+ +
Method
+
GET
+ +
URL
+
`/v1/job//summary`
+ +
Parameters
+
+ None +
+ +
Blocking Queries
+
+ [Supported](/docs/http/index.html#blocking-queries) +
+ +
Returns
+
+ + ```javascript + { + "JobID": "example", + "Summary": { + "cache": { + "Queued": 0, + "Complete": 0, + "Failed": 0, + "Running": 1, + "Starting": 0, + "Lost": 0 + } + }, + "CreateIndex": 6, + "ModifyIndex": 10 + } + ``` + +
+
+ + ## PUT / POST
diff --git a/website/source/docs/http/system.html.md b/website/source/docs/http/system.html.md index f32af29c0..bb372739c 100644 --- a/website/source/docs/http/system.html.md +++ b/website/source/docs/http/system.html.md @@ -36,3 +36,27 @@ region can be specified using the `?region=` query parameter. None
+ + +
+
Description
+
+ Reconcile the summaries of all the registered jobs based. +
+ +
Method
+
PUT
+ +
URL
+
`/v1/system/reconcile/summaries`
+ +
Parameters
+
+ None +
+ +
Returns
+
+ None +
+
From f7aea5876493a586afcc807b780c49994a46f4ac Mon Sep 17 00:00:00 2001 From: Diptanu Choudhury Date: Wed, 10 Aug 2016 15:08:03 -0700 Subject: [PATCH 2/2] Added the job summary on getting started --- website/source/intro/getting-started/jobs.html.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/source/intro/getting-started/jobs.html.md b/website/source/intro/getting-started/jobs.html.md index 3630ba196..86800b64b 100644 --- a/website/source/intro/getting-started/jobs.html.md +++ b/website/source/intro/getting-started/jobs.html.md @@ -70,6 +70,10 @@ Datacenters = dc1 Status = running Periodic = false +Summary +Task Group Queued Starting Running Failed Complete Lost +cache 0 0 1 0 0 0 + Allocations ID Eval ID Node ID Task Group Desired Status dadcdb81 61b0b423 72687b1a cache run running