Skip to content

Commit

Permalink
Updates based on review.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrasell committed Oct 2, 2024
1 parent e3c3317 commit a018046
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 30 deletions.
8 changes: 4 additions & 4 deletions website/content/api-docs/json-jobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ The `Task` object supports the following keys:
in a port map. A numeric port may be specified since port maps aren't
required by all network plugins. Useful for advertising SDN and
overlay network addresses. Task will fail if driver network cannot be
determined. Only implemented for Docker and rkt.
determined. Only implemented for Docker.

- `host` - Use the host IP and port.

Expand Down Expand Up @@ -625,7 +625,7 @@ The `Task` object supports the following keys:
supplied, this value takes precedence over the `Service.PortLabel`
value. This is useful for services which operate on multiple ports.
`http` and `tcp` checks require a port while `script` checks do not.
Checks will use the host IP and ports by default. Numeric ports may be
Checks will use the host IP and ports by default. Numeric ports may be
used if `AddressMode: "driver"` is set on the check.

- `Header`: Headers for HTTP checks. Should be an object where the values
Expand Down Expand Up @@ -657,7 +657,7 @@ The `Task` object supports the following keys:
checks.

- `TLSSkipVerify`: If true, Consul will not attempt to verify the
certificate when performing HTTPS checks.
certificate when performing HTTPS checks.

- `CheckRestart`: `CheckRestart` is an object which enables
restarting of tasks based upon Consul health checks.
Expand Down Expand Up @@ -1095,7 +1095,7 @@ creates a convenient way to ship configuration files that are populated from
environment variables, Consul data, Vault secrets, or just general
configurations within a Nomad task.

Nomad utilizes a tool called [Consul Template][ct]. The template can reference
Nomad utilizes a tool called [Consul Template][ct]. The template can reference
[Nomad's runtime environment variables][env]. For a full list of the API template
functions, please refer to the [Consul Template README][ct].

Expand Down
14 changes: 8 additions & 6 deletions website/content/docs/drivers/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ Task drivers are used by Nomad clients to execute a task and provide resource
isolation. By having extensible task drivers, Nomad has the flexibility to
support a broad set of workloads across all major operating systems.

Task drivers are pluggable. This gives users the flexibility to introduce their
own drivers without having to recompile Nomad. You can view the [plugin block][plugin]
documentation for examples on how to use the `plugin` block in Nomad's client configuration.
See [docker][docker_plugin] for a more detailed and specific example.
Keep in mind that even though all built-in drivers are plugins, Nomad
remains a single binary and maintains backwards compatibility.
Task drivers are pluggable. This gives you the flexibility to introduce your
own drivers without having to recompile Nomad. You can view the
[plugin block][plugin] documentation for examples on how to use the plugin
block in Nomad's client configuration. See the Docker driver's
[Client Requirements][docker_plugin] for a more detailed and specific example.

The Nomad binary includes the default task drivers, so you do not have to
download them separately.

The list of supported task drivers is provided on the left of this page. Each
task driver documents the configuration available in a [job
Expand Down
7 changes: 3 additions & 4 deletions website/content/docs/job-specification/task.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,9 @@ job "docs" {

- `user` `(string: <varies>)` - Specifies the user that will run the task.
Defaults to `nobody` for the [`exec`][exec] and [`java`][java] drivers.
[Docker][] and [rkt][] images specify their own default users. This can only
be set on Linux platforms, and clients can restrict
[which drivers][user_drivers] are allowed to run tasks as
[certain users][user_denylist].
[Docker][] images specify their own default users. This can only be set
on Linux platforms, and clients can restrict [which drivers][user_drivers]
are allowed to run tasks as [certain users][user_denylist].

- `template` <code>([Template][]: nil)</code> - Specifies the set of templates
to render for the task. Templates can be used to inject both static and
Expand Down
15 changes: 8 additions & 7 deletions website/content/plugins/drivers/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ Task drivers are used by Nomad clients to execute a task and provide resource
isolation. By having extensible task drivers, Nomad has the flexibility to
support a broad set of workloads across all major operating systems.

Task drivers are pluggable. This gives users the flexibility to introduce their
own drivers without having to recompile Nomad. You can view the [plugin block][plugin]
documentation for examples on how to use the `plugin` block in Nomad's client configuration.
Note that we have introduced new syntax when specifying driver options in the client
configuration (see [docker][docker_plugin] for an example). Keep in mind that even though
all built-in drivers are now plugins, Nomad remains a single binary and maintains
backwards compatibility.
Task drivers are pluggable. This gives you the flexibility to introduce your
own drivers without having to recompile Nomad. You can view the
[plugin block][plugin] documentation for examples on how to use the plugin
block in Nomad's client configuration. See the Docker driver's
[Client Requirements][docker_plugin] for a more detailed and specific example.

The Nomad binary includes the default task drivers, so you do not have to
download them separately.

The list of supported task drivers is provided on the left of this page. Each
task driver documents the configuration available in a [job
Expand Down
9 changes: 0 additions & 9 deletions website/data/docs-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -2008,15 +2008,6 @@
"title": "Pot",
"href": "/plugins/drivers/community/pot"
},
{
"title": "Rkt",
"badge": {
"text": "Deprecated",
"type": "outlined",
"color": "neutral"
},
"href": "/plugins/drivers/community/rkt"
},
{
"title": "Rookout",
"href": "/plugins/drivers/community/rookout"
Expand Down

0 comments on commit a018046

Please sign in to comment.