Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
小 白蛋
Nomad
Commits
e12dd2f4
Unverified
Commit
e12dd2f4
authored
6 years ago
by
Preetha Appan
Browse files
Options
Download
Email Patches
Plain Diff
Address review comments
parent
7ef16693
Branches unavailable
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.4.0-rc.1
v1.4.0-beta.1
v1.3.8
v1.3.7
v1.3.6
v1.3.5
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.3.0-rc.1
v1.3.0-beta.1
v1.2.15
v1.2.14
v1.2.13
v1.2.12
v1.2.11
v1.2.10
v1.2.9
v1.2.8
v1.2.7
v1.2.6
v1.2.5
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.2.0-rc1
v1.2.0-beta1
v1.1.18
v1.1.17
v1.1.16
v1.1.15
v1.1.14
v1.1.13
v1.1.12
v1.1.11
v1.1.10
v1.1.9
v1.1.8
v1.1.7
v1.1.6
v1.1.5
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1.0
v1.1.0-rc1
v1.1.0-beta1
v1.0.18
v1.0.17
v1.0.16
v1.0.15
v1.0.14
v1.0.13
v1.0.12
v1.0.11
v1.0.10
v1.0.9
v1.0.8
v1.0.7
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v1.0.0-rc1
v1.0.0-beta3
v1.0.0-beta2
v0.12.12
v0.12.11
v0.12.10
v0.12.9
v0.12.8
v0.12.7
v0.12.6
v0.12.5
v0.12.4
v0.12.4-rc1
v0.12.3
v0.12.2
v0.12.1
v0.12.0
v0.12.0-rc1
v0.12.0-beta2
v0.12.0-beta1
v0.11.8
v0.11.7
v0.11.6
v0.11.5
v0.11.4
v0.11.3
v0.11.2
v0.11.1
v0.11.0
v0.11.0-rc1
v0.11.0-beta2
v0.11.0-beta1
v0.10.9
v0.10.8
v0.10.7
v0.10.6
v0.10.5
v0.10.4
v0.10.4-rc1
v0.10.3
v0.10.2
v0.10.2-rc1
v0.10.1
v0.10.0
v0.10.0-rc1
v0.10.0-connect1
v0.10.0-beta1
v0.9.7
v0.9.6
v0.9.5
v0.9.4
v0.9.4-rc1
v0.9.3
v0.9.2
v0.9.2-rc1
v0.9.1
v0.9.1-rc1
v0.9.0
v0.9.0-rc2
v0.9.0-rc1
v0.9.0-beta3
v0.9.0-beta2
v0.9.0-beta1
nightly
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
website/source/docs/job-specification/spread.html.md
+45
-17
website/source/docs/job-specification/spread.html.md
with
45 additions
and
17 deletions
+45
-17
website/source/docs/job-specification/spread.html.md
+
45
-
17
View file @
e12dd2f4
...
...
@@ -3,7 +3,7 @@ layout: "docs"
page_title
:
"
spread
Stanza
-
Job
Specification"
sidebar_current
:
"
docs-job-specification-spread"
description
:
|-
The "spread" stanza
allows operators to configure desired target percentages for allocations according to node attributes or metadata
.
The "spread" stanza
is used to spread placements across a certain node attributes such as datacenter
.
Spread may be specified at the job, group, or task levels for ultimate flexibility.
More than one spread stanza may be specified with relative weights between each.
---
...
...
@@ -23,19 +23,24 @@ description: |-
</tr>
</table>
The
`
spread
`
stanza allows operators to
specify target percentages of allocations according to
s
pe
cific node attributes or metadata. Spread may
be expressed on
[
attributes
][
interpolation
]
or
[
client metadata
][
client-meta
]
.
Additionally spread may be specified at the
[
job
][
job
]
,
[
group
][
group
]
, or
[
task
][
task
]
levels for ultimate flexibility
.
The spread stanza allows operators to
influence the placement of allocations in a task group.
O
pe
rators can use spread to increase failure tolerance of their application.
The operator can specify a node attribute such as datacenter, availability zone, or even rack
in a physical datacenter to spread the allocations over. By default, when using spread the scheduler will attempt to place allocations equally
among the available values of the given target
.
Nomad will use any defined spread criteria when computing node scores for placement.
Nodes are scored acccording to how closely they match the desired target percentage defined in the
Nodes are scored according to how closely they match the desired target percentage defined in the
spread stanza. Spread scores are combined with other scoring factors such as bin packing.
A job or task group can have more than one spread criteria, with weights to express relative preference.
Spread criteria are treated as a soft preference by the Nomad scheduler. If no nodes match a given spread criteria, placement is still successful.
Spread criteria are treated as a soft preference by the Nomad scheduler.
If no nodes match a given spread criteria, placement is still successful.
Spread may be expressed on
[
attributes
][
interpolation
]
or
[
client metadata
][
client-meta
]
.
Additionally, spread may be specified at the
[
job
][
job
]
,
[
group
][
group
]
, or
[
task
][
task
]
levels for ultimate flexibility.
## `spread` Parameters
...
...
@@ -48,7 +53,7 @@ Spread criteria are treated as a soft preference by the Nomad scheduler. If no n
Nomad will spread allocations evenly across all values of the attribute.
-
`weight`
`(integer:0)`
- Specifies a weight for the spread stanza. The weight is used
during scoring and must be an integer between
-10
0 to 100. Weights can be used
during scoring and must be an integer between 0 to 100. Weights can be used
when there is more than one spread or affinity stanza to express relative preference across them.
## `target` Parameters
...
...
@@ -63,8 +68,9 @@ The following examples show different ways to use the `spread` stanza.
### Even Spread Across Data Center
This example shows a spread stanza across the node's
`datacenter`
attribute. Allocations
are placed evenly across all datacenters with this example.
This example shows a spread stanza across the node's
`datacenter`
attribute. If we have
two datacenters
`us-east1`
and
`us-west1`
, and a task group of
`count = 10`
,
Nomad will attempt to place 5 allocations in each datacenter.
```
hcl
spread
{
...
...
@@ -75,16 +81,36 @@ spread {
### Spread With Target Percentages
This example shows a spread stanza that specifies one target percentage. If we
have three datacenters
`us-east1`
,
`us-east2`
and
`us-west1`
, and a task group
of
`count = 10`
Nomad will attempt to place place 5 of the allocations in "us-east1",
and then spread the rest among the other two datacenters.
```
hcl
spread
{
attribute
=
"${node.datacenter}"
weight
=
100
target
"us-east1"
{
percent
=
50
}
}
```
This example shows a spread stanza that specifies target percentages for two
different datacenters.
different datacenters. If we have two datacenters
`us-east1`
and
`us-west1`
,
and a task group of
`count = 10`
, Nomad will attempt to place 6 allocations
in
`us-east1`
and 4 in
`us-west1`
.
```
hcl
spread
{
attribute
=
"${node.datacenter}"
weight
=
100
target
"us-east1"
{
percent
=
60
}
target
"us-west1"
{
percent
=
40
}
...
...
@@ -93,7 +119,11 @@ spread {
### Spread Across Multiple Attributes
This example shows spread stanzas with multiple attributes
This example shows spread stanzas with multiple attributes. Consider a Nomad cluster
where there are two datacenters
`us-east1`
and
`us-west1`
, and each datacenter has nodes
with
`${meta.rack}`
being
`r1`
or
`r2`
. For the following spread stanza used on a job with
`count=12`
, Nomad
will attempt to place 6 allocations in each datacenter. Within a datacenter, Nomad will
attempt to place 3 allocations in nodes on rack
`r1`
, and 3 allocations in nodes on rack
`r2`
.
```
hcl
spread
{
...
...
@@ -112,6 +142,4 @@ spread {
[
task
]:
/docs/job-specification/task.html
"Nomad task Job Specification"
[
interpolation
]:
/docs/runtime/interpolation.html
"Nomad interpolation"
[
node-variables
]:
/docs/runtime/interpolation.html#node-variables-
"Nomad interpolation-Node variables"
[
constraint
]:
/docs/job-specification/constraint.html
"Nomad Constraint job Specification"
[
constraint
]:
/docs/job-specification/constraint.html
"Nomad Constraint job Specification"
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
Menu
Projects
Groups
Snippets
Help