github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/job-specification/sidecar_service.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: sidecar_service Stanza - Job Specification
     4  description: |-
     5    The "sidecar_service" stanza allows specifying options for configuring
     6    sidecar proxies used in Consul Connect integration
     7  ---
     8  
     9  # `sidecar_service` Stanza
    10  
    11  <Placement groups={['job', 'group', 'service', 'connect', 'sidecar_service']} />
    12  
    13  The `sidecar_service` stanza allows configuring various options for the sidecar
    14  proxy managed by Nomad for [Consul
    15  Connect](/docs/integrations/consul-connect) integration. It is
    16  valid only within the context of a connect stanza.
    17  
    18  ```hcl
    19  job "countdash" {
    20    datacenters = ["dc1"]
    21  
    22    group "api" {
    23      network {
    24        mode = "bridge"
    25      }
    26  
    27      service {
    28        name = "count-api"
    29        port = "9001"
    30  
    31        connect {
    32          sidecar_service {}
    33        }
    34      }
    35  
    36      task "web" {
    37        driver = "docker"
    38  
    39        config {
    40          image = "hashicorpdev/counter-api:v3"
    41        }
    42      }
    43    }
    44  }
    45  ```
    46  
    47  ## `sidecar_service` Parameters
    48  
    49  - `disable_default_tcp_check` `(bool: false)` - disable the default TCP health
    50    check.
    51  
    52  - `port` `(string: )` - Port label for sidecar service.
    53  
    54  - `proxy` <code>([proxy][]: nil)</code> - This is used to configure the
    55    sidecar proxy service.
    56  
    57  - `tags` <code>(array&lt;string&gt;: nil)</code> - Custom Consul service tags
    58    for the sidecar service.
    59  
    60  ## `sidecar_service` Examples
    61  
    62  The following example is a minimal `sidecar_service` stanza with defaults
    63  
    64  ```hcl
    65    connect {
    66      sidecar_service {}
    67    }
    68  ```
    69  
    70  The following example includes specifying upstreams.
    71  
    72  ```hcl
    73     sidecar_service {
    74       proxy {
    75         upstreams {
    76           destination_name = "count-api"
    77           local_bind_port = 8080
    78         }
    79       }
    80     }
    81  
    82  ```
    83  
    84  [job]: /docs/job-specification/job 'Nomad job Job Specification'
    85  [group]: /docs/job-specification/group 'Nomad group Job Specification'
    86  [task]: /docs/job-specification/task 'Nomad task Job Specification'
    87  [interpolation]: /docs/runtime/interpolation 'Nomad interpolation'
    88  [sidecar_service]: /docs/job-specification/sidecar_service 'Nomad sidecar service Specification'
    89  [proxy]: /docs/job-specification/proxy 'Nomad sidecar proxy config Specification'