Skip to content

Commit aebdd5f

Browse files
authored
[PUBLISH] Nomad Docs: Publish nomad/1.11.1 release docs (#1488)
🚧 `hashicorp/web-unified-docs` publication PR **Triggered by**: @aimeeu with a Github action **Release branch**: `nomad/1.11.1` **Merge target**: `main`
2 parents 058ad92 + 9b8add1 commit aebdd5f

File tree

16 files changed

+146
-26
lines changed

16 files changed

+146
-26
lines changed

content/nomad/v1.10.x/content/docs/job-declare/task-driver/docker.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -608,8 +608,6 @@ The `auth` object supports the following keys:
608608

609609
- `password` - (Optional) The account password.
610610

611-
- `email` - (Optional) The account email.
612-
613611
- `server_address` - (Optional) The server domain/IP without the protocol.
614612
Docker Hub is used by default.
615613

content/nomad/v1.10.x/content/docs/other-specifications/volume/host.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@ user running the Nomad client agent, which is commonly `0` (root).
125125

126126
The user and group IDs must be present on any node that may receive the volume.
127127

128+
On Windows, the `uid` and `gid` values are ignored. In addition, only the 0o200
129+
bit (owner writable) mode is used; it controls whether the file's read-only
130+
attribute is set or cleared.
131+
128132
### mkdir example
129133

130134
<CodeBlockConfig filename="mkdir.volume.hcl">

content/nomad/v1.11.x/content/docs/configuration/client.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,13 @@ client {
9393
- `disk_total_mb` `(int:0)` - Specifies an override for the total disk space
9494
fingerprint attribute. This value is not used by the scheduler unless you have
9595
constraints set on the attribute `unique.storage.bytestotal`. The actual total
96-
disk space can be determined via the [Read Stats API](/nomad/api-docs/client#read-stats)
97-
98-
- `disk_free_mb` `(int:0)` - Specifies the disk space free for scheduling
99-
allocations. If set, this value overrides any detected free disk space. This
100-
value can be seen in `nomad node status` under Allocated Resources.
96+
disk space can be determined via the [Read Stats
97+
API](/nomad/api-docs/client#read-stats)
98+
99+
- `disk_free_mb` `(int:0)` - Previously specified the disk space free for
100+
scheduling allocations. If set, it would override any detected free disk
101+
space. This value has been deprecated and is now ignored by Nomad clients. Use
102+
[`client.reserved.disk`](#reserved-parameters) instead.
101103

102104
- `min_dynamic_port` `(int:20000)` - Specifies the minimum dynamic port to be
103105
assigned. Individual ports and ranges of ports may be excluded from dynamic

content/nomad/v1.11.x/content/docs/deploy/task-driver/qemu.mdx

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,37 @@ way to retrieve the image being run.
4343
The `qemu` driver will set the following client attributes:
4444

4545
- `driver.qemu` - Set to `1` if QEMU is found on the host node. Nomad determines
46-
this by executing `qemu-system-x86_64 -version` on the host and parsing the output
47-
- `driver.qemu.version` - Version of `qemu-system-x86_64`, ex: `2.4.0`
46+
this by executing the first found QEMU binary with `--version` on the client
47+
and parsing the output. Nomad does not get the version of each individual QEMU
48+
emulator.
49+
- `driver.qemu.version` - Version found running the command for `driver.qemu`;
50+
for example: `2.4.0`
51+
- `driver.qemu.emulators` - A comma separated list of emulators detected on the client.
4852

4953
Here is an example of using these properties in a job file:
5054

5155
```hcl
5256
job "docs" {
5357
# Only run this job where the qemu version is higher than 1.2.3.
5458
constraint {
55-
attribute = "${driver.qemu.version}"
59+
attribute = "${attr.driver.qemu.version}"
5660
operator = ">"
5761
value = "1.2.3"
5862
}
5963
}
6064
```
6165

66+
```hcl
67+
job "docs" {
68+
# Only run this job where the the qemu-system-aarch64 emulator was detected.
69+
constraint {
70+
attribute = "${attr.driver.qemu.emulators}"
71+
operator = "set_contains"
72+
value = "aarch64"
73+
}
74+
}
75+
```
76+
6277
## Plugin Options
6378

6479
```hcl
@@ -78,6 +93,10 @@ plugin "qemu" {
7893
including flags that provide the VM with access to host devices such
7994
as USB drives. Refer to the [QEMU documentation] for the available
8095
flags.
96+
- `emulators_allowlist` (`[]string`: `[]`) - Specifies the allowed emulators
97+
tasks may use. When specified, Nomad only fingerprints this list and does not
98+
allow tasks to run using other emulators. Defaults to fingerprinting and
99+
allowing all emulators.
81100

82101
## Resource Isolation
83102

content/nomad/v1.11.x/content/docs/job-declare/task-driver/docker.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -608,8 +608,6 @@ The `auth` object supports the following keys:
608608

609609
- `password` - (Optional) The account password.
610610

611-
- `email` - (Optional) The account email.
612-
613611
- `server_address` - (Optional) The server domain/IP without the protocol.
614612
Docker Hub is used by default.
615613

content/nomad/v1.11.x/content/docs/job-declare/task-driver/qemu.mdx

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ great performance. Currently the `qemu` driver can map a set of ports from the
1414
host machine to the guest virtual machine, and provides configuration for
1515
resource allocation.
1616

17-
The `qemu` driver can execute any regular `qemu` image (e.g. `qcow`, `img`,
18-
`iso`), and is currently invoked with `qemu-system-x86_64`.
17+
The `qemu` driver can execute any regular `qemu` image, such as `qcow`, `img`,
18+
and `iso`. Nomad uses the QEMU binary specified by the `emulator` parameter. For
19+
example, if you specify `x86_64d, Nomad uses `qemu-system-x86_64`.
1920

2021
The driver requires the image to be accessible from the Nomad client via the
2122
[`artifact` downloader](/nomad/docs/job-specification/artifact).
@@ -31,6 +32,8 @@ task "webservice" {
3132
3233
config {
3334
image_path = "/path/to/my/linux.img"
35+
emulator = "x86_64"
36+
machine_type = "q35"
3437
accelerator = "kvm"
3538
graceful_shutdown = true
3639
args = ["-nodefaults", "-nodefconfig"]
@@ -40,10 +43,15 @@ task "webservice" {
4043

4144
The `qemu` driver supports the following configuration in the job spec:
4245

43-
- `image_path` - The path to the downloaded image. In most cases this will just
44-
be the name of the image. However, if the supplied artifact is an archive that
45-
contains the image in a subfolder, the path will need to be the relative path
46-
(`subdir/from_archive/my.img`).
46+
- `image_path` - The path to the downloaded image. In most cases this is the
47+
name of the image. However, if the supplied artifact is an archive that
48+
contains the image in a subfolder, the path needs to be the relative path
49+
(`subdir/from_archive/my.img`). Nomad gives this image an ID of "image0".
50+
51+
- `emulator` `(string: "x86_64")` - The architecture of the QEMU emulator used to
52+
run the virtual machine.
53+
54+
- `machine_type` `(string: "pc")` - Used to select the emulated machine by name.
4755

4856
- `drive_interface` - (Optional) This option defines on which type of interface
4957
the drive is connected. Available types are: `ide`, `scsi`, `sd`, `mtd`,

content/nomad/v1.11.x/content/docs/job-specification/identity.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ description: |-
1212
['job', 'group', 'service', 'identity'],
1313
['job', 'group', 'task', 'identity'],
1414
['job', 'group', 'task', 'service', 'identity'],
15+
['job', 'group', 'service', 'connect', 'sidecar_task', 'identity'],
1516
]}
1617
/>
1718

content/nomad/v1.11.x/content/docs/job-specification/secret.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ Nomad extends the provider list via the use of custom providers plugins. Custom
8989
providers must implement both the `fingerprint` and `fetch` functionality. You
9090
must place custom providers in the `common_plugin_dir/secrets/` subdirectory. On
9191
startup, the Nomad client fingerprints executables in the secrets directory by
92-
executing it with the first argument of `fingerblock`. When using a custom
93-
plugin "foo", Nomad looks for an executable "foo" and runs it with the first
94-
argument being "fetch", and the second argument being the secret's path
92+
executing it with the first argument being `fingerprint`. When a task using a custom
93+
plugin "foo" to fetch a secret, Nomad looks for an executable "foo" and runs it with
94+
the first argument being "fetch", and the second argument being the secret's path
9595
parameter. Refer to the [plugin authoring][secret-provider] guide on secret providers
9696
for an example custom provider.
9797

content/nomad/v1.11.x/content/docs/job-specification/sidecar_task.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,11 @@ meta.connect.sidecar_image = custom/envoy-${NOMAD_envoy_version}:latest
156156
- `volume_mount` <code>([VolumeMount][]: nil)</code> - Specifies where a group
157157
volume should be mounted.
158158

159+
- `identity` <code>([Identity][]: nil)</code> - Expose an extra [Workload Identity][]
160+
to the task. Nomad automatically configures Consul Service Mesh sidecars with
161+
the required identities to communicate with Consul. Specifying this block lets
162+
you add extra identities that can be consumed by third-party services.
163+
159164
## Examples
160165

161166
The following example configures resources for the sidecar task and other configuration.
@@ -181,6 +186,8 @@ The following example configures resources for the sidecar task and other config
181186
[group]: /nomad/docs/job-specification/group 'Nomad group Job Specification'
182187
[interpolation]: /nomad/docs/reference/runtime-variable-interpolation 'Nomad interpolation'
183188
[job]: /nomad/docs/job-specification/job 'Nomad job Job Specification'
189+
[Identity]: /nomad/docs/job-specification/identity 'Nomad identity Job Specification'
190+
[Workload Identity]: /nomad/docs/concepts/workload-identity
184191
[logs]: /nomad/docs/job-specification/logs 'Nomad logs Job Specification'
185192
[resources]: /nomad/docs/job-specification/resources 'Nomad resources Job Specification'
186193
[sidecar_service]: /nomad/docs/job-specification/sidecar_service 'Nomad sidecar service Specification'

content/nomad/v1.11.x/content/docs/other-specifications/acl-policy.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ The `policy` field for namespace rules can have one of the following values:
117117
- `write`: allow the resource to be read and modified
118118
- `deny`: do not allow the resource to be read or modified. Deny takes
119119
precedence when multiple policies are associated with a token.
120+
- `scale`: allow the resource to be scaled by the nomad-autoscaler
120121

121122
In addition to the coarse-grained `policy`, you can provide a fine-grained list
122123
of `capabilities`. This includes:
@@ -171,7 +172,7 @@ The coarse-grained policy permissions are shorthand for these fine-grained names
171172
| `deny` | deny |
172173
| `read` | list-jobs<br />parse-job<br />read-job<br />csi-list-volume<br />csi-read-volume<br />host-volume-read<br />list-scaling-policies<br />read-scaling-policy<br />read-job-scaling |
173174
| `write` | list-jobs<br />parse-job<br />read-job<br />submit-job<br />dispatch-job<br />read-logs<br />read-fs<br />alloc-exec<br />alloc-lifecycle<br />csi-write-volume<br />csi-mount-volume<br />host-volume-write<br />list-scaling-policies<br />read-scaling-policy<br />read-job-scaling<br />scale-job<br />submit-recommendation |
174-
| `scale` | list-scaling-policies<br />read-scaling-policy<br />read-job-scaling<br />scale-job |
175+
| `scale` | list-scaling-policies<br />read-scaling-policy<br />read-job-scaling<br />scale-job<br />read-job<br />submit-recommendation |
175176

176177

177178

0 commit comments

Comments
 (0)