mirror of
https://github.com/kemko/nomad.git
synced 2026-01-01 16:05:42 +03:00
Sweep of docs for repeated words; minor edits (#14032)
This commit is contained in:
@@ -29,7 +29,7 @@ The table below shows this endpoint's support for
|
||||
- `prefix` `(string: "")`- Specifies a string to filter evaluations based on an
|
||||
ID prefix. Because the value is decoded to bytes, the prefix must have an
|
||||
even number of hexadecimal characters (0-9a-f). This is specified as a query
|
||||
string parameter and and is used before any `filter` expression is applied.
|
||||
string parameter and is used before any `filter` expression is applied.
|
||||
|
||||
- `next_token` `(string: "")` - This endpoint supports paging. The
|
||||
`next_token` parameter accepts a string which is the `ID` field of
|
||||
|
||||
@@ -43,7 +43,7 @@ allocation's namespace.
|
||||
- `-verbose`: Display verbose output.
|
||||
|
||||
- `-no-shutdown-delay`
|
||||
Ignore the the group and task [`shutdown_delay`] configuration so that
|
||||
Ignore the group and task [`shutdown_delay`] configuration so that
|
||||
there is no delay between service deregistration and task
|
||||
shutdown. Note that using this flag will result in failed network
|
||||
connections to the allocation being stopped.
|
||||
|
||||
@@ -7,7 +7,7 @@ description: |
|
||||
|
||||
# Command: deployment resume
|
||||
|
||||
The `deployment resume` command is used used to unpause a paused deployment.
|
||||
The `deployment resume` command is used to unpause a paused deployment.
|
||||
Resuming a deployment will resume the placement of new allocations as part of
|
||||
rolling deployment.
|
||||
|
||||
|
||||
@@ -100,7 +100,7 @@ that volume.
|
||||
|
||||
- `-consul-namespace`: <EnterpriseAlert inline/> If set, any services in the job will be registered into the
|
||||
specified Consul namespace. Any `template` stanza reading from Consul KV will
|
||||
scoped to the the specified Consul namespace. If Consul ACLs are enabled and the
|
||||
scoped to the specified Consul namespace. If Consul ACLs are enabled and the
|
||||
[`consul` stanza `allow_unauthenticated`] is disabled in the Nomad server configuration, then
|
||||
a Consul token must be supplied with appropriate service and kv Consul ACL policy
|
||||
permissions.
|
||||
|
||||
@@ -10,7 +10,7 @@ description: |
|
||||
**Alias: `nomad stop`**
|
||||
|
||||
The `job stop` command is used to stop a running job and signals the scheduler
|
||||
to cancel all of the running allocations.
|
||||
to cancel all the running allocations.
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -56,7 +56,7 @@ When ACLs are enabled, this command requires a token with the `submit-job`,
|
||||
stop only a single region at a time. Ignored for single-region jobs.
|
||||
|
||||
- `-no-shutdown-delay`
|
||||
Ignore the the group and task [`shutdown_delay`] configuration so that
|
||||
Ignore the group and task [`shutdown_delay`] configuration so that
|
||||
there is no delay between service deregistration and task
|
||||
shutdown. Note that using this flag will result in failed network
|
||||
connections to the allocations being stopped.
|
||||
|
||||
@@ -7,7 +7,7 @@ description: |
|
||||
|
||||
# Command: volume snapshot list
|
||||
|
||||
The `volume snapshot list` command lists volume snapshots known to to a
|
||||
The `volume snapshot list` command lists volume snapshots known to a
|
||||
[Container Storage Interface (CSI)][csi] storage provider. Only CSI plugins
|
||||
that implement the [Controller][csi_plugins_internals] interface support this
|
||||
command.
|
||||
|
||||
@@ -74,10 +74,10 @@ Nomad exposes a Unix domain socket named `csi.sock` inside each CSI
|
||||
plugin task, and communicates over the gRPC protocol expected by the
|
||||
CSI specification. The `mount_dir` field tells Nomad where the plugin
|
||||
expects to find the socket file. The path to this socket is exposed in
|
||||
the container as the `CSI_ENDPOINT` environment variable.
|
||||
the container as the `CSI_ENDPOINT` environment variable.
|
||||
|
||||
Some plugins also require the `stage_publish_base_dir` field, which
|
||||
tells Nomad where to instruct the plugin to mount volumes for staging
|
||||
tells Nomad where to instruct the plugin to mount volumes for staging
|
||||
and/or publishing.
|
||||
|
||||
### Plugin Lifecycle and State
|
||||
@@ -128,7 +128,7 @@ terminal. The client frees the volume locally by making "unpublish"
|
||||
RPCs to the node plugin. The node plugin unmounts the bind-mount from
|
||||
the allocation and unmounts the volume from the plugin (if it's not in
|
||||
use by another task). The client will then send an "unpublish" RPC to
|
||||
the server, which will forward it to the the controller plugin (if
|
||||
the server, which will forward it to the controller plugin (if
|
||||
any), and decrement the claim count for the volume. At this point the
|
||||
volume’s claim capacity has been freed up for scheduling.
|
||||
|
||||
|
||||
@@ -88,7 +88,7 @@ strings for various RFC-specified formats are given below to be copied into your
|
||||
configuration as needed:
|
||||
|
||||
- [RFC 822](https://tools.ietf.org/html/rfc822#section-5) and
|
||||
[RFC RFC 2822](https://tools.ietf.org/html/rfc2822#section-3.3):
|
||||
[RFC 2822](https://tools.ietf.org/html/rfc2822#section-3.3):
|
||||
`"DD MMM YYYY hh:mm ZZZ"`
|
||||
- [RFC 850](https://tools.ietf.org/html/rfc850#section-2.1.4):
|
||||
`"EEEE, DD-MMM-YY hh:mm:ss ZZZ"`
|
||||
|
||||
@@ -13,9 +13,9 @@ description: |-
|
||||
<EnterpriseAlert />
|
||||
|
||||
The `multiregion` stanza specifies that a job will be deployed to multiple
|
||||
[federated regions]. If omitted, the job will be deployed to a single region
|
||||
— the one specified by the `region` field or the `-region` command line
|
||||
flag to `nomad job run`.
|
||||
[federated regions]. If omitted, the job will be deployed to a single region—the
|
||||
one specified by the `region` field or the `-region` command line flag to
|
||||
`nomad job run`.
|
||||
|
||||
Federated Nomad clusters are members of the same gossip cluster but not the
|
||||
same raft cluster; they don't share their data stores. Each region in a
|
||||
@@ -113,7 +113,7 @@ multiregion deployments are considered GA.
|
||||
that led to the failure and resubmit the job.
|
||||
|
||||
~> For `system` jobs, only [`max_parallel`](#max_parallel) is enforced. The
|
||||
`system` scheduler will be updated to support `on_failure` when the the
|
||||
`system` scheduler will be updated to support `on_failure` when the
|
||||
[`update` stanza] is fully supported for system jobs in a future release.
|
||||
|
||||
### `region` Parameters
|
||||
|
||||
@@ -13,7 +13,7 @@ description: The "restart" stanza configures a group's behavior on task failure.
|
||||
]}
|
||||
/>
|
||||
|
||||
The `restart` stanza configures a tasks's behavior on task failure. Restarts
|
||||
The `restart` stanza configures a task's behavior on task failure. Restarts
|
||||
happen on the client that is running the task.
|
||||
|
||||
```hcl
|
||||
@@ -151,7 +151,7 @@ restart {
|
||||
}
|
||||
```
|
||||
|
||||
With the following `restart` block, a task that that fails after 1
|
||||
With the following `restart` block, a task that fails after 1
|
||||
minute, after 2 minutes, and after 3 minutes will be restarted each
|
||||
time. If it fails again before 10 minutes, the entire allocation will
|
||||
be marked as failed and the scheduler will follow the group's
|
||||
|
||||
@@ -105,7 +105,7 @@ spread {
|
||||
|
||||
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",
|
||||
of `count = 10`, Nomad will attempt to place 5 of the allocations in "us-east1",
|
||||
and will spread the remaining among the other two datacenters.
|
||||
|
||||
```hcl
|
||||
|
||||
@@ -21,7 +21,7 @@ recovery.
|
||||
Only one key in the keyring is "active" at any given time, and all encryption
|
||||
and signing operations happen on the leader. Nomad automatically rotates the
|
||||
active encryption key every 30 days. When a key is rotated, the existing keys
|
||||
are marked as "inactive" but not deleted, so they can be be used for decrypting
|
||||
are marked as "inactive" but not deleted, so they can be used for decrypting
|
||||
previously encrypted variables and verifying workload identities for existing
|
||||
allocations.
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@
|
||||
</td>
|
||||
<td>
|
||||
The specific CPU cores reserved for the task in cpuset list notation.
|
||||
Omitted if the the task does not request cpu cores. E.g. <code>0-2,7,12-14</code>
|
||||
Omitted if the task does not request cpu cores. E.g. <code>0-2,7,12-14</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
@@ -194,7 +194,7 @@ Power usage = 37 / 149 W
|
||||
Temperature = 34 C
|
||||
```
|
||||
|
||||
Run the following example job to see that that the GPU was mounted in the
|
||||
Run the following example job to see that the GPU was mounted in the
|
||||
container:
|
||||
|
||||
```hcl
|
||||
@@ -291,4 +291,4 @@ Wed Jan 23 18:25:32 2019
|
||||
[nvidia_hook]: https://github.com/lxc/lxc/blob/master/hooks/nvidia
|
||||
[nvidia_plugin_download]: https://releases.hashicorp.com/nomad-device-nvidia/
|
||||
[nvidia_container_toolkit]: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html
|
||||
[source]: https://github.com/hashicorp/nomad-device-nvidia
|
||||
[source]: https://github.com/hashicorp/nomad-device-nvidia
|
||||
|
||||
@@ -408,7 +408,7 @@ the networking namespace of one container for other tasks in the same group.
|
||||
|
||||
A typical example is a network server and a metric exporter or log shipping
|
||||
sidecar. The metric exporter needs access to a private monitoring port which
|
||||
should not be exposed the the network and thus is usually bound to `localhost`.
|
||||
should not be exposed to the network and thus is usually bound to `localhost`.
|
||||
|
||||
The [`nomad-driver-podman` repository][homepage] includes three different
|
||||
examples jobs for such a setup. All of them will start a
|
||||
|
||||
@@ -27,7 +27,7 @@ apm "example-apm-plugin" {
|
||||
- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
|
||||
plugin binary when it is executed.
|
||||
|
||||
- `driver` `(string: "")` - The plugin's executable name relative to to the
|
||||
- `driver` `(string: "")` - The plugin's executable name relative to the
|
||||
[`plugin_dir`][plugin_dir]. If the plugin has a suffix, such as .exe, this
|
||||
should be omitted.
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ strategy "example-strategy-plugin" {
|
||||
- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
|
||||
plugin binary when it is executed.
|
||||
|
||||
- `driver` `(string: "")` - The plugin's executable name relative to to the
|
||||
- `driver` `(string: "")` - The plugin's executable name relative to the
|
||||
[`plugin_dir`][plugin_dir]. If the plugin has a suffix, such as .exe, this should be omitted.
|
||||
|
||||
- `config` `(map<string><string>: nil)` - Specifies configuration values for
|
||||
|
||||
@@ -27,7 +27,7 @@ target "example-target-plugin" {
|
||||
- `args` `(array<string>: [])` - Specifies a set of arguments to pass to the
|
||||
plugin binary when it is executed.
|
||||
|
||||
- `driver` `(string: "")` - The plugin's executable name relative to to the
|
||||
- `driver` `(string: "")` - The plugin's executable name relative to the
|
||||
[`plugin_dir`][plugin_dir]. If the plugin has a suffix, such as .exe, this
|
||||
should be omitted.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user