Skip to content

Commit

Permalink
adding more clarity around sidecar volume annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
David Yu authored Jul 22, 2022
1 parent c6cf5c0 commit 7e16739
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/content/docs/k8s/annotations-and-labels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ The following Kubernetes resource annotations could be used on a pod to control
- `consul.hashicorp.com/service-metrics-port` - Set the port where the Connect service exposes metrics.
- `consul.hashicorp.com/service-metrics-path` - Set the path where the Connect service exposes metrics.
- `consul.hashicorp.com/connect-inject-mount-volume` - Comma separated list of container names to mount the connect-inject volume into. The volume will be mounted at `/consul/connect-inject`. The connect-inject volume contains Consul internals data needed by the other sidecar containers, for example the `consul` binary, and the Pod's Consul ACL token. This data can be valuable for advanced use-cases, such as making requests to the Consul API from within application containers.
- `consul.hashicorp.com/consul-sidecar-user-volume` - JSON objects that define volumes to add to the Envoy sidecar.
- `consul.hashicorp.com/consul-sidecar-user-volume-mount` - JSON objects that define volumeMounts to add to the Envoy sidecar.
- `consul.hashicorp.com/consul-sidecar-user-volume` - JSON objects as specified by the [Volume pod spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#volume-v1-core), that define volumes to add to the Envoy sidecar. For example, the JSON object for a volume with the name `secrets-data` and the hostPath `/mnt/secrets-path` is as follows: `"[{\"name\": \"secrets-data\", \"hostPath\": "[{\"path\": \"/mnt/secrets-path\"}] "}]"`
- `consul.hashicorp.com/consul-sidecar-user-volume-mount` - JSON objects as specified by the [Volume mount pod spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#volumemount-v1-core), that define volumeMounts to add to the Envoy sidecar. For example, the JSON object for a volume mount with the name `secrets-store-mount` and the mountPath `/mnt/secrets-store` is as follows: `"[{\"name\": \"secrets-store-mount\", \"mountPath\": \"/mnt/secrets-store\"}]"`

## Labels

Expand Down

0 comments on commit 7e16739

Please sign in to comment.