luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Merge pull request #6583 from hashicorp/connect-annotations 

Document new annotations for Connect injections
This commit is contained in:
Luke Kysow 2019-10-31 12:58:43 -07:00 committed by GitHub
parent 48ba388ec9 9093b99dfd
commit db2ca07f98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -202,13 +202,15 @@ Annotations can be used to configure the injection behavior.
The name of the service is the name of the service registered with Consul. You can optionally specify datacenters with this annotation. The name of the service is the name of the service registered with Consul. You can optionally specify datacenters with this annotation.
```annotations: ```yaml
annotations:
"consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter]" "consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter]"
``` ```
* [Prepared Query](https://www.consul.io/docs/connect/proxies.html#upstreams) * [Prepared Query](https://www.consul.io/docs/connect/proxies.html#upstreams)
```annotations: ```yaml
annotations:
"consul.hashicorp.com/connect-service-upstreams": "prepared_query:[query name]:[port]" "consul.hashicorp.com/connect-service-upstreams": "prepared_query:[query name]:[port]"
```` ````
@ -216,18 +218,16 @@ Annotations can be used to configure the injection behavior.
If you would like to specify multiple services or upstreams, delimit them with commas If you would like to specify multiple services or upstreams, delimit them with commas
```annotations: ```yaml
annotations:
"consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter],[service-name]:[port]:[optional datacenter]" "consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter],[service-name]:[port]:[optional datacenter]"
``` ```
```annotations: ```yaml
annotations:
"consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter],prepared_query:[query name]:[port]" "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)
feature, information about the protocol the service uses is required. Users feature, information about the protocol the service uses is required. Users
@ -236,6 +236,24 @@ Annotations can be used to configure the injection behavior.
[defaultProtocol](/docs/platform/k8s/helm.html#v-connectinject-centralconfig-defaultprotocol) [defaultProtocol](/docs/platform/k8s/helm.html#v-connectinject-centralconfig-defaultprotocol)
option. Specific annotations will always override the default value. option. Specific annotations will always override the default value.
* `consul.hashicorp.com/service-tags` - A comma separated list of tags that will
be applied to the Consul service and its sidecar.
```yaml
annotations:
consul.hashicorp.com/service-tags: foo,bar,baz
```
* `consul.hashicorp.com/service-meta-<YOUR_KEY>` - Set Consul meta key/value
pairs that will be applied to the Consul service and its sidecar.
The key will be what comes after `consul.hashicorp.com/service-meta-`, e.g.
`consul.hashicorp.com/service-meta-foo: bar` will result in `foo: bar`.
```yaml
annotations:
consul.hashicorp.com/service-meta-foo: baz
consul.hashicorp.com/service-meta-bar: baz
```
### Deployments, StatefulSets, etc. ### Deployments, StatefulSets, etc.