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

Update annotations-and-labels.mdx

pull/18032/head
David Yu 2023-07-06 11:42:49 -07:00 committed by GitHub
parent 83b84a985a
commit 56d81738cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/content/docs/k8s/annotations-and-labels.mdx
View File

@ -16,7 +16,7 @@ This allows the user to configure natively configure Consul on select Kubernetes
- [Annotations](#annotations) - [Annotations](#annotations)
- [Labels](#labels) - [Labels](#labels)
- [Service Sync](#service-sync) - [Service Sync](#service-sync)
- [Annotations](#service-sync-annotations) - [Annotations](#annotations-1)
The noun _connect_ is used throughout this documentation to refer to the connect The noun _connect_ is used throughout this documentation to refer to the connect
subsystem that provides Consul's service mesh capabilities. subsystem that provides Consul's service mesh capabilities.
@ -288,7 +288,10 @@ Resource labels could be used on a Kubernetes service to control connect-inject
The following Kubernetes resource annotations could be used on a pod to [Service Sync](https://developer.hashicorp.com/consul/docs/k8s/service-sync) behavior: The following Kubernetes resource annotations could be used on a pod to [Service Sync](https://developer.hashicorp.com/consul/docs/k8s/service-sync) behavior:
- `consul.hashicorp.com/service-sync`: If this is set to `true`, then the Kubernetes service is explicitly configured to be synced to Consul. - `consul.hashicorp.com/service-sync`: If this is set to `true`, then the Kubernetes service is explicitly configured to be synced to Consul.
```yaml
annotations:
'consul.hashicorp.com/service-sync': 'true'
```
- `consul.hashicorp.com/service-port`: Configures the port to register to the Consul Catalog for the Kubernetes service. The annotation value may be a name of a port (recommended) or an exact port value. See [service ports](https://developer.hashicorp.com/consul/docs/k8s/service-sync#service-ports) for more information. - `consul.hashicorp.com/service-port`: Configures the port to register to the Consul Catalog for the Kubernetes service. The annotation value may be a name of a port (recommended) or an exact port value. See [service ports](https://developer.hashicorp.com/consul/docs/k8s/service-sync#service-ports) for more information.
```yaml ```yaml
annotations: annotations:
@ -300,7 +303,7 @@ The following Kubernetes resource annotations could be used on a pod to [Service
annotations: annotations:
'consul.hashicorp.com/service-tags': 'primary,foo' 'consul.hashicorp.com/service-tags': 'primary,foo'
``` ```
- `consul.hashicorp.com/service-meta`: A map for specifying service metadata for Consul services. The "KEY" below can be set to any key. This allows setting multiple meta values. - `consul.hashicorp.com/service-meta-KEY`: A map for specifying service metadata for Consul services. The "KEY" below can be set to any key. This allows setting multiple meta values.
```yaml ```yaml
annotations: annotations: