([sidecar_service][]: nil) - 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"
diff --git a/website/content/docs/job-specification/expose.mdx b/website/content/docs/job-specification/expose.mdx
index 17fe8b47c..e7b5396e0 100644
--- a/website/content/docs/job-specification/expose.mdx
+++ b/website/content/docs/job-specification/expose.mdx
@@ -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'
diff --git a/website/content/docs/job-specification/gateway.mdx b/website/content/docs/job-specification/gateway.mdx
index 0ca7cd931..7dcfbe80c 100644
--- a/website/content/docs/job-specification/gateway.mdx
+++ b/website/content/docs/job-specification/gateway.mdx
@@ -10,15 +10,15 @@ description: |-
(array<[service]>: required) - 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
diff --git a/website/content/docs/job-specification/proxy.mdx b/website/content/docs/job-specification/proxy.mdx
index fce984bf6..0f256f0cb 100644
--- a/website/content/docs/job-specification/proxy.mdx
+++ b/website/content/docs/job-specification/proxy.mdx
@@ -58,11 +58,11 @@ job "countdash" {
- `upstreams` ([upstreams][]: nil) - Used to configure details of each upstream service that
this sidecar proxy communicates with.
- `expose` ([expose]: nil) - 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
diff --git a/website/content/docs/job-specification/service.mdx b/website/content/docs/job-specification/service.mdx
index 2fb6861ab..91bc66590 100644
--- a/website/content/docs/job-specification/service.mdx
+++ b/website/content/docs/job-specification/service.mdx
@@ -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: | 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'}
- |
-
| 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 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 | -
| Variable | -Description | -
|---|---|
- NOMAD_ALLOC_DIR
- |
-
- The path to the shared alloc/ directory. See
- here for more information.
- |
-
- NOMAD_TASK_DIR
- |
-
- The path to the task local/ directory. See
- here for more information.
- |
-
- NOMAD_SECRETS_DIR
- |
- - Path to the task's secrets directory. See - here 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>}
-
- which are keys in the node's metadata.
- |
-
- VAULT_TOKEN
- |
- - The task's Vault token. See - Vault Integration - for more details - | -
| Network-related Variables | -|
- NOMAD_IP_<label>
- |
-
- Host IP for the given port label. See
- here for more 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 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 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.
- |
-
- NOMAD_UPSTREAM_PORT_<service>
- |
-
- Port for the given service when defined as a Consul Connect
- upstream.
- |
-
- NOMAD_UPSTREAM_ADDR_<service>
- |
-
- Host IP:Port for the given service when
- defined as a Consul Connect
- upstream.
- |
-
- 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. - | -