annotation

A key-value note attached to a Kubernetes object that tools read for extra configuration.

In more detail

Unlike labels, annotations are not used to select objects; they carry settings for controllers and tools. Values can be long strings, such as timeouts or the name of a certificate issuer.

Examples

nginx.ingress.kubernetes.io/proxy-read-timeout: "3600" keeps slow streams open
cert-manager.io/cluster-issuer: letsencrypt-prod
kubectl -n kube-system get pod "$pod" -o jsonpath='{.metadata.annotations.kubernetes\.io/config\.source}'

Related terms

Taught in

References

Certification courses