Skip to content

Commit

Permalink
Update annotations-and-labels.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
David Yu committed Jul 6, 2023
1 parent b9cfc86 commit 0ddf013
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions website/content/docs/k8s/annotations-and-labels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -265,11 +265,29 @@ The following Kubernetes resource annotations could be used on a pod to control
"consul.hashicorp.com/consul-sidecar-user-volume-mount": "[{\"name\": \"secrets-store-mount\", \"mountPath\": \"/mnt/secrets-store\"}]"
```

## Consul Catalog Sync anntoations
## Service Sync annotations

The following Kubernetes resource annotations could be used on a pod to [Catalog 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-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
annotations:
'consul.hashicorp.com/service-port': 'http'
```
- 'consul.hashicorp.com/service-tags': A comma separated list of strings (without whitespace) to use for registering tags to the service registered to Consul. These custom tags automatically include the `k8s` tag which can't be disabled.

```yaml
annotations:
'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.

```yaml
annotations:
'consul.hashicorp.com/service-meta-KEY': 'value'
```
- `consul.hashicorp.com/service-weight:` - Configure ability to support weighted loadbalancing by service annotation for Catalog Sync. The integer provided will be applied as a weight for the `passing` state for the health of the service. See [weights](/consul/docs/services/configuration/services-configuration-reference#weights) in service configuration for more information on how this is leveraged for services in the Consul catalog.

```yaml
Expand Down

0 comments on commit 0ddf013

Please sign in to comment.