kubernetes/website

API mirroring annotations not registered or documented

Open

#37 999 ouverte le 21 nov. 2022

Voir sur GitHub
 (10 commentaires) (0 réactions) (1 assigné)HTML (13 918 forks)batch import
help wantedkind/buglanguage/enpriority/backlogsig/architecturesig/nodetriage/accepted

Métriques du dépôt

Stars
 (4 127 stars)
Métriques de merge PR
 (Merge moyen 16j 13h) (160 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le problème nécessite d'ajouter la documentation pour les quatre annotations (kubernetes.io/config.source, kubernetes.io/config.seen, kubernetes.io/config.hash, kubernetes.io/config.mirror) à la page /docs/reference/labels annotations taints/. La source de vérité se trouve dans les types kubelet à l'adresse https://pkg.go.dev/k8s.io/kubernetes/pkg/kubelet/types. Le contributeur doit examiner la documentation Go pour confirmer les annotations et leurs valeurs, puis mettre à jour le fichier markdown en conséquence. Les discussions dans les commentaires du problème peuvent fournir un contexte supplémentaire.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75