kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-06 10:25:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

website: fixes redirected links (#14918)

Browse Source
This commit is contained in:
Bryce Kalow
2022-10-18 10:31:52 -05:00
committed by GitHub
parent cbf2ed2f18
commit f49b3a95dd
23 changed files with 122 additions and 657 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/content/docs/concepts/security.mdx
View File

@@ -17,7 +17,7 @@ workloads including Docker, non-containerized, microservice, and batch
applications.
Nomad utilizes a lightweight gossip and RPC system, [similar to
Consul](https://www.consul.io/docs/concepts/security), which provides
Consul](https://developer.hashicorp.com/consul/docs/concepts/security), which provides
various essential features. Both of these systems provide security mechanisms
which should be utilized to help provide [confidentiality, integrity and
authentication](https://en.wikipedia.org/wiki/Information_security).

2
website/content/docs/concepts/variables.mdx
View File

@@ -155,7 +155,7 @@ nomad acl policy apply \
See [Workload Associated ACL Policies] for more details.
[HashiCorp Consul]: https://www.consul.io/
[HashiCorp Vault]: https://vaultproject.io
[HashiCorp Vault]: https://www.vaultproject.io/
[Key Management]: /docs/operations/key-management
[ACL policy specification]: /docs/other-specifications/acl-policy
[`template`]: /docs/job-specification/template

4
website/content/docs/configuration/consul.mdx
View File

@@ -90,13 +90,13 @@ configuring Nomad to talk to Consul via DNS such as consul.service.consul
- `grpc_address` `(string: "127.0.0.1:8502")` - Specifies the address to the local
Consul agent for `gRPC` requests, given in the format `host:port`. Note that
Consul does not enable the [`grpc`](https://www.consul.io/docs/agent/config/config-files#_grpc_port)
Consul does not enable the [`grpc`](https://developer.hashicorp.com/consul/docs/agent/config/config-files#_grpc_port)
listener by default.
- `key_file` `(string: "")` - Specifies the path to the private key used for
Consul communication. If this is set then you need to also set `cert_file`.
- `namespace` `(string: "")` - Specifies the [Consul namespace](https://www.consul.io/docs/enterprise/namespaces)
- `namespace` `(string: "")` - Specifies the [Consul namespace](https://developer.hashicorp.com/consul/docs/enterprise/namespaces)
used by the Consul integration. If non-empty, this namespace will be used on
all Consul API calls and for Consul Connect configurations.

4
website/content/docs/configuration/vault.mdx
View File

@@ -86,7 +86,7 @@ vault {
- `token` `(string: "")` - Specifies the parent Vault token to use to derive
child tokens for jobs requesting tokens. Only required on Nomad servers.
Nomad client agents use the allocation's token when contacting Vault.
Visit the [Vault Integration Guide](/docs/vault-integration)
Visit the [Vault Integration Guide](/docs/integrations/vault-integration)
to see how to generate an appropriate token in Vault.
!> It is **strongly discouraged** to place the token as a configuration
@@ -149,4 +149,4 @@ token needs to be given to the servers without having to restart them. A reload
can be accomplished by sending the process a `SIGHUP` signal.
[vault]: https://www.vaultproject.io/ 'Vault by HashiCorp'
[nomad-vault]: /docs/vault-integration 'Nomad Vault Integration'
[nomad-vault]: /docs/integrations/vault-integration 'Nomad Vault Integration'

2
website/content/docs/faq.mdx
View File

@@ -96,7 +96,7 @@ machine you will need to use the network interface IP address.
$ curl http://192.168.0.10:8080
```
[consul_dc]: https://www.consul.io/docs/agent/config/config-files#datacenter
[consul_dc]: https://developer.hashicorp.com/consul/docs/agent/config/config-files#datacenter
[consul_fed]: https://learn.hashicorp.com/tutorials/consul/federarion-gossip-wan
[nomad_region]: /docs/configuration#datacenter
[`bootstrap_expect`]: /docs/configuration/server#bootstrap_expect

2
website/content/docs/install/index.mdx
View File

@@ -266,7 +266,7 @@ as a copy of [`git`](https://www.git-scm.com/) in your `PATH`.
[consul-dev]: https://learn.hashicorp.com/consul/getting-started/agent#starting-the-agent
[consul-download]: https://www.consul.io/downloads
[consul-download]: https://developer.hashicorp.com/consul/downloads
[destroy]: https://www.vagrantup.com/docs/cli/destroy

6
website/content/docs/integrations/consul-connect.mdx
View File

@@ -11,7 +11,7 @@ description: >-
~> **Note:** Nomad's service mesh integration requires Linux network namespaces.
Consul service mesh will not run on Windows or macOS.
[Consul service mesh](https://www.consul.io/docs/connect) provides
[Consul service mesh](https://developer.hashicorp.com/consul/docs/connect) provides
service-to-service connection authorization and encryption using mutual
Transport Layer Security (TLS). Applications can use sidecar proxies in a
service mesh configuration to automatically establish TLS connections for
@@ -350,5 +350,5 @@ dashes (`-`) are converted to underscores (`_`) in environment variables so
[count-dashboard]: /img/count-dashboard.png
[consul_acl]: https://github.com/hashicorp/consul/issues/7414
[gh-9907]: https://github.com/hashicorp/nomad/issues/9907
[`Local`]: https://www.consul.io/docs/security/acl/acl-tokens#token-attributes
[anon_token]: https://www.consul.io/docs/security/acl/acl-tokens#special-purpose-tokens
[`Local`]: https://developer.hashicorp.com/consul/docs/security/acl/acl-tokens#token-attributes
[anon_token]: https://developer.hashicorp.com/consul/docs/security/acl/acl-tokens#special-purpose-tokens

4
website/content/docs/integrations/consul-integration.mdx
View File

@@ -125,9 +125,9 @@ service_prefix "" {
[consul]: https://www.consul.io/ "Consul by HashiCorp"
[consul_acls]: https://www.consul.io/docs/security/acl
[consul_acls]: https://developer.hashicorp.com/consul/docs/security/acl
[consul_namespaces]: https://www.consul.io/docs/enterprise/namespaces
[consul_namespaces]: https://developer.hashicorp.com/consul/docs/enterprise/namespaces
[consul_agent_namespace]: /docs/configuration/consul#namespace

2
website/content/docs/job-specification/check.mdx
View File

@@ -435,7 +435,7 @@ Output = nomad: Get "http://:9999/": dial tcp :9999: connect: connection re
</small>
[check_restart_stanza]: /docs/job-specification/check_restart
[consul_passfail]: https://www.consul.io/docs/discovery/checks#success-failures-before-passing-critical
[consul_passfail]: https://developer.hashicorp.com/consul/docs/discovery/checks#success-failures-before-passing-critical
[network]: /docs/job-specification/network 'Nomad network Job Specification'
[service]: /docs/job-specification/service
[service_task]: /docs/job-specification/service#task-1

6
website/content/docs/job-specification/connect.mdx
View File

@@ -50,7 +50,7 @@ Used to configure a connect service. Only one of `native`, `sidecar_service`,
or `gateway` may be realized per `connect` block.
- `native` - `(bool: false)` - This is used to configure the service as supporting
[Connect Native](https://www.consul.io/docs/connect/native) applications.
[Connect Native](https://developer.hashicorp.com/consul/docs/connect/native) applications.
- `sidecar_service` - <code>([sidecar_service][]: nil)</code> - This is used to
configure the sidecar service created by Nomad for Consul Connect.
@@ -66,7 +66,7 @@ or `gateway` may be realized per `connect` block.
### Using Connect Native
The following example is a minimal service stanza for a
[Consul Connect Native](https://www.consul.io/docs/connect/native)
[Consul Connect Native](https://developer.hashicorp.com/consul/docs/connect/native)
application implemented by a task named `generate`.
```hcl
@@ -249,7 +249,7 @@ job "ingress-demo" {
[job]: /docs/job-specification/job "Nomad job Job Specification"
[native]: https://www.consul.io/docs/connect/native
[native]: https://developer.hashicorp.com/consul/docs/connect/native
[service_task]: /docs/job-specification/service#task-1 "Nomad service task"

2
website/content/docs/job-specification/expose.mdx
View File

@@ -229,7 +229,7 @@ check {
```
[network-to]: /docs/job-specification/network#to
[consul-expose-path-config]: https://www.consul.io/docs/connect/registration/service-registration#expose-paths-configuration-reference
[consul-expose-path-config]: https://developer.hashicorp.com/consul/docs/connect/registration/service-registration#expose-paths-configuration-reference
[expose-path]: /docs/job-specification/expose#path-1
[expose]: /docs/job-specification/service#expose
[path]: /docs/job-specification/expose#path-parameters 'Nomad Expose Path Parameters'

24
website/content/docs/job-specification/gateway.mdx
View File

@@ -10,15 +10,15 @@ description: |-
<Placement groups={['job', 'group', 'service', 'connect', 'gateway']} />
The `gateway` stanza allows configuration of [Consul Connect Gateways](https://www.consul.io/docs/connect/gateways). Nomad will
automatically create the necessary Gateway [Configuration Entry](https://www.consul.io/docs/agent/config-entries)
The `gateway` stanza allows configuration of [Consul Connect Gateways](https://developer.hashicorp.com/consul/docs/connect/gateways). Nomad will
automatically create the necessary Gateway [Configuration Entry](https://developer.hashicorp.com/consul/docs/agent/config-entries)
as well as inject an Envoy proxy task into the Nomad job to serve as the Gateway.
The `gateway` configuration is valid within the context of a `connect` stanza.
Additional information about Gateway configurations can be found in Consul's
[Connect Gateways](https://www.consul.io/docs/connect/gateways) documentation.
[Connect Gateways](https://developer.hashicorp.com/consul/docs/connect/gateways) documentation.
~> **Note:** [Ingress Gateways](https://www.consul.io/docs/connect/gateways/ingress-gateway)
~> **Note:** [Ingress Gateways](https://developer.hashicorp.com/consul/docs/connect/gateways/ingress-gateway)
are generally intended for enabling access into a Consul service mesh from within the
same network. For public ingress products like [NGINX](https://learn.hashicorp.com/tutorials/nomad/load-balancing-nginx?in=nomad/load-balancing)
provide more suitable features.
@@ -101,17 +101,17 @@ envoy_gateway_bind_addresses "<service>" {
- `tls_min_version` `(string: optional)` - Set the default minimum TLS version
supported by the gateway. Refer to
[`TLSMinVersion`](https://www.consul.io/docs/connect/config-entries/ingress-gateway#tlsminversion)
[`TLSMinVersion`](https://developer.hashicorp.com/consul/docs/connect/config-entries/ingress-gateway#tlsminversion)
in the Consul documentation for supported versions.
- `tls_max_version` `(string: optional)` - Set the default maximum TLS version
supported by the gateway. Refer to
[`TLSMaxVersion`](https://www.consul.io/docs/connect/config-entries/ingress-gateway#tlsmaxversion)
[`TLSMaxVersion`](https://developer.hashicorp.com/consul/docs/connect/config-entries/ingress-gateway#tlsmaxversion)
in the Consul documentation for supported versions.
- `cipher_suites` `(array<string>: optional)` - Set the default list of TLS
cipher suites for the gateway's listeners. Refer to
[`CipherSuites`](https://www.consul.io/docs/connect/config-entries/ingress-gateway#ciphersuites)
[`CipherSuites`](https://developer.hashicorp.com/consul/docs/connect/config-entries/ingress-gateway#ciphersuites)
in the Consul documentation for the supported cipher suites.
#### `listener` Parameters
@@ -121,7 +121,7 @@ envoy_gateway_bind_addresses "<service>" {
of `tcp`, `http`, `http2`, or `grpc`.
~> **Note:** If using any protocol other than `tcp` (for example: `http` or `grpc`), preconfiguring a [service-default] in Consul to
set the [Protocol](https://www.consul.io/docs/agent/config-entries/service-defaults#protocol)
set the [Protocol](https://developer.hashicorp.com/consul/docs/connect/config-entries/service-defaults#protocol)
of the service to the desired protocol is mandatory due to an [open issue](https://github.com/hashicorp/nomad/issues/8647).
- `service` <code>(array<[service]>: required)</code> - One or more services to be
@@ -648,9 +648,9 @@ job "countdash-mesh-two" {
[address]: /docs/job-specification/gateway#address-parameters
[advanced configuration]: https://www.consul.io/docs/connect/proxies/envoy#advanced-configuration
[connect_timeout_ms]: https://www.consul.io/docs/connect/config-entries/service-resolver#connecttimeout
[connect_mesh_gw]: https://www.consul.io/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways#mesh-gateways
[advanced configuration]: https://developer.hashicorp.com/consul/docs/connect/proxies/envoy#advanced-configuration
[connect_timeout_ms]: https://developer.hashicorp.com/consul/docs/connect/config-entries/service-resolver#connecttimeout
[connect_mesh_gw]: https://developer.hashicorp.com/consul/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways#mesh-gateways
[envoy docker]: https://hub.docker.com/r/envoyproxy/envoy/tags
[ingress]: /docs/job-specification/gateway#ingress-parameters
[proxy]: /docs/job-specification/gateway#proxy-parameters
@@ -658,7 +658,7 @@ job "countdash-mesh-two" {
[listener]: /docs/job-specification/gateway#listener-parameters
[interpolation]: /docs/runtime/interpolation
[service]: /docs/job-specification/gateway#service-parameters
[service-default]: https://www.consul.io/docs/agent/config-entries/service-defaults
[service-default]: https://developer.hashicorp.com/consul/docs/connect/config-entries/service-defaults
[sidecar_task]: /docs/job-specification/sidecar_task
[terminating]: /docs/job-specification/gateway#terminating-parameters
[tls]: /docs/job-specification/gateway#tls-parameters

4
website/content/docs/job-specification/proxy.mdx
View File

@@ -58,11 +58,11 @@ job "countdash" {
- `upstreams` <code>([upstreams][]: nil)</code> - Used to configure details of each upstream service that
this sidecar proxy communicates with.
- `expose` <code>([expose]: nil)</code> - Used to configure expose path configuration for Envoy.
See Consul's [Expose Paths Configuration Reference](https://www.consul.io/docs/connect/registration/service-registration#expose-paths-configuration-reference)
See Consul's [Expose Paths Configuration Reference](https://developer.hashicorp.com/consul/docs/connect/registration/service-registration#expose-paths-configuration-reference)
for more information.
- `config` `(map: nil)` - Proxy configuration that's opaque to Nomad and
passed directly to Consul. See [Consul Connect's
documentation](https://www.consul.io/docs/connect/proxies/envoy#dynamic-configuration)
documentation](https://developer.hashicorp.com/consul/docs/connect/proxies/envoy#dynamic-configuration)
for details. Keys and values support [runtime variable interpolation][interpolation].
## `proxy` Examples

8
website/content/docs/job-specification/service.mdx
View File

@@ -137,7 +137,7 @@ Connect][connect] integration.
- `enable_tag_override` `(bool: false)` - Enables users of Consul's Catalog API
to make changes to the tags of a service without having those changes be
overwritten by Consul's anti-entropy mechanism. See Consul
[documentation](https://www.consul.io/docs/concepts/anti-entropy#enable-tag-override)
[documentation](https://developer.hashicorp.com/consul/docs/concepts/anti-entropy#enable-tag-override)
for more information. Only available where `provider = "consul"`.
- `address` `(string: <optional>)` - Specifies a custom address to advertise in
@@ -501,8 +501,8 @@ advertise and check directly since Nomad isn't managing any port assignments.
[check]: /docs/job-specification/check
[check_restart_stanza]: /docs/job-specification/check_restart
[consul_grpc]: https://www.consul.io/api-docs/agent/check#grpc
[consul_passfail]: https://www.consul.io/docs/agent/checks#success-failures-before-passing-critical
[consul_grpc]: https://developer.hashicorp.com/consul/api-docs/agent/check#grpc
[consul_passfail]: https://developer.hashicorp.com/consul/docs/discovery/checks#success-failures-before-passing-critical
[service-discovery]: /docs/integrations/consul-integration#service-discovery 'Nomad Service Discovery'
[interpolation]: /docs/runtime/interpolation 'Nomad Runtime Interpolation'
[network]: /docs/job-specification/network 'Nomad network Job Specification'
@@ -516,4 +516,4 @@ advertise and check directly since Nomad isn't managing any port assignments.
[service_task]: /docs/job-specification/service#task-1
[network_mode]: /docs/job-specification/network#mode
[on_update]: /docs/job-specification/service#on_update
[tagged_addresses]: https://www.consul.io/docs/discovery/services#tagged-addresses
[tagged_addresses]: https://developer.hashicorp.com/consul/docs/discovery/services#tagged-addresses

2
website/content/docs/job-specification/task.mdx
View File

@@ -215,7 +215,7 @@ task "server" {
[exec]: /docs/drivers/exec 'Nomad exec Driver'
[java]: /docs/drivers/java 'Nomad Java Driver'
[docker]: /docs/drivers/docker 'Nomad Docker Driver'
[rkt]: /docs/drivers/rkt 'Nomad rkt Driver'
[rkt]: /plugins/drivers/community/rkt 'Nomad rkt Driver'
[service_discovery]: /docs/integrations/consul-integration#service-discovery 'Nomad Service Discovery'
[template]: /docs/job-specification/template 'Nomad template Job Specification'
[user_drivers]: /docs/configuration/client#user-checked_drivers

4
website/content/docs/job-specification/upstreams.mdx
View File

@@ -133,6 +133,6 @@ and a local bind port.
[interpolation]: /docs/runtime/interpolation 'Nomad interpolation'
[sidecar_service]: /docs/job-specification/sidecar_service 'Nomad sidecar service Specification'
[upstreams]: /docs/job-specification/upstreams 'Nomad upstream config Specification'
[service_defaults_mode]: https://www.consul.io/docs/connect/config-entries/service-defaults#meshgateway
[service_defaults_mode]: https://developer.hashicorp.com/consul/docs/connect/config-entries/service-defaults#meshgateway
[mesh_gateway_param]: /docs/job-specification/upstreams#mesh_gateway-parameters
[mesh_gateways]: https://www.consul.io/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters#mesh-gateways
[mesh_gateways]: https://developer.hashicorp.com/consul/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters#mesh-gateways

2
website/content/docs/operations/index.mdx
View File

@@ -12,7 +12,7 @@ learn more, choose an item from the sidebar, or choose one of the options
below:
- [Operating Nomad Agents](/docs/operations/nomad-agent)
- [Telemetry Overview](/docs/operations/telemetry)
- [Telemetry Overview](/docs/operations/monitoring-nomad)
- [Metrics](/docs/operations/metrics-reference)
- [Cluster Management](https://learn.hashicorp.com/collections/nomad/manage-clusters)
- [Transport Security](https://learn.hashicorp.com/collections/nomad/transport-security)

6
website/content/docs/operations/monitoring-nomad.mdx
View File

@@ -292,14 +292,14 @@ latency and packet loss for the [Serf] address.
[alerting-rules]: https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/
[alertmanager]: https://prometheus.io/docs/alerting/alertmanager/
[allocation-metrics]: /docs/telemetry/metrics#allocation-metrics
[allocation-metrics]: /docs/operations/metrics-reference#allocation-metrics
[circonus-telem]: /docs/configuration/telemetry#circonus
[collection-interval]: /docs/configuration/telemetry#collection_interval
[datadog-alerting]: https://www.datadoghq.com/blog/monitoring-101-alerting/
[datadog-telem]: /docs/configuration/telemetry#datadog
[draining]: https://learn.hashicorp.com/tutorials/nomad/node-drain
[gh-11830]: https://github.com/hashicorp/nomad/pull/11830
[metric-types]: /docs/telemetry/metrics#metric-types
[metric-types]: /docs/operations/metrics-reference#metric-types
[metrics-api-endpoint]: /api-docs/metrics
[prometheus-telem]: /docs/configuration/telemetry#prometheus
[`plan_rejection_tracker`]: /docs/configuration/server#plan_rejection_tracker
@@ -307,7 +307,7 @@ latency and packet loss for the [Serf] address.
[statsd-exporter]: https://github.com/prometheus/statsd_exporter
[statsd-telem]: /docs/configuration/telemetry#statsd
[statsite-telem]: /docs/configuration/telemetry#statsite
[tagged-metrics]: /docs/telemetry/metrics#tagged-metrics
[tagged-metrics]: /docs/operations/metrics-reference#tagged-metrics
[telemetry-stanza]: /docs/configuration/telemetry
[Consensus Protocol (Raft)]: /docs/operations/monitoring-nomad#consensus-protocol-raft
[Job Summary Metrics]: /docs/operations/metrics-reference#job-summary-metrics

2
website/content/docs/runtime/environment.mdx
View File

@@ -113,6 +113,6 @@ passed to the tasks can be controlled using the client configuration
[`env.denylist`][].
[jobspec]: /docs/job-specification 'Nomad Job Specification'
[vault]: /docs/vault-integration 'Nomad Vault Integration'
[vault]: /docs/integrations/vault-integration 'Nomad Vault Integration'
[filesystem internals]: /docs/concepts/filesystem
[`env.denylist`]: /docs/configuration/client#env-denylist

246
website/content/docs/runtime/interpolation.mdx
View File

@@ -63,227 +63,37 @@ Below is a full listing of node attributes that are interpretable. These
attributes are interpreted by **both** constraints and within the task and
driver.
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
<th>Example Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>{'${node.unique.id}'}</code>
</td>
<td>36 character unique client identifier</td>
<td>
<code>9afa5da1-8f39-25a2-48dc-ba31fd7c0023</code>
</td>
</tr>
<tr>
<td>
<code>{'${node.region}'}</code>
</td>
<td>Client's region</td>
<td>
<code>global</code>
</td>
</tr>
<tr>
<td>
<code>{'${node.datacenter}'}</code>
</td>
<td>Client's datacenter</td>
<td>
<code>dc1</code>
</td>
</tr>
<tr>
<td>
<code>{'${node.unique.name}'}</code>
</td>
<td>Client's name</td>
<td>
<code>nomad-client-10-1-2-4</code>
</td>
</tr>
<tr>
<td>
<code>{'${node.class}'}</code>
</td>
<td>Client's class</td>
<td>
<code>linux-64bit</code>
</td>
</tr>
<tr>
<td>
<code>
${'{'}attr.&lt;property&gt;{'}'}
</code>
</td>
<td>
Property given by <code>property</code> on the client
</td>
<td>
<code>{'${attr.cpu.arch} => amd64'}</code>
</td>
</tr>
<tr>
<td>
<code>
${'{'}meta.&lt;key&gt;{'}'}
</code>
</td>
<td>
Metadata value given by <code>key</code> on the client
</td>
<td>
<code>{'${meta.foo} => bar'}</code>
</td>
</tr>
</tbody>
</table>
| Variable | Description | Example Value |
| ------------------------- | ------------------------------------------- | -------------------------------------- |
| `${node.unique.id}` | 36 character unique client identifier | `9afa5da1-8f39-25a2-48dc-ba31fd7c0023` |
| `${node.region}` | Client's region | `global` |
| `${node.datacenter}` | Client's datacenter | `dc1` |
| `${node.unique.name}` | Client's name | `nomad-client-10-1-2-4` |
| `${node.class}` | Client's class | `linux-64bit` |
| `${attr.<property>}` | Property given by `property` on the client | `${attr.cpu.arch} => amd64` |
| `${meta.<key>}` | Metadata value given by `key` on the client | `${meta.foo} => bar` |
Below is a table documenting common node properties:
<table>
<thead>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>{'${attr.cpu.arch}'}</code>
</td>
<td>
CPU architecture of the client (e.g. <code>amd64</code>,{' '}
<code>386</code>)
</td>
</tr>
<tr>
<td>
<code>{'${attr.cpu.numcores}'}</code>
</td>
<td>Number of CPU cores on the client. May differ from how many cores are available for reservation due to OS or configuration. See <code>cpu.reservablecores</code>.</td>
</tr>
<tr>
<td>
<code>{'${attr.cpu.reservablecores}'}</code>
</td>
<td>Number of CPU cores on the client avaible for scheduling. Number of cores used by the scheduler when placing work with <code>resources.cores</code> set.</td>
</tr>
<tr>
<td>
<code>{'${attr.cpu.totalcompute}'}</code>
</td>
<td>
<code>cpu.frequency &times; cpu.numcores</code> but may be overridden by{' '}
<code>client.cpu_total_compute</code>
</td>
</tr>
<tr>
<td>
<code>{'${attr.consul.datacenter}'}</code>
</td>
<td>The Consul datacenter of the client (if Consul is found)</td>
</tr>
<tr>
<td>
<code>
${'{'}attr.driver.&lt;property&gt;{'}'}
</code>
</td>
<td>
See the <a href="/docs/drivers">task drivers</a> for property
documentation
</td>
</tr>
<tr>
<td>
<code>{'${attr.unique.hostname}'}</code>
</td>
<td>Hostname of the client</td>
</tr>
<tr>
<td>
<code>{'${attr.unique.network.ip-address}'}</code>
</td>
<td>
The IP address fingerprinted by the client and from which task ports are
allocated
</td>
</tr>
<tr>
<td>
<code>{'${attr.kernel.arch}'}</code>
</td>
<td>
Kernel architecture of the client (e.g. <code>x86_64</code>, <code>aarch64</code>)
</td>
</tr>
<tr>
<td>
<code>{'${attr.kernel.name}'}</code>
</td>
<td>
Kernel of the client (e.g. <code>linux</code>, <code>darwin</code>)
</td>
</tr>
<tr>
<td>
<code>{'${attr.kernel.version}'}</code>
</td>
<td>
Version of the client kernel (e.g. <code>3.19.0-25-generic</code>,{' '}
<code>15.0.0</code>)
</td>
</tr>
<tr>
<td>
<code>{'${attr.platform.aws.ami-id}'}</code>
</td>
<td>AMI ID of the client (if on AWS EC2)</td>
</tr>
<tr>
<td>
<code>{'${attr.platform.aws.instance-life-cycle}'}</code>
</td>
<td>Instance lifecycle (e.g. spot, on-demand) of the client (if on AWS EC2)</td>
</tr>
<tr>
<td>
<code>{'${attr.platform.aws.instance-type}'}</code>
</td>
<td>Instance type of the client (if on AWS EC2)</td>
</tr>
<tr>
<td>
<code>{'${attr.platform.aws.placement.availability-zone}'}</code>
</td>
<td>Availability Zone of the client (if on AWS EC2)</td>
</tr>
<tr>
<td>
<code>{'${attr.os.name}'}</code>
</td>
<td>
Operating system of the client (e.g. <code>ubuntu</code>,{' '}
<code>windows</code>, <code>darwin</code>)
</td>
</tr>
<tr>
<td>
<code>{'${attr.os.version}'}</code>
</td>
<td>Version of the client OS</td>
</tr>
</tbody>
</table>
| Property | Description |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `${attr.cpu.arch}` | CPU architecture of the client (e.g. `amd64`, `386`) |
| `${attr.cpu.numcores}` | Number of CPU cores on the client. May differ from how many cores are available for reservation due to OS or configuration. See `cpu.reservablecores`. |
| `${attr.cpu.reservablecores}` | Number of CPU cores on the client avaible for scheduling. Number of cores used by the scheduler when placing work with `resources.cores` set. |
| `${attr.cpu.totalcompute}` | `cpu.frequency × cpu.numcores` but may be overridden by `client.cpu_total_compute` |
| `${attr.consul.datacenter}` | The Consul datacenter of the client (if Consul is found) |
| `${attr.driver.<property>}` | See the [task drivers](/docs/drivers) for property documentation |
| `${attr.unique.hostname}` | Hostname of the client |
| `${attr.unique.network.ip-address}` | The IP address fingerprinted by the client and from which task ports are allocated |
| `${attr.kernel.arch}` | Kernel architecture of the client (e.g. `x86_64`, `aarch64`) |
| `${attr.kernel.name}` | Kernel of the client (e.g. `linux`, `darwin`) |
| `${attr.kernel.version}` | Version of the client kernel (e.g. `3.19.0-25-generic`, `15.0.0`) |
| `${attr.platform.aws.ami-id}` | AMI ID of the client (if on AWS EC2) |
| `${attr.platform.aws.instance-life-cycle}` | Instance lifecycle (e.g. spot, on-demand) of the client (if on AWS EC2) |
| `${attr.platform.aws.instance-type}` | Instance type of the client (if on AWS EC2) |
| `${attr.platform.aws.placement.availability-zone}` | Availability Zone of the client (if on AWS EC2) |
| `${attr.os.name}` | Operating system of the client (e.g. `ubuntu`, `windows`, `darwin`) |
| `${attr.os.version}` | Version of the client OS |
The full list of node attributes can be obtained by running `nomad node status -verbose [node]`.

4
website/content/docs/upgrade/upgrade-specific.mdx
View File

@@ -1521,8 +1521,8 @@ deleted and then Nomad 0.3.0 can be launched.
[cap_drop_exec]: /docs/drivers/exec#cap_drop
[`log_file`]: /docs/configuration#log_file
[Upgrading to Raft Protocol 3]: /docs/upgrade#upgrading-to-raft-protocol-3
[`Local`]: https://www.consul.io/docs/security/acl/acl-tokens#token-attributes
[anon_token]: https://www.consul.io/docs/security/acl/acl-tokens#special-purpose-tokens
[`Local`]: https://developer.hashicorp.com/consul/docs/security/acl/acl-tokens#token-attributes
[anon_token]: https://developer.hashicorp.com/consul/docs/security/acl/acl-tokens#special-purpose-tokens
[consul_acl]: https://github.com/hashicorp/consul/issues/7414
[kill_timeout]: /docs/job-specification/task#kill_timeout
[max_kill_timeout]: /docs/configuration/client#max_kill_timeout

439
website/content/partials/envvars.mdx
View File

@@ -1,392 +1,47 @@
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>NOMAD_ALLOC_DIR</code>
</td>
<td>
The path to the shared <code>alloc/</code> directory. See
<a href="/docs/runtime/environment#task-directories"> here</a> for more information.
</td>
</tr>
<tr>
<td>
<code>NOMAD_TASK_DIR</code>
</td>
<td>
The path to the task <code>local/</code> directory. See
<a href="/docs/runtime/environment#task-directories"> here</a> for more information.
</td>
</tr>
<tr>
<td>
<code>NOMAD_SECRETS_DIR</code>
</td>
<td>
Path to the task's secrets directory. See
<a href="/docs/runtime/environment#task-directories"> here</a> for more information.
</td>
</tr>
<tr>
<td>
<code>NOMAD_MEMORY_LIMIT</code>
</td>
<td>Memory limit in MB for the task</td>
</tr>
<tr>
<td>
<code>NOMAD_MEMORY_MAX_LIMIT</code>
</td>
<td>
The maximum memory limit the task may use if client has excess memory
capacity, in MB. Omitted if task isn't configured with memory oversubscription.
</td>
</tr>
<tr>
<td>
<code>NOMAD_CPU_LIMIT</code>
</td>
<td>CPU limit in MHz for the task</td>
</tr>
<tr>
<td>
<code>NOMAD_CPU_CORES</code>
</td>
<td>
The specific CPU cores reserved for the task in cpuset list notation.
Omitted if the task does not request cpu cores. E.g. <code>0-2,7,12-14</code>
</td>
</tr>
<tr>
<td>
<code>NOMAD_ALLOC_ID</code>
</td>
<td>Allocation ID of the task</td>
</tr>
<tr>
<td>
<code>NOMAD_SHORT_ALLOC_ID</code>
</td>
<td>The first 8 characters of the allocation ID of the task</td>
</tr>
<tr>
<td>
<code>NOMAD_ALLOC_NAME</code>
</td>
<td>Allocation name of the task</td>
</tr>
<tr>
<td>
<code>NOMAD_ALLOC_INDEX</code>
</td>
<td>
Allocation index; useful to distinguish instances of task groups. From 0
to (count - 1). The index is unique within a given version of a job, but
canaries or failed tasks in a deployment may reuse the index.
</td>
</tr>
<tr>
<td>
<code>NOMAD_TASK_NAME</code>
</td>
<td>Task's name</td>
</tr>
<tr>
<td>
<code>NOMAD_GROUP_NAME</code>
</td>
<td>Group's name</td>
</tr>
<tr>
<td>
<code>NOMAD_JOB_ID</code>
</td>
<td>
Job's ID, which is equal to the Job name when submitted through
CLI but can be different when using the API
</td>
</tr>
<tr>
<td>
<code>NOMAD_JOB_NAME</code>
</td>
<td>Job's name</td>
</tr>
<tr>
<td>
<code>NOMAD_JOB_PARENT_ID</code>
</td>
<td>ID of the Job's parent if it has one</td>
</tr>
<tr>
<td>
<code>NOMAD_DC</code>
</td>
<td>Datacenter in which the allocation is running</td>
</tr>
<tr>
<td>
<code>NOMAD_PARENT_CGROUP</code>
</td>
<td>The parent cgroup used to contain task cgroups (Linux only)</td>
</tr>
<tr>
<td>
<code>NOMAD_NAMESPACE</code>
</td>
<td>Namespace in which the allocation is running</td>
</tr>
<tr>
<td>
<code>NOMAD_REGION</code>
</td>
<td>Region in which the allocation is running</td>
</tr>
<tr>
<td>
<code>NOMAD_META_&lt;key&gt;</code>
</td>
<td>
The metadata value given by <code>key</code> on the task's
metadata. Note that this is different from
<a href="/docs/runtime/interpolation#node-variables-">
<code>$&#123;meta.&lt;key&gt;&#125;</code>
</a>
which are keys in the node's metadata.
</td>
</tr>
<tr>
<td>
<code>VAULT_TOKEN</code>
</td>
<td>
The task's Vault token. See
<a href="/docs/vault-integration"> Vault Integration </a>
for more details
</td>
</tr>
<tr>
<th colSpan="2">Network-related Variables</th>
</tr>
<tr>
<td>
<code>NOMAD_IP_&lt;label&gt;</code>
</td>
<td>
Host IP for the given port <code>label</code>. See
<a href="/docs/job-specification/network"> here for more</a> information.
</td>
</tr>
<tr>
<td>
<code>NOMAD_PORT_&lt;label&gt;</code>
</td>
<td>
Port for the given port <code>label</code>. Driver-specified port when a
port map is used, otherwise the host's static or dynamic port
allocation. Services should bind to this port. See
<a href="/docs/job-specification/network"> here for more</a> information.
</td>
</tr>
<tr>
<td>
<code>NOMAD_ADDR_&lt;label&gt;</code>
</td>
<td>
Host <code>IP:Port</code> pair for the given port <code>label</code>.
</td>
</tr>
<tr>
<td>
<code>NOMAD_HOST_PORT_&lt;label&gt;</code>
</td>
<td>
Port on the host for the port <code>label</code>. See
<a href="/docs/job-specification/network#mapped-ports"> here</a> for more
information.
</td>
</tr>
<tr>
<td>
<code>NOMAD_IP_&lt;task&gt;_&lt;label&gt;</code>
</td>
<td>
<b>Deprecated</b>. Host IP for the given port <code>label</code>
and <code>task</code> for tasks in the same task group. Only available
when setting ports via the task resource network port mapping.
</td>
</tr>
<tr>
<td>
<code>NOMAD_PORT_&lt;task&gt;_&lt;label&gt;</code>
</td>
<td>
<b>Deprecated</b>. Port for the given port <code>label</code> and
<code>task</code> for tasks in the same task group. Driver-specified port
when a port map is used, otherwise the host's static or dynamic port
allocation. Services should bind to this port. Only available when setting
ports via the task resource network port mapping.
</td>
</tr>
<tr>
<td>
<code>NOMAD_ADDR_&lt;task&gt;_&lt;label&gt;</code>
</td>
<td>
<b>Deprecated</b>. Host <code>IP:Port</code> pair for the given port
<code>label</code> and <code>task</code> for tasks in the same task group.
Only available when setting ports via the task resource network port
mapping.
</td>
</tr>
<tr>
<td>
<code>NOMAD_HOST_PORT_&lt;task&gt;_&lt;label&gt;</code>
</td>
<td>
<b>Deprecated</b>. Port on the host for the port <code>label</code> and
<code>task</code> for tasks in the same task group. Only available when
setting ports via the task resource network port mapping.
</td>
</tr>
<tr>
<td>
<code>NOMAD_UPSTREAM_IP_&lt;service&gt;</code>
</td>
<td>
IP for the given <code>service</code> when defined as a Consul Connect
<a href="/docs/job-specification/upstreams"> upstream</a>.
</td>
</tr>
<tr>
<td>
<code>NOMAD_UPSTREAM_PORT_&lt;service&gt;</code>
</td>
<td>
Port for the given <code>service</code> when defined as a Consul Connect
<a href="/docs/job-specification/upstreams"> upstream</a>.
</td>
</tr>
<tr>
<td>
<code>NOMAD_UPSTREAM_ADDR_&lt;service&gt;</code>
</td>
<td>
Host <code>IP:Port</code> for the given <code>service</code> when
defined as a Consul Connect
<a href="/docs/job-specification/upstreams"> upstream</a>.
</td>
</tr>
<tr>
<td>
<code>NOMAD_ENVOY_ADMIN_ADDR_&lt;service&gt;</code>
</td>
<td>
Local address <code>127.0.0.2:Port</code> for the admin port of the
envoy sidecar for the given <code>service</code> when defined as a
Consul Connect enabled service. Envoy runs inside the group network
namespace unless configured for host networking.
</td>
</tr>
<tr>
<td>
<code>NOMAD_ENVOY_READY_ADDR_&lt;service&gt;</code>
</td>
<td>
Local address <code>127.0.0.1:Port</code> for the ready port of the
envoy sidecar for the given <code>service</code> when defined as a
Consul Connect enabled service. Envoy runs inside the group network
namespace unless configured for host networking.
</td>
</tr>
<tr>
<th colSpan="2">Consul-related Variables (only set for connect native tasks)</th>
</tr>
<tr>
<td>
<code>CONSUL_HTTP_ADDR</code>
</td>
<td>
Specifies the address to the local Consul agent. Will be automatically
set to a unix domain socket in bridge networking mode, or a tcp address in
host networking mode.
</td>
</tr>
<tr>
<td>
<code>CONSUL_HTTP_TOKEN</code>
</td>
<td>
Specifies the Consul ACL token used to authorize with Consul. Will be
automatically set to a generated Connect service identity token specific
to the service instance if Consul ACLs are enabled.
</td>
</tr>
<tr>
<td>
<code>CONSUL_HTTP_SSL</code>
</td>
<td>
Specifies whether HTTPS should be used when communicating with consul. Will
be automatically set to true if Nomad is configured to communicate with
Consul using TLS.
</td>
</tr>
<tr>
<td>
<code>CONSUL_HTTP_SSL_VERIFY</code>
</td>
<td>
Specifies whether the HTTPS connection with Consul should be mutually
verified. Will be automatically set to true if Nomad is configured to
verify TLS certificates.
</td>
</tr>
<tr>
<td>
<code>CONSUL_CACERT</code>
</td>
<td>
Specifies the path to the CA certificate used for Consul communication.
Will be automatically set if Nomad is configured with the <code>consul.share_ssl</code>
option.
</td>
</tr>
<tr>
<td>
<code>CONSUL_CLIENT_CERT</code>
</td>
<td>
Specifies the path to the Client certificate used for Consul communication.
Will be automatically set if Nomad is configured with the <code>consul.share_ssl</code>
option.
</td>
</tr>
<tr>
<td>
<code>CONSUL_CLIENT_KEY</code>
</td>
<td>
Specifies the path to the CLient Key certificate used for Consul communication.
Will be automatically set if Nomad is configured with the <code>consul.share_ssl</code>
option.
</td>
</tr>
<tr>
<td>
<code>CONSUL_TLS_SERVER_NAME</code>
</td>
<td>
Specifies the server name to use as the SNI host for Consul communication.
Will be automatically set if Consul is configured to use TLS and the task
is in a group using bridge networking mode.
</td>
</tr>
</tbody>
</table>
| Variable | Description |
| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `NOMAD_ALLOC_DIR` | The path to the shared `alloc/` directory. See [here](/docs/runtime/environment#task-directories) for more information. |
| `NOMAD_TASK_DIR` | The path to the task `local/` directory. See [here](/docs/runtime/environment#task-directories) for more information. |
| `NOMAD_SECRETS_DIR` | Path to the task's secrets directory. See [here](/docs/runtime/environment#task-directories) for more information. |
| `NOMAD_MEMORY_LIMIT` | Memory limit in MB for the task |
| `NOMAD_MEMORY_MAX_LIMIT` | The maximum memory limit the task may use if client has excess memory capacity, in MB. Omitted if task isn't configured with memory oversubscription. |
| `NOMAD_CPU_LIMIT` | CPU limit in MHz for the task |
| `NOMAD_CPU_CORES` | The specific CPU cores reserved for the task in cpuset list notation. Omitted if the task does not request cpu cores. E.g. `0-2,7,12-14` |
| `NOMAD_ALLOC_ID` | Allocation ID of the task |
| `NOMAD_SHORT_ALLOC_ID` | The first 8 characters of the allocation ID of the task |
| `NOMAD_ALLOC_NAME` | Allocation name of the task |
| `NOMAD_ALLOC_INDEX` | Allocation index; useful to distinguish instances of task groups. From 0 to (count - 1). The index is unique within a given version of a job, but canaries or failed tasks in a deployment may reuse the index. |
| `NOMAD_TASK_NAME` | Task's name |
| `NOMAD_GROUP_NAME` | Group's name |
| `NOMAD_JOB_ID` | Job's ID, which is equal to the Job name when submitted through CLI but can be different when using the API |
| `NOMAD_JOB_NAME` | Job's name |
| `NOMAD_JOB_PARENT_ID` | ID of the Job's parent if it has one |
| `NOMAD_DC` | Datacenter in which the allocation is running |
| `NOMAD_PARENT_CGROUP` | The parent cgroup used to contain task cgroups (Linux only) |
| `NOMAD_NAMESPACE` | Namespace in which the allocation is running |
| `NOMAD_REGION` | Region in which the allocation is running |
| `NOMAD_META_<key>` | The metadata value given by `key` on the task's metadata. Note that this is different from [`${meta.<key>}`](/docs/runtime/interpolation#node-variables-) which are keys in the node's metadata. |
| `VAULT_TOKEN` | The task's Vault token. See [Vault Integration](/docs/vault-integration) for more details |
| **Network-related Variables** |
| `NOMAD_IP_<label>` | Host IP for the given port `label`. See [here for more](/docs/job-specification/network) information. |
| `NOMAD_PORT_<label>` | Port for the given port `label`. Driver-specified port when a port map is used, otherwise the host's static or dynamic port allocation. Services should bind to this port. See [here for more](/docs/job-specification/network) information. |
| `NOMAD_ADDR_<label>` | Host `IP:Port` pair for the given port `label`. |
| `NOMAD_HOST_PORT_<label>` | Port on the host for the port `label`. See [here](/docs/job-specification/network#mapped-ports) for more information. |
| `NOMAD_IP_<task>_<label>` | **Deprecated**. Host IP for the given port `label` and `task` for tasks in the same task group. Only available when setting ports via the task resource network port mapping. |
| `NOMAD_PORT_<task>_<label>` | **Deprecated**. Port for the given port `label` and `task` for tasks in the same task group. Driver-specified port when a port map is used, otherwise the host's static or dynamic port allocation. Services should bind to this port. Only available when setting ports via the task resource network port mapping. |
| `NOMAD_ADDR_<task>_<label>` | **Deprecated**. Host `IP:Port` pair for the given port `label` and `task` for tasks in the same task group. Only available when setting ports via the task resource network port mapping. |
| `NOMAD_HOST_PORT_<task>_<label>` | **Deprecated**. Port on the host for the port `label` and `task` for tasks in the same task group. Only available when setting ports via the task resource network port mapping. |
| `NOMAD_UPSTREAM_IP_<service>` | IP for the given `service` when defined as a Consul Connect [upstream](/docs/job-specification/upstreams). |
| `NOMAD_UPSTREAM_PORT_<service>` | Port for the given `service` when defined as a Consul Connect [upstream](/docs/job-specification/upstreams). |
| `NOMAD_UPSTREAM_ADDR_<service>` | Host `IP:Port` for the given `service` when defined as a Consul Connect [upstream](/docs/job-specification/upstreams). |
| `NOMAD_ENVOY_ADMIN_ADDR_<service>` | Local address `127.0.0.2:Port` for the admin port of the envoy sidecar for the given `service` when defined as a Consul Connect enabled service. Envoy runs inside the group network namespace unless configured for host networking. |
| `NOMAD_ENVOY_READY_ADDR_<service>` | Local address `127.0.0.1:Port` for the ready port of the envoy sidecar for the given `service` when defined as a Consul Connect enabled service. Envoy runs inside the group network namespace unless configured for host networking. |
| **Consul-related Variables** (only set for connect native tasks) |
| `CONSUL_HTTP_ADDR` | Specifies the address to the local Consul agent. Will be automatically set to a unix domain socket in bridge networking mode, or a tcp address in host networking mode. |
| `CONSUL_HTTP_TOKEN` | Specifies the Consul ACL token used to authorize with Consul. Will be automatically set to a generated Connect service identity token specific to the service instance if Consul ACLs are enabled. |
| `CONSUL_HTTP_SSL` | Specifies whether HTTPS should be used when communicating with consul. Will be automatically set to true if Nomad is configured to communicate with Consul using TLS. |
| `CONSUL_HTTP_SSL_VERIFY` | Specifies whether the HTTPS connection with Consul should be mutually verified. Will be automatically set to true if Nomad is configured to verify TLS certificates. |
| `CONSUL_CACERT` | Specifies the path to the CA certificate used for Consul communication. Will be automatically set if Nomad is configured with the `consul.share_ssl` option. |
| `CONSUL_CLIENT_CERT` | Specifies the path to the Client certificate used for Consul communication. Will be automatically set if Nomad is configured with the `consul.share_ssl` option. |
| `CONSUL_CLIENT_KEY` | Specifies the path to the CLient Key certificate used for Consul communication. Will be automatically set if Nomad is configured with the `consul.share_ssl` option. |
| `CONSUL_TLS_SERVER_NAME` | Specifies the server name to use as the SNI host for Consul communication. Will be automatically set if Consul is configured to use TLS and the task is in a group using bridge networking mode. |

2
website/content/plugins/drivers/podman.mdx
View File

@@ -566,7 +566,7 @@ configuration file.
[memory-value]: /docs/job-specification/resources#memory
[`network`]: /docs/job-specification/network
[nomad-init]: /docs/commands/job/init
[nomad_download]: /downloads.html
[nomad_download]: /downloads
[nomad_driver_ports]: /docs/drivers/docker#forwarding-and-exposing-ports
[nomad_group_network]: /docs/job-specification/group#network
[nomad_lifecycle_hooks]: /docs/job-specification/lifecycle