From 352adf204ce1ea31c1864493b428323f4a0d1c91 Mon Sep 17 00:00:00 2001 From: Sarah Christoff Date: Thu, 20 Jun 2019 14:18:34 -0500 Subject: [PATCH] [docs] update documentation for connect-service-upstreams (#5422) * update documentation for connect-service-upstreams Adds documentation for services, multiple services, and prepared query under connect-service-upstreams annotation. * changing tone of voice * active voice fix * fixing spaces * fixed order, added clarification for multiple upstreams * Update website/source/docs/platform/k8s/connect.html.md Co-Authored-By: s-christoff --- .../source/docs/platform/k8s/connect.html.md | 35 ++++++++++++++++--- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/website/source/docs/platform/k8s/connect.html.md b/website/source/docs/platform/k8s/connect.html.md index 17fdbc476..a9d9ce423 100644 --- a/website/source/docs/platform/k8s/connect.html.md +++ b/website/source/docs/platform/k8s/connect.html.md @@ -174,10 +174,37 @@ Annotations can be used to configure the injection behavior. * `consul.hashicorp.com/connect-service-upstreams` - The list of upstream services that this pod needs to connect to via Connect along with a static - local port to listen for those connections. Example: `db:1234,auth:6789` - will start two local listeners for `db` on port 1234 and `auth` on port - 6789, respectively. The name of the service is the name of the service - registered with Consul. This value defaults to no upstreams. + local port to listen for those connections. + + * Services + + The name of the service is the name of the service registered with Consul. You can optionally specify datacenters with this annotation. + + ```annotations: + "consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter]" + ``` + + * [Prepared Query](https://www.consul.io/docs/connect/proxies.html#upstreams) + + ```annotations: + "consul.hashicorp.com/connect-service-upstreams": "prepared_query:[query name]:[port]" + ```` + + * Multiple Upstreams + + If you would like to specify multiple services or upstreams, delimit them with commas + + ```annotations: + "consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter],[service-name]:[port]:[optional datacenter]" + ``` + + ```annotations: + "consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter],prepared_query:[query name]:[port]" + ``` + + + + * `consul.hashicorp.com/connect-service-protocol` - For pods that will be registered with Consul's [central configuration](/docs/agent/config_entries.html)