luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

Merge pull request #1539 from hashicorp/docs-summaries

Browse source 
Added docs for job summaries
This commit is contained in:
Diptanu Choudhury 2016-08-10 15:08:32 -07:00 committed by GitHub
parent 56c78f84a4 f7aea58764
commit 9f0926b5aa
4 changed files with 87 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
website/source/docs/commands/status.html.md.erb
View file

@ -75,6 +75,10 @@ Datacenters = dc1
Status = running Status = running
Periodic = false Periodic = false
Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 1 0 0 0
Allocations Allocations
ID Eval ID Node ID Task Group Desired Status ID Eval ID Node ID Task Group Desired Status
24cfd201 81efc2fa 8d0331e9 cache run running 24cfd201 81efc2fa 8d0331e9 cache run running
@ -92,6 +96,10 @@ Datacenters = dc1
Status = running Status = running
Periodic = false Periodic = false
Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 5 0 0 0
Placement Failure Placement Failure
Task Group "cache": Task Group "cache":
* Resources exhausted on 1 nodes * Resources exhausted on 1 nodes
@ -120,6 +128,10 @@ Datacenters = dc1
Status = running Status = running
Periodic = false Periodic = false
Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 5 0 0 0
Evaluations Evaluations
ID Priority Triggered By Status Placement Failures ID Priority Triggered By Status Placement Failures
69f34a37 50 job-register blocked N/A - In Progress 69f34a37 50 job-register blocked N/A - In Progress

47
website/source/docs/http/job.html.md
View file

@ -240,6 +240,53 @@ region is used; another region can be specified using the `?region=` query param
</dd> </dd>
</dl> </dl>
<dl>
<dt>Description</dt>
<dd>
Query the summary of a job.
</dd>
<dt>Method</dt>
<dd>GET</dd>
<dt>URL</dt>
<dd>`/v1/job/<ID>/summary`</dd>
<dt>Parameters</dt>
<dd>
None
</dd>
<dt>Blocking Queries</dt>
<dd>
[Supported](/docs/http/index.html#blocking-queries)
</dd>
<dt>Returns</dt>
<dd>
```javascript
{
"JobID": "example",
"Summary": {
"cache": {
"Queued": 0,
"Complete": 0,
"Failed": 0,
"Running": 1,
"Starting": 0,
"Lost": 0
}
},
"CreateIndex": 6,
"ModifyIndex": 10
}
```
</dd>
</dl>
## PUT / POST ## PUT / POST
<dl> <dl>

24
website/source/docs/http/system.html.md
View file

@ -36,3 +36,27 @@ region can be specified using the `?region=` query parameter.
None None
</dd> </dd>
</dl> </dl>
<dl>
<dt>Description</dt>
<dd>
Reconcile the summaries of all the registered jobs based.
</dd>
<dt>Method</dt>
<dd>PUT</dd>
<dt>URL</dt>
<dd>`/v1/system/reconcile/summaries`</dd>
<dt>Parameters</dt>
<dd>
None
</dd>
<dt>Returns</dt>
<dd>
None
</dd>
</dl>

4
website/source/intro/getting-started/jobs.html.md
View file

@ -70,6 +70,10 @@ Datacenters = dc1
Status = running Status = running
Periodic = false Periodic = false
Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 1 0 0 0
Allocations Allocations
ID Eval ID Node ID Task Group Desired Status ID Eval ID Node ID Task Group Desired Status
dadcdb81 61b0b423 72687b1a cache run running dadcdb81 61b0b423 72687b1a cache run running