nomad/website/source/docs/job-specification/sidecar_service.html.md

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
docs	sidecar_service Stanza - Job Specification	docs-job-specification-sidecar-service	The "sidecar_service" stanza allows specifying options for configuring sidecar proxies used in Consul Connect integration

sidecar_service Stanza

Placement	job -> group -> service -> connect -> **sidecar_service**

The sidecar_service stanza allows configuring various options for the sidecar proxy managed by Nomad for Consul Connect integration. It is valid only within the context of a connect stanza.

 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"
         }
     }
   }
 }

sidecar_service Parameters

• tags (array: nil) - Custom Consul service tags for the sidecar service.

• port (string: ) - Port label for sidecar service.

• proxy (proxy: nil) - This is used to configure the sidecar proxy service.

sidecar_service Examples

The following example is a minimal sidecar_service stanza with defaults

  connect {
    sidecar_service {}
  }

The following example includes specifying upstreams.

   sidecar_service {
     proxy {
       upstreams {
         destination_name = "count-api"
         local_bind_port = 8080
       }
     }
   }