117 lines
3.1 KiB
Plaintext
117 lines
3.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: upstreams Stanza - Job Specification
|
|
sidebar_title: upstreams
|
|
description: |-
|
|
The "upstreams" stanza allows specifying options for configuring
|
|
upstream services
|
|
---
|
|
|
|
# `upstreams` Stanza
|
|
|
|
<Placement
|
|
groups={[
|
|
'job',
|
|
'group',
|
|
'service',
|
|
'connect',
|
|
'sidecar_service',
|
|
'proxy',
|
|
'upstreams',
|
|
]}
|
|
/>
|
|
|
|
The `upstreams` stanza allows configuring various options for managing upstream
|
|
services that a [Consul
|
|
Connect](/docs/integrations/consul-connect) proxy routes to. It
|
|
is valid only within the context of a `proxy` stanza.
|
|
|
|
For Consul-specific details see the [Consul Connect
|
|
Guide](https://learn.hashicorp.com/consul/getting-started/connect#register-a-dependent-service-and-proxy).
|
|
|
|
```hcl
|
|
job "countdash" {
|
|
datacenters = ["dc1"]
|
|
|
|
group "dashboard" {
|
|
network {
|
|
mode = "bridge"
|
|
|
|
port "http" {
|
|
static = 9002
|
|
to = 9002
|
|
}
|
|
}
|
|
|
|
service {
|
|
name = "count-dashboard"
|
|
port = "9002"
|
|
|
|
connect {
|
|
sidecar_service {
|
|
proxy {
|
|
upstreams {
|
|
destination_name = "count-api"
|
|
local_bind_port = 8080
|
|
datacenter = "dc1"
|
|
local_bind_address = "127.0.0.1"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
task "dashboard" {
|
|
driver = "docker"
|
|
|
|
env {
|
|
COUNTING_SERVICE_URL = "http://${NOMAD_UPSTREAM_ADDR_count_api}"
|
|
}
|
|
|
|
config {
|
|
image = "hashicorpnomad/counter-dashboard:v3"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
```
|
|
|
|
## `upstreams` Parameters
|
|
|
|
- `destination_name` `(string: <required>)` - Name of the upstream service.
|
|
- `local_bind_port` - `(int: <required>)` - The port the proxy will receive
|
|
connections for the upstream on.
|
|
- `datacenter` `(string: "")` - The Consul datacenter in which to issue the
|
|
discovery query. Defaults to the empty string, which Consul interprets as the
|
|
local Consul datacenter.
|
|
- `local_bind_address` - `(string: "")` - The address the proxy will receive
|
|
connections for the upstream on.
|
|
|
|
The `NOMAD_UPSTREAM_ADDR_<destination_name>` environment variables may be used
|
|
to interpolate the upstream's `host:port` address.
|
|
|
|
Applications are encouraged to connect to `127.0.0.1` and a well defined port
|
|
(eg 6379 for Redis) by default. Then when using Consul Connect the application
|
|
can be deployed with the Redis upstream's `local_bind_port = 6379` and require
|
|
no explicit configuration.
|
|
|
|
## `upstreams` Examples
|
|
|
|
The following example is an upstream config with the name of the destination service
|
|
and a local bind port.
|
|
|
|
```hcl
|
|
upstreams {
|
|
destination_name = "count-api"
|
|
local_bind_port = 8080
|
|
}
|
|
```
|
|
|
|
[job]: /docs/job-specification/job 'Nomad job Job Specification'
|
|
[group]: /docs/job-specification/group 'Nomad group Job Specification'
|
|
[task]: /docs/job-specification/task 'Nomad task Job Specification'
|
|
[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'
|