kubernetes / kubernetes/website

API mirroring annotations not registered or documented

Open
#37,999 10 comments 0 reactions 1 assignee Claimed by @vaibhav2107 View on GitHub
help wanted kind/bug language/en priority/backlog sig/architecture sig/node triage/accepted
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

**This is a Bug Report**

**Problem:**
Kubernetes sets up to ~three~ four annotations when mirroring a resource (for example, a [mirror pod](https://kubernetes.io/docs/concepts/workloads/pods/#static-pods)). These are:

- `kubernetes.io/config.source`
- `kubernetes.io/config.seen`
- `kubernetes.io/config.hash`
- `kubernetes.io/config.mirror`

However, those annotations are not documented in
https://kubernetes.io/docs/reference/labels-annotations-taints/

**Proposed Solution:**
Document those annotations.

**Page to Update:**
https://kubernetes.io/docs/reference/labels-annotations-taints/

**Additional Information:**
See https://pkg.go.dev/k8s.io/kubernetes/pkg/kubelet/types for more details on the values that the kubelet sets for `kubernetes.io/config.source`. I don't think we promise that the kubelet is the only thing that ever sets this annotation, though.

/sig architecture
/sig node
/language en

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.