From 0ddf013d6c4e7d44c0c6dfff8fe0c56e5c4b6ca5 Mon Sep 17 00:00:00 2001 From: David Yu Date: Thu, 6 Jul 2023 10:57:20 -0700 Subject: [PATCH] Update annotations-and-labels.mdx --- .../docs/k8s/annotations-and-labels.mdx | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/website/content/docs/k8s/annotations-and-labels.mdx b/website/content/docs/k8s/annotations-and-labels.mdx index 784fc3e685a1..a14eb927fadc 100644 --- a/website/content/docs/k8s/annotations-and-labels.mdx +++ b/website/content/docs/k8s/annotations-and-labels.mdx @@ -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