open-nomad/website/pages/docs/job-specification/resources.mdx

104 lines
2.2 KiB
Plaintext
Raw Normal View History

---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: resources Stanza - Job Specification
sidebar_title: resources
description: |-
The "resources" stanza describes the requirements a task needs to execute.
2017-03-04 19:54:49 +00:00
Resource requirements include memory, network, cpu, and more.
---
# `resources` Stanza
2020-02-06 23:45:31 +00:00
<Placement groups={['job', 'group', 'task', 'resources']} />
The `resources` stanza describes the requirements a task needs to execute.
Resource requirements include memory, network, CPU, and more.
```hcl
job "docs" {
group "example" {
task "server" {
resources {
cpu = 100
memory = 256
network {
mbits = 100
port "http" {}
port "ssh" {
static = 22
}
}
2019-01-23 00:42:38 +00:00
device "nvidia/gpu" {
count = 2
}
}
}
}
}
```
## `resources` Parameters
- `cpu` `(int: 100)` - Specifies the CPU required to run this task in MHz.
- `memory` `(int: 300)` - Specifies the memory required in MB
2019-01-23 00:42:38 +00:00
- `network` <code>([Network][]: &lt;optional&gt;)</code> - Specifies the network
requirements, including static and dynamic port allocations.
2019-01-23 00:42:38 +00:00
- `device` <code>([Device][]: &lt;optional&gt;)</code> - Specifies the device
requirements. This may be repeated to request multiple device types.
## `resources` Examples
The following examples only show the `resources` stanzas. Remember that the
2016-10-31 00:41:03 +00:00
`resources` stanza is only valid in the placements listed above.
### Memory
This example specifies the task requires 2 GB of RAM to operate. 2 GB is the
equivalent of 2000 MB:
```hcl
resources {
memory = 2000
}
```
### Network
This example shows network constraints as specified in the [network][] stanza
which require 1 Gbit of bandwidth, dynamically allocates two ports, and
statically allocates one port:
```hcl
resources {
network {
mbits = 1000
port "http" {}
port "https" {}
port "lb" {
static = "8889"
}
}
}
```
2019-01-23 00:42:38 +00:00
### Devices
This example shows a device constraints as specified in the [device][] stanza
which require two nvidia GPUs to be made available:
```hcl
resources {
device "nvidia/gpu" {
count = 2
}
}
```
2020-02-06 23:45:31 +00:00
[network]: /docs/job-specification/network 'Nomad network Job Specification'
[device]: /docs/job-specification/device 'Nomad device Job Specification'