From d5005719c050e2111a7fa22c6700ddb630948afd Mon Sep 17 00:00:00 2001 From: Blake Covarrubias Date: Wed, 24 Jan 2024 09:35:03 -0800 Subject: [PATCH] docs: Fix example service registration for built-in proxy Fix the sample service registration for the built-in proxy by adding the missing `sidecar_service` block. --- .../consul-ui/mock-api/v1/agent/services | 18 +++++----- .../content/docs/connect/proxies/built-in.mdx | 34 ++++++++++--------- 2 files changed, 28 insertions(+), 24 deletions(-) diff --git a/ui/packages/consul-ui/mock-api/v1/agent/services b/ui/packages/consul-ui/mock-api/v1/agent/services index 6397b362e9..9a7f5b4278 100644 --- a/ui/packages/consul-ui/mock-api/v1/agent/services +++ b/ui/packages/consul-ui/mock-api/v1/agent/services @@ -12,14 +12,16 @@ "ModifyIndex": 0, "ProxyDestination": "", "Connect": { - "Proxy": { - "ExecMode": "daemon", - "Command": [ - "/bin/consul", - "connect", - "proxy" - ], - "Config": null + "SidecarService": { + "Proxy": { + "ExecMode": "daemon", + "Command": [ + "/bin/consul", + "connect", + "proxy" + ], + "Config": null + } } } }, diff --git a/website/content/docs/connect/proxies/built-in.mdx b/website/content/docs/connect/proxies/built-in.mdx index 284bfa9035..93ec90bcb4 100644 --- a/website/content/docs/connect/proxies/built-in.mdx +++ b/website/content/docs/connect/proxies/built-in.mdx @@ -24,23 +24,25 @@ for the built-in proxy. "service": { "name": "example-service", "connect": { - "proxy": { - "config": { - "bind_address": "0.0.0.0", - "bind_port": 20000, - "local_service_address": "127.0.0.1:1234", - "local_connect_timeout_ms": 1000, - "handshake_timeout_ms": 10000, - "upstreams": [] - }, - "upstreams": [ - { - "destination_name": "example-upstream", - "config": { - "connect_timeout_ms": 1000 + "sidecar_service": { + "proxy": { + "config": { + "bind_address": "0.0.0.0", + "bind_port": 20000, + "local_service_address": "127.0.0.1:1234", + "local_connect_timeout_ms": 1000, + "handshake_timeout_ms": 10000, + "upstreams": [] + }, + "upstreams": [ + { + "destination_name": "example-upstream", + "config": { + "connect_timeout_ms": 1000 + } } - } - ] + ] + } } } }