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

docs: fix description of update.stagger

Browse source 
Also add a bunch of links.
This commit is contained in:
Michael Schurter 2018-08-16 11:28:40 -07:00
parent 4612cac021
commit 97563ffd61
1 changed files with 17 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
website/source/docs/job-specification/update.html.md
View file

@ -22,11 +22,11 @@ description: |-
</table> </table>
The `update` stanza specifies the group's update strategy. The update strategy The `update` stanza specifies the group's update strategy. The update strategy
is used to control things like rolling upgrades and canary deployments. If is used to control things like [rolling upgrades][rolling] and [canary
omitted, rolling updates and canaries are disabled. If specified at the job deployments][canary]. If omitted, rolling updates and canaries are disabled. If
level, the configuration will apply to all groups within the job. If multiple specified at the job level, the configuration will apply to all groups within
`update` stanzas are specified, they are merged with the group stanza taking the the job. If multiple `update` stanzas are specified, they are merged with the
highest precedence and then the job. group stanza taking the highest precedence and then the job.
```hcl ```hcl
job "docs" { job "docs" {
@ -43,10 +43,11 @@ job "docs" {
} }
``` ```
~> For `system` jobs, only `max_parallel` and `stagger` are enforced. The job is ~> For `system` jobs, only [`max_parallel`](#max_parallel) and
updated at a rate of `max_parallel`, waiting `stagger` duration before the next [`stagger`](#stagger) are enforced. The job is updated at a rate of
set of updates. The `system` scheduler will be updated to support the new `max_parallel`, waiting `stagger` duration before the next set of updates.
`update` stanza in a future release. The `system` scheduler will be updated to support the new `update` stanza in
a future release.
## `update` Parameters ## `update` Parameters
@ -97,9 +98,10 @@ set of updates. The `system` scheduler will be updated to support the new
are healthy, they can be promoted which unblocks a rolling update of the are healthy, they can be promoted which unblocks a rolling update of the
remaining allocations at a rate of `max_parallel`. remaining allocations at a rate of `max_parallel`.
- `stagger` `(string: "30s")` - Specifies the delay between migrating - `stagger` `(string: "30s")` - Specifies the delay between each set of
allocations off nodes marked for draining. This is specified using a label [`max_parallel`](#max_parallel) updates when updating system jobs. This
suffix like "30s" or "1h". setting no longer applies to service jobs which use
[deployments.][strategies]
## `update` Examples ## `update` Examples
@ -258,4 +260,7 @@ group "two" {
} }
``` ```
[canary]: /guides/operating-a-job/update-strategies/blue-green-and-canary-deployments.html "Nomad Canary Deployments"
[checks]: /docs/job-specification/service.html#check-parameters "Nomad check Job Specification" [checks]: /docs/job-specification/service.html#check-parameters "Nomad check Job Specification"
[rolling]: /guides/operating-a-job/update-strategies/rolling-upgrades.html "Nomad Rolling Upgrades"
[strategies]: /guides/operating-a-job/update-strategies/index.html "Nomad Update Strategies"