github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[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 <sarah.christoff13@gmail.com>
pull/6002/head
Sarah Christoff 2019-06-20 14:18:34 -05:00 committed by GitHub
parent cb80c7ba85
commit 8c821c1260
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
website/source/docs/platform/k8s/connect.html.md
View File

@ -174,10 +174,37 @@ Annotations can be used to configure the injection behavior.
* `consul.hashicorp.com/connect-service-upstreams` - The list of upstream * `consul.hashicorp.com/connect-service-upstreams` - The list of upstream
services that this pod needs to connect to via Connect along with a static 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` local port to listen for those connections.
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 * Services
registered with Consul. This value defaults to no upstreams.
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 * `consul.hashicorp.com/connect-service-protocol` - For pods that will be
registered with Consul's [central configuration](/docs/agent/config_entries.html) registered with Consul's [central configuration](/docs/agent/config_entries.html)