open-nomad/website/source/docs/job-specification/proxy.html.md

84 lines
2.2 KiB
Markdown
Raw Normal View History

2019-09-05 18:08:31 +00:00
---
layout: "docs"
page_title: "proxy Stanza - Job Specification"
sidebar_current: "docs-job-specification-proxy"
description: |-
The "proxy" stanza allows specifying options for configuring
sidecar proxies used in Consul Connect integration
---
# `proxy` Stanza
<table class="table table-bordered table-striped">
<tr>
<th width="120">Placement</th>
<td>
<code>job -> group -> service -> connect -> sidecar_service -> **proxy** </code>
</td>
</tr>
</table>
The `proxy` stanza allows configuring various options for the sidecar proxy
managed by Nomad for [Consul
Connect](/guides/integrations/consul-connect/index.html). It is valid only
within the context of a `sidecar_service` stanza.
2019-09-05 18:08:31 +00:00
```hcl
job "countdash" {
datacenters = ["dc1"]
group "api" {
network {
mode = "bridge"
}
service {
name = "count-api"
port = "9001"
connect {
sidecar_service {}
}
}
task "web" {
driver = "docker"
config {
image = "test/test:v1"
}
}
}
}
```
## `proxy` Parameters
- `upstreams` <code>([upstreams][]: nil)</code> Used to configure details of each upstream service that
this sidecar proxy communicates with.
- `config` - (map: nil)</code> - 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.html#dynamic-configuration)
for details.
2019-09-05 18:08:31 +00:00
## `proxy` Examples
The following example is a proxy specification that includes upstreams configuration.
```hcl
sidecar_service {
proxy {
upstreams {
destination_name = "count-api"
local_bind_port = 8080
}
}
}
```
[job]: /docs/job-specification/job.html "Nomad job Job Specification"
[group]: /docs/job-specification/group.html "Nomad group Job Specification"
[task]: /docs/job-specification/task.html "Nomad task Job Specification"
[interpolation]: /docs/runtime/interpolation.html "Nomad interpolation"
[sidecar_service]: /docs/job-specification/sidecar_service.html "Nomad sidecar service Specification"
[upstreams]: /docs/job-specification/upstreams.html "Nomad upstream config Specification"