From 914ed9ffebe3c1f01e4c2a65ac87b09ce934b512 Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Tue, 29 Aug 2017 16:20:28 -0700 Subject: [PATCH] Clarify all_at_once parameter Fixes https://github.com/hashicorp/nomad/issues/3125 --- website/source/api/json-jobs.html.md | 8 +++++--- website/source/docs/job-specification/job.html.md | 8 ++++++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/website/source/api/json-jobs.html.md b/website/source/api/json-jobs.html.md index 3409baf5b..8851df1d5 100644 --- a/website/source/api/json-jobs.html.md +++ b/website/source/api/json-jobs.html.md @@ -130,9 +130,11 @@ their default values if any for each type of object. The `Job` object supports the following keys: -- `AllAtOnce` - Controls if the entire set of tasks in the job must - be placed atomically or if they can be scheduled incrementally. - This should only be used for special circumstances. Defaults to `false`. +- `AllAtOnce` - Controls whether the scheduler can make partial placements if + optimistic scheduling resulted in an oversubscribed node. This does not + control whether all allocations for the job, where all would be the desired + count for each task group, must be placed atomically. This should only be + used for special circumstances. Defaults to `false`. - `Constraints` - A list to define additional constraints where a job can be run. See the constraint reference for more details. diff --git a/website/source/docs/job-specification/job.html.md b/website/source/docs/job-specification/job.html.md index c340e8a7d..f1a4f23ee 100644 --- a/website/source/docs/job-specification/job.html.md +++ b/website/source/docs/job-specification/job.html.md @@ -26,8 +26,6 @@ of one or many tasks. ```hcl job "docs" { - all_at_once = true - constraint { # ... } @@ -70,6 +68,12 @@ job "docs" { must be placed atomically or if they can be scheduled incrementally. This should only be used for special circumstances. +- `all_at_once` `(bool: false)` - Controls whether the scheduler can make + partial placements if optimistic scheduling resulted in an oversubscribed + node. This does not control whether all allocations for the job, where all + would be the desired count for each task group, must be placed atomically. + This should only be used for special circumstances. + - `constraint` ([Constraint][constraint]: nil) - This can be provided multiple times to define additional constraints. See the [Nomad constraint reference](/docs/job-specification/constraint.html) for more