apiVersion: meta/v1
import "k8s.io/apimachinery/pkg/apis/meta/v1"
ObjectMeta {#ObjectMeta}
ObjectMeta 是所有持久化资源(包括用户必须创建的所有对象)都必须具备的元数据。
<hr>
<table> <thead><tr><th>字段</th><th>描述</th></tr></thead> <tbody> <tr> <td><code>annotations</code><br/><em>object</em></td> <td>
annotations(注解)是随资源一起存储的非结构化键值对映射,可由外部工具设置,用于存储和检索任意元数据。
它们不可查询,且在修改对象时应予以保留。更多信息:
https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/annotations
</td>
</tr>
<tr>
<td><code>creationTimestamp</code><br/><em><a href="">Time</a></em></td>
<td>
creationTimestamp 是一个时间戳,表示该对象创建时的服务器时间。不保证在不同操作之间遵循
“happens-before”(先行发生)顺序。客户端不可设置此值。该值采用 RFC3339 格式,并以 UTC
时间表示。由系统自动填充。只读。对于列表类型,该值为 null。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
</td>
</tr>
<tr>
<td><code>deletionGracePeriodSeconds</code><br/><em>integer</em></td>
<td>
该对象在从系统中移除前允许进行优雅终止的秒数。仅在设置了 deletionTimestamp 时才会设置此字段。该值只能被缩短。只读。
</td>
</tr>
<tr>
<td><code>deletionTimestamp</code><br/><em><a href="">Time</a></em></td>
<td>
deletionTimestamp 是该资源将被删除的 RFC 3339 格式日期和时间。当用户请求进行优雅删除(graceful deletion)时,
该字段由服务器设置,客户端无法直接对其进行设置。一旦 finalizers(终结器)列表为空,且时间超过了该字段指定的时间点,
该资源即被视为已删除(即不再出现在资源列表中,也无法通过名称访问)。只要 finalizers 列表中仍有条目,删除操作就会被阻塞。
一旦设置了 deletionTimestamp,该值便不可被取消设置或推迟到更晚的时间点,尽管可以缩短该时间或在到达该时间点之前删除资源。
例如,用户可以请求在 30 秒后删除某个 Pod。kubelet 接收到请求后,会向该 Pod 中的容器发送优雅终止信号。
30 秒后,kubelet 会向容器发送强制终止信号(SIGKILL),并在完成清理工作后将该 Pod 从 API 中移除。
若发生网络分区,该对象可能会在该时间戳之后继续存在,直到管理员或自动化流程确认该资源已完全终止。
如果未设置该字段,则表示未请求对该对象进行优雅删除。该字段在请求优雅删除时由系统自动填充。为只读字段。更多信息请参阅:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
</td>
</tr>
<tr>
<td><code>finalizers</code><br/><em>string array</em><br/><em>patch strategy: merge</em></td>
<td>
在对象从注册表中删除之前,该列表必须为空。列表中的每一项都是一个标识符,指向负责将该项从列表中移除的组件。
如果对象的 deletionTimestamp(删除时间戳)非空,则该列表中的项只能被移除。
终结器(finalizers)的处理和移除顺序不固定;之所以不强制规定顺序,是因为强制排序会带来终结器处理过程陷入停滞(stuck)的重大风险。
finalizers 是一个共享字段,任何拥有相应权限的参与者(actor)都可以对其进行重新排序。
如果按顺序处理终结器列表,可能会出现这样一种情况:负责列表中第一个终结器的组件,
正在等待由负责列表中后续终结器的组件所产生的信号(如字段值、外部系统信号或其他信号),从而导致死锁。
若不强制规定顺序,终结器之间便可自由安排执行次序,且不会因列表顺序的变动而受到影响。
</td>
</tr>
<tr>
<td><code>generateName</code><br/><em>string</em></td>
<td>
generateName 是一个可选的前缀,仅在未提供 Name 字段时由服务器用于生成唯一名称。
如果使用了该字段,返回给客户端的名称将与传入的名称不同;该值会与一个唯一后缀组合使用。
所提供的值遵循与 Name 字段相同的验证规则,且可能会因服务器端确保唯一性所需的后缀长度而被截断。
如果指定了该字段且生成的名称已存在,服务器将返回 409 状态码。仅在未指定 Name 时生效。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
</td>
</tr>
<tr>
<td><code>generation</code><br/><em>integer</em></td>
<td>
表示目标状态特定版本的序列号。由系统填充。只读。
</td>
</tr>
<tr>
<td><code>labels</code><br/><em>object</em></td>
<td>
用于组织和分类(限定范围及筛选)对象的字符串键值对映射。可与 ReplicationController 和 Service 的选择器相匹配。更多信息:
https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/labels
</td>
</tr>
<tr>
<td><code>managedFields</code><br/><em><a href="">ManagedFieldsEntry array</a></em></td>
<td>
managedFields 将工作流 ID(workflow-id)和版本映射到由该工作流管理的字段集合。
这主要用于内部管理,用户通常无需设置或理解该字段。工作流名称可以是用户名、控制器名称,或者是诸如 “ci-cd”
之类的特定应用路径名称。其中的字段集合始终采用该工作流在修改对象时所使用的版本。
</td>
</tr>
<tr>
<td><code>name</code><br/><em>string</em></td>
<td>
name 在命名空间内必须唯一。创建资源时必须指定名称,尽管某些资源允许客户端请求自动生成合适的名称。
名称主要用于确保创建操作的幂等性以及配置定义。名称不可更新。更多信息:
https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/names#names
</td>
</tr>
<tr>
<td><code>namespace</code><br/><em>string</em></td>
<td>
namespace 定义了一个作用域,在该作用域内每个名称必须是唯一的。空的命名空间等同于 "default" 命名空间,但
"default" 是其标准表示形式。并非所有对象都必须归属于某个命名空间——对于此类对象,该字段的值为空。
该值必须符合 DNS_LABEL 规范,且不可更新。更多信息请参阅:
https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/namespaces
</td>
</tr>
<tr>
<td><code>ownerReferences</code><br/><em><a href="">OwnerReference array</a></em><br/><em>patch strategy: merge on key <code>uid</code></em></td>
<td>
该对象所依赖的对象列表。如果列表中的所有对象均已被删除,则该对象将被垃圾回收。
如果该对象由控制器管理,则该列表中会包含指向该控制器的条目,且该条目的 controller 字段会被设为 true。
管理该对象的控制器只能有一个。
</td>
</tr>
<tr>
<td><code>resourceVersion</code><br/><em>string</em></td>
<td>
这是一个代表该对象内部版本的不透明值,客户端可利用它来判断对象是否发生了变更。
该值可用于乐观并发控制、变更检测以及针对单个或一组资源的“监视”(watch)操作。
客户端必须将这些值视为不透明数据,并原样传回服务器。它们可能仅对特定资源或资源集合有效。由系统自动填充。只读。
客户端必须将该值视为不透明数据。更多信息请参阅:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
</td>
</tr>
<tr>
<td><code>selfLink</code><br/><em>string</em></td>
<td>
已弃用:selfLink 是一个旧版只读字段,系统不再对其进行填充。
</td>
</tr>
<tr>
<td><code>uid</code><br/><em>string</em></td>
<td>
UID 是该对象在时间和空间上的唯一标识符。它通常由服务器在资源成功创建时生成,且在执行 PUT 操作时不允许更改。
由系统自动填充。只读。更多信息:https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/names#uids
</td>
</tr>
</tbody> </table>
来源:Kubernetes 文档贡献者 · 作者与贡献记录 · CC BY 4.0。离线整理了版式、链接和媒体显示。
