kubernetes/website

API mirroring annotations not registered or documented

Open

#37,999 创建于 2022年11月21日

在 GitHub 查看
 (10 评论) (0 反应) (1 负责人)HTML (13,918 fork)batch import
help wantedkind/buglanguage/enpriority/backlogsig/architecturesig/nodetriage/accepted

仓库指标

Star
 (4,127 star)
PR 合并指标
 (平均合并 16天 13小时) (30 天内合并 160 个 PR)

描述

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

贡献者指南

研究方向
该问题要求在页面 /docs/reference/labels annotations taints/ 上添加四个注解（kubernetes.io/config.source、kubernetes.io/config.seen、kubernetes.io/config.hash、kubernetes.io/config.mirror）的文档。其权威来源是位于 https://pkg.go.dev/k8s.io/kubernetes/pkg/kubelet/types 的 kubelet 类型。贡献者应查阅 Go 文档以确认这些注解及其取值，然后相应地更新 Markdown 文件。问题评论中的讨论可能提供额外背景信息。
技术栈
无
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75