Fix docs and method documentation in API

This commit is contained in:
Preetha Appan
2018-05-21 17:20:59 -05:00
parent ae5d8fd593
commit 2ea09b82a0
2 changed files with 19 additions and 3 deletions

View File

@@ -233,7 +233,8 @@ func (j *Jobs) ForceEvaluate(jobID string, q *WriteOptions) (string, *WriteMeta,
return resp.EvalID, wm, nil
}
// ForceEvaluate is used to force-evaluate an existing job.
// EvaluateWithOpts is used to force-evaluate an existing job and takes additional options
// for whether to force reschedule failed allocations
func (j *Jobs) EvaluateWithOpts(jobID string, opts EvalOptions, q *WriteOptions) (string, *WriteMeta, error) {
req := &JobEvaluateRequest{
JobID: jobID,

View File

@@ -43,12 +43,27 @@ Evaluate the job with ID "job1":
```
$ nomad job eval job1
Created eval ID: "6754c2e3-9abb-e7e9-dc92-76aab01751c8"
==> Monitoring evaluation "0f3bc0f3"
Evaluation triggered by job "test"
Evaluation within deployment: "51baf5c8"
Evaluation status changed: "pending" -> "complete"
==> Evaluation "0f3bc0f3" finished with status "complete"
```
Evaluate the job with ID "job1" and return immediately:
```
$ nomad job eval -detach job1
Created eval ID: "4947e728"
```
Evaluate the job with ID "job1", and reschedule any eligible failed allocations:
```
$ nomad job eval -force-reschedule job1
Created eval ID: "6754c2e3-9abb-e7e9-dc92-76aab01751c8"
==> Monitoring evaluation "0f3bc0f3"
Evaluation triggered by job "test"
Evaluation within deployment: "51baf5c8"
Evaluation status changed: "pending" -> "complete"
==> Evaluation "0f3bc0f3" finished with status "complete"
```