kubernetes/website

API mirroring annotations not registered or documented

Open

#37.999 aperta il 21 nov 2022

Vedi su GitHub
 (10 commenti) (0 reazioni) (1 assegnatario)HTML (13.918 fork)batch import
help wantedkind/buglanguage/enpriority/backlogsig/architecturesig/nodetriage/accepted

Metriche repository

Star
 (4127 star)
Metriche merge PR
 (Merge medio 16g 13h) (160 PR mergiate in 30 g)

Descrizione

This is a Bug Report

Problem: Kubernetes sets up to three four annotations when mirroring a resource (for example, a mirror pod). 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

Guida contributor

Direzione di ricerca
Il problema richiede di aggiungere la documentazione per le quattro annotazioni (kubernetes.io/config.source, kubernetes.io/config.seen, kubernetes.io/config.hash, kubernetes.io/config.mirror) alla pagina /docs/reference/labels annotations taints/. La fonte di verità sono i tipi kubelet all'indirizzo https://pkg.go.dev/k8s.io/kubernetes/pkg/kubelet/types. Il contributore dovrebbe esaminare la documentazione Go per confermare le annotazioni e i loro valori, quindi aggiornare di conseguenza il file markdown. Le discussioni nei commenti del problema potrebbero fornire ulteriore contesto.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75