Skip to content

Commit

Permalink
docs: clarify that a default update strategy is used when update stra…
Browse files Browse the repository at this point in the history
…tegy is omitted
  • Loading branch information
Mike Noordermeer authored May 10, 2021
1 parent 1b22964 commit 87af5de
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions website/content/docs/job-specification/group.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ job "docs" {
within this group. This can be specified multiple times, to add a task as part
of the group.

- `update` <code>([Update][update]: nil)</code> - Specifies the task's update
strategy. When omitted, a default update strategy is applied.

- `vault` <code>([Vault][]: nil)</code> - Specifies the set of Vault policies
required by all tasks in this group. Overrides a `vault` block set at the
`job` level.
Expand Down Expand Up @@ -268,5 +271,6 @@ group "second" {
[restart]: /docs/job-specification/restart 'Nomad restart Job Specification'
[service]: /docs/job-specification/service 'Nomad service Job Specification'
[service_discovery]: /docs/integrations/consul-integration#service-discovery 'Nomad Service Discovery'
[update]: /docs/job-specification/update 'Nomad update Job Specification'
[vault]: /docs/job-specification/vault 'Nomad vault Job Specification'
[volume]: /docs/job-specification/volume 'Nomad volume Job Specification'
2 changes: 1 addition & 1 deletion website/content/docs/job-specification/job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ job "docs" {
use. Nomad provides the `service`, `system` and `batch` schedulers.

- `update` <code>([Update][update]: nil)</code> - Specifies the task's update
strategy. When omitted, rolling updates are disabled.
strategy. When omitted, a default update strategy is applied.

- `vault` <code>([Vault][]: nil)</code> - Specifies the set of Vault policies
required by all tasks in this job.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/job-specification/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: update Stanza - Job Specification
description: |-
The "update" stanza specifies the group's update strategy. The update strategy
is used to control things like rolling upgrades and canary deployments. If
omitted, rolling updates and canaries are disabled.
omitted, a default update strategy is applied.
---

# `update` Stanza
Expand All @@ -18,7 +18,7 @@ description: |-

The `update` stanza specifies the group's update strategy. The update strategy
is used to control things like [rolling upgrades][rolling] and [canary
deployments][canary]. If omitted, rolling updates and canaries are disabled. If
deployments][canary]. If omitted, a default update strategy is applied. If
specified at the job level, the configuration will apply to all groups within
the job. If multiple `update` stanzas are specified, they are merged with the
group stanza taking the highest precedence and then the job.
Expand Down

0 comments on commit 87af5de

Please sign in to comment.