---
id: "envoy-sidecar"
type: "component"
kind: "service-mesh"
provider: "default"
category: "ops"
docs: "https://www.envoyproxy.io/docs/envoy/latest/intro/deployment_types/service_to_service"
url: "https://localhost:3000/catalogue/components/envoy-sidecar"
---

# Envoy sidecar

Hand-rolled mesh of Envoy sidecars with a custom control plane.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Service mesh](https://localhost:3000/catalogue/kinds/service-mesh) |
| Category | Operations |
| Official docs | [https://www.envoyproxy.io/docs/envoy/latest/intro/deployment_types/service_to_service](https://www.envoyproxy.io/docs/envoy/latest/intro/deployment_types/service_to_service) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `circuitBreaking` | boolean | — | no | false | inherited |
| `controlPlanes` | integer | — | no | — | inherited |
| `managed` | boolean | — | no | false | **false** |
| `mtls` | boolean | — | no | false | **false** |
| `retries` | boolean | — | no | false | **false** |
| `sidecar` | boolean | — | no | true | **true** |
| `xds` | boolean | — | no | true | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 11

- [AWS App Mesh](https://localhost:3000/catalogue/components/aws-app-mesh.md) `aws-app-mesh` — aws
- [Amazon VPC Lattice](https://localhost:3000/catalogue/components/aws-vpc-lattice.md) `aws-vpc-lattice` — aws
- [Cilium](https://localhost:3000/catalogue/components/cilium.md) `cilium` — default
- [Consul Connect](https://localhost:3000/catalogue/components/consul-connect.md) `consul-connect` — default
- [Dapr](https://localhost:3000/catalogue/components/dapr.md) `dapr` — default
- [Istio](https://localhost:3000/catalogue/components/istio.md) `istio` — default
- [Kmesh](https://localhost:3000/catalogue/components/kmesh.md) `kmesh` — default
- [Kuma](https://localhost:3000/catalogue/components/kuma.md) `kuma` — default
- [Linkerd](https://localhost:3000/catalogue/components/linkerd.md) `linkerd` — default
- [Generic service mesh](https://localhost:3000/catalogue/components/service-mesh.md) `service-mesh` — default
- [Cloud Service Mesh](https://localhost:3000/catalogue/components/google-cloud-service-mesh.md) `google-cloud-service-mesh` — gcp

## Use it in a design

```yaml
nodes:
  - { id: "envoy-sidecar", component: "envoy-sidecar" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# Plain Envoy sidecars driven by a custom xDS control plane: nothing on by default.
schemaVersion: "1"
type: "component"
id: "envoy-sidecar"
kind: "service-mesh"
provider: "default"
docs: "https://www.envoyproxy.io/docs/envoy/latest/intro/deployment_types/service_to_service"
defaults:
  managed: false
  sidecar: true
  mtls: false
  retries: false
properties:
  xds:
    type: "boolean"
    default: true
```

Human page: https://localhost:3000/catalogue/components/envoy-sidecar