【k8s源码篇】k8s类型定义2之基础设施TypeMeta与ObjectMeta

news/2024/6/3 16:49:56 标签: kubernetes, docker, 容器

揭开 apimachinery metav1 真面目—— API 结构体的基础设施

metav1是"k8s.io/apimachinery/pkg/apis/meta/v1"的重命名

参考： 深入剖析kubernetes的API对象类型定义

  1. metav1.TypeMeta和metav1.ObjectMeta是所有API单体对象的父类；
  2. metav1.TypeMeta和metav1.ListMeta是所有API列表对象的父类；
  3. metav1.TypeMeta才是所有API对象的父类，这也很好理解，毕竟所有的对象都要说明自己是什么类型；

1 | TypeMeta

  • 从代码可以看出，TypeMeta是ObjectKind 接口的实现，
    • 因此ObjectKind 接口是 TypeMeta 的抽象，也就是所有 API 对象 meta 的抽象，也可以称为顶层设计，具体下节在讲
// 代码源自：k8s.io/apimachinery/pkg/apis/meta/v1/types.go
// 来自apimachinery仓库
type TypeMeta struct {
	// Kind is a string value representing the REST resource this object represents.
	// Servers may infer this from the endpoint the client submits requests to.
	// Cannot be updated.
	// In CamelCase.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	// +optional
  // Kind 是一个字符串值，表示此对象所代表的 REST 资源。//服务器可以从客户端向其提交请求的端点推断出这一点。//无法更新。
	Kind string `json:"kind,omitempty" protobuf:"bytes,1,opt,name=kind"`

	// APIVersion defines the versioned schema of this representation of an object.
	// Servers should convert recognized schemas to the latest internal value, and
	// may reject unrecognized values.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	// +optional
  // APIVersion定义对象表示的版本化架构。服务器应将已识别的架构转换为最新的内部值，并且可能会拒绝未识别的值。
	APIVersion string `json:"apiVersion,omitempty" protobuf:"bytes,2,opt,name=apiVersion"`
}

// 代码源自k8s.io/apimachinery/pkg/apis/meta/v1/meta.go

func (obj *TypeMeta) GetObjectKind() schema.ObjectKind { return obj }

// metav1.TypeMeta实现了schema.ObjectKind
// SetGroupVersionKind satisfies the ObjectKind interface for all objects that embed TypeMeta
// 对于所有嵌入 TypeMeta 的对象，SetGroupVersionKind 满足 ObjectKind 接口
func (obj *TypeMeta) SetGroupVersionKind(gvk schema.GroupVersionKind) {
	obj.APIVersion, obj.Kind = gvk.ToAPIVersionAndKind()
}

// GroupVersionKind satisfies the ObjectKind interface for all objects that embed TypeMeta
// 对于所有嵌入 TypeMeta 的对象，GroupVersionKind 满足 ObjectKind 接口
func (obj *TypeMeta) GroupVersionKind() schema.GroupVersionKind {
	return schema.FromAPIVersionAndKind(obj.APIVersion, obj.Kind)
}



// 代码源自k8s.io/apimachinery/pkg/runtime/schema/interfaces.go
// ObjectKind是接口，两个接口函数是GroupVersionKind类型的setter和getter
// 这个接口的作用下一章再介绍
type ObjectKind interface {
    SetGroupVersionKind(kind GroupVersionKind)
    GroupVersionKind() GroupVersionKind
}

2 | ObjectMeta

  • Name是在Namespace空间下唯一
  • ResourceVersion则是同名、同类型对象，同时间下唯一
    • 因为同名对象在不同时间可能会更新、删除再添加
    • 用于比较两个对象谁比较新的情况
  • SelfLink 对象的URL，由系统生成
// 代码源自：k8s.io/apimachinery/pkg/apis/meta/v1/types.go
// 同样来自apimachinery仓库，ObjectMeta是xxx.yaml中metadata字段，平时我们填写的metadata
// 一般只有name、label，其实ObjectMeta字段还是有很多内容了，让笔者逐一介绍一下。
type ObjectMeta struct {
    // 对象的名字应该不用介绍了。
    Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`
    // 如果Name为空，系统这为该对象生成一个唯一的名字。
    GenerateName string `json:"generateName,omitempty" protobuf:"bytes,2,opt,name=generateName"`
    // 命名空间，在平时学习、调试的时候很少用，但是在发布的时候会经常用。
    Namespace string `json:"namespace,omitempty" protobuf:"bytes,3,opt,name=namespace"`
    // 对象的URL，由系统生成。
    SelfLink string `json:"selfLink,omitempty" protobuf:"bytes,4,opt,name=selfLink"`
    // 对象的唯一ID，由系统生成。
    UID types.UID `json:"uid,omitempty" protobuf:"bytes,5,opt,name=uid,casttype=k8s.io/kubernetes/pkg/types.UID"`
    // 资源版本，这是一个非常有意思且变量，版本可以理解为对象在时间轴上的一个时间节点，代表着对象最后
    // 一次更新的时刻。如果说Name是在Namespace空间下唯一，那么ResourceVersion则是同名、同类型
    // 对象时间下唯一。因为同名对象在不同时间可能会更新、删除再添加，在比较两个对象谁比较新的情况
    // 非常有用，比如Watch。
    ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,6,opt,name=resourceVersion"`
    // 笔者很少关注这个值，所以也不太了解是干什么的，读者感兴趣可以自己了解一下。
    Generation int64 `json:"generation,omitempty" protobuf:"varint,7,opt,name=generation"`
    // 对象创建时间，由系统生成。
    CreationTimestamp Time `json:"creationTimestamp,omitempty" protobuf:"bytes,8,opt,name=creationTimestamp"`
    // 对象删除时间，指针类型说明是可选的，当指针不为空的时候说明对象被删除了，也是由系统生成
    DeletionTimestamp *Time `json:"deletionTimestamp,omitempty" protobuf:"bytes,9,opt,name=deletionTimestamp"`
    // 对象被删除前允许优雅结束的时间，单位为秒。
    DeletionGracePeriodSeconds *int64 `json:"deletionGracePeriodSeconds,omitempty" protobuf:"varint,10,opt,name=deletionGracePeriodSeconds"`
    // 对象标签，这个是我们经常用的，不用多解释了
    Labels map[string]string `json:"labels,omitempty" protobuf:"bytes,11,rep,name=labels"`
    // 批注，这个和标签很像，但是用法不同，比如可以用来做配置。
    Annotations map[string]string `json:"annotations,omitempty" protobuf:"bytes,12,rep,name=annotations"`
    // 该对象依赖的对象类表，如果这些依赖对象全部被删除了，那么该对象也会被回收。如果该对象对象被
    // 某一controller管理，那么类表中有一条就是指向这个controller的。例如Deployment对象的
    // OwnerReferences有一条就是指向DeploymentController的。
    OwnerReferences []OwnerReference `json:"ownerReferences,omitempty" patchStrategy:"merge" patchMergeKey:"uid" protobuf:"bytes,13,rep,name=ownerReferences"`
    // 下面这几个变量笔者没有了解过，等笔者知道了再来更新文章吧。
  	// 表示删除前需要做什么清理操作，若DeletionTimestamp被设置时间，同时Finalizers不为空
    // 那么相应控制器将会检测到 Finalizers 中有自己设置的标签，就会做清理工作，做完清理掉自己设置的标签
    Finalizers []string `json:"finalizers,omitempty" patchStrategy:"merge" protobuf:"bytes,14,rep,name=finalizers"`
    ClusterName string `json:"clusterName,omitempty" protobuf:"bytes,15,opt,name=clusterName"`
    ManagedFields []ManagedFieldsEntry `json:"managedFields,omitempty" protobuf:"bytes,17,rep,name=managedFields"`
}
 
// 代码源自k8s.io/apimachinery/pkg/apis/meta/v1/meta.go，GetObjectMeta是MetaAccessor
// 的接口函数，这个函数说明了ObjectMeta实现了MetaAccessor。
func (obj *ObjectMeta) GetObjectMeta() Object { return obj }
 
// 下面所有的函数是接口Object的ObjectMeta实现，可以看出来基本就是setter/getter方法。纳尼？
// 又一个Object(这个Object是metav1.Object，本章节简写为Object)?Object是API对象公共属性
// (meta信息)的抽象，下面的函数是Object所有函数的实现，因为功能比较简单，笔者就不一一注释了。
func (meta *ObjectMeta) GetNamespace() string                { return meta.Namespace }
func (meta *ObjectMeta) SetNamespace(namespace string)       { meta.Namespace = namespace }
func (meta *ObjectMeta) GetName() string                     { return meta.Name }
func (meta *ObjectMeta) SetName(name string)                 { meta.Name = name }
func (meta *ObjectMeta) GetGenerateName() string             { return meta.GenerateName }
func (meta *ObjectMeta) SetGenerateName(generateName string) { meta.GenerateName = generateName }
func (meta *ObjectMeta) GetUID() types.UID                   { return meta.UID }
func (meta *ObjectMeta) SetUID(uid types.UID)                { meta.UID = uid }
func (meta *ObjectMeta) GetResourceVersion() string          { return meta.ResourceVersion }
func (meta *ObjectMeta) SetResourceVersion(version string)   { meta.ResourceVersion = version }
func (meta *ObjectMeta) GetGeneration() int64                { return meta.Generation }
func (meta *ObjectMeta) SetGeneration(generation int64)      { meta.Generation = generation }
func (meta *ObjectMeta) GetSelfLink() string                 { return meta.SelfLink }
func (meta *ObjectMeta) SetSelfLink(selfLink string)         { meta.SelfLink = selfLink }
func (meta *ObjectMeta) GetCreationTimestamp() Time          { return meta.CreationTimestamp }
func (meta *ObjectMeta) SetCreationTimestamp(creationTimestamp Time) {
    meta.CreationTimestamp = creationTimestamp
}
func (meta *ObjectMeta) GetDeletionTimestamp() *Time { return meta.DeletionTimestamp }
func (meta *ObjectMeta) SetDeletionTimestamp(deletionTimestamp *Time) {
    meta.DeletionTimestamp = deletionTimestamp
}
func (meta *ObjectMeta) GetDeletionGracePeriodSeconds() *int64 { return meta.DeletionGracePeriodSeconds }
func (meta *ObjectMeta) SetDeletionGracePeriodSeconds(deletionGracePeriodSeconds *int64) {
    meta.DeletionGracePeriodSeconds = deletionGracePeriodSeconds
}
func (meta *ObjectMeta) GetLabels() map[string]string                 { return meta.Labels }
func (meta *ObjectMeta) SetLabels(labels map[string]string)           { meta.Labels = labels }
func (meta *ObjectMeta) GetAnnotations() map[string]string            { return meta.Annotations }
func (meta *ObjectMeta) SetAnnotations(annotations map[string]string) { meta.Annotations = annotations }
func (meta *ObjectMeta) GetFinalizers() []string                      { return meta.Finalizers }
func (meta *ObjectMeta) SetFinalizers(finalizers []string)            { meta.Finalizers = finalizers }
func (meta *ObjectMeta) GetOwnerReferences() []OwnerReference         { return meta.OwnerReferences }
func (meta *ObjectMeta) SetOwnerReferences(references []OwnerReference) {
    meta.OwnerReferences = references
}
func (meta *ObjectMeta) GetClusterName() string                 { return meta.ClusterName }
func (meta *ObjectMeta) SetClusterName(clusterName string)      { meta.ClusterName = clusterName }
func (meta *ObjectMeta) GetManagedFields() []ManagedFieldsEntry { return meta.ManagedFields }
func (meta *ObjectMeta) SetManagedFields(managedFields []ManagedFieldsEntry) {
    meta.ManagedFields = managedFields
}

3 | ListMeta

// 代码源自：k8s.io/apimachinery/pkg/apis/meta/v1/types.go
type ListMeta struct {
    // 下面这两个变量在ObjectMeta相同，不多解释
    SelfLink string `json:"selfLink,omitempty" protobuf:"bytes,1,opt,name=selfLink"`
    ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,2,opt,name=resourceVersion"`
    // 在列举对象的时候可能会有非常多的对象，kubernetes支持分页获取，类似于SQL的limit，当对象总量
    // 多于单页的总量的时候，这个变量就会被设置。它用来告知用户需要继续获取，并且它包含了下次获取的
    // 起始位置。
    Continue string `json:"continue,omitempty" protobuf:"bytes,3,opt,name=continue"`
    // 从字面意思也能理解，就是还剩多少个对象，这个和Continue是配合使用的，当Continue被设置了
    // 这个变量就不会为空，用来告诉用户还有多少对象没有获取。
    RemainingItemCount *int64 `json:"remainingItemCount,omitempty" protobuf:"bytes,4,opt,name=remainingItemCount"`
}
 
// 代码源自k8s.io/apimachinery/pkg/apis/meta/v1/meta.go
// 下面所有的函数是接口ListInterface的ListMeta实现，ListInterface是API对象列表公共属性(meta)
// 的抽象。
func (meta *ListMeta) GetResourceVersion() string        { return meta.ResourceVersion }
func (meta *ListMeta) SetResourceVersion(version string) { meta.ResourceVersion = version }
func (meta *ListMeta) GetSelfLink() string               { return meta.SelfLink }
func (meta *ListMeta) SetSelfLink(selfLink string)       { meta.SelfLink = selfLink }
func (meta *ListMeta) GetContinue() string               { return meta.Continue }
func (meta *ListMeta) SetContinue(c string)              { meta.Continue = c }
func (meta *ListMeta) GetRemainingItemCount() *int64     { return meta.RemainingItemCount }
func (meta *ListMeta) SetRemainingItemCount(c *int64)    { meta.RemainingItemCount = c }

4 | Object/Listmeta接口——公共属性的抽象

  • 在metav1包中，为API单体对象和对象列表的公共属性(meta)做了抽象，分别为metav1.Object和 metav1.ListInterface 两个接口
  • 抽象的实现：metav1包为这两个抽象做了实现，他们分别为metav1.ObjectMeta和metav1.ListMeta（就是上面的两个部分）
    • 所以说为什么所有 API 单体对象都要继承 metav1.ObjectMeta
      • 因为继承后，该 API 对象就可以用 Object 接口接收
    • 所有 API 列表对象都要继承 metav1.ListMeta
      • 因为继承后，该 API 对象就可以用 ListMeta接口接收
  • API 对象结构体的基础设施：因此可以将此两者理解为 基础设施，所有要创建的 API 对象或列表都要包含
    • 另外 TypeMeta 别忘了，所有类型都需要
    • 所以说 apimachinery 包可称之为“API 类型构建的基础设施”
// k8s.io/apimachinery@v0.20.2/pkg/apis/meta/v1/meta.go
// Object lets you work with object metadata from any of the versioned or
// internal API objects. Attempting to set or retrieve a field on an object that does
// not support that field (Name, UID, Namespace on lists) will be a no-op and return
// a default value.
type Object interface {
	GetNamespace() string
	SetNamespace(namespace string)
	GetName() string
	SetName(name string)
	GetGenerateName() string
	SetGenerateName(name string)
	GetUID() types.UID
	SetUID(uid types.UID)
	GetResourceVersion() string
	SetResourceVersion(version string)
	GetGeneration() int64
	SetGeneration(generation int64)
	GetSelfLink() string
	SetSelfLink(selfLink string)
	GetCreationTimestamp() Time
	SetCreationTimestamp(timestamp Time)
	GetDeletionTimestamp() *Time
	SetDeletionTimestamp(timestamp *Time)
	GetDeletionGracePeriodSeconds() *int64
	SetDeletionGracePeriodSeconds(*int64)
	GetLabels() map[string]string
	SetLabels(labels map[string]string)
	GetAnnotations() map[string]string
	SetAnnotations(annotations map[string]string)
	GetFinalizers() []string
	SetFinalizers(finalizers []string)
	GetOwnerReferences() []OwnerReference
	SetOwnerReferences([]OwnerReference)
	GetClusterName() string
	SetClusterName(clusterName string)
	GetManagedFields() []ManagedFieldsEntry
	SetManagedFields(managedFields []ManagedFieldsEntry)
}

// ListInterface lets you work with list metadata from any of the versioned or
// internal API objects. Attempting to set or retrieve a field on an object that does
// not support that field will be a no-op and return a default value.
// TODO: move this, and TypeMeta and ListMeta, to a different package
type ListInterface interface {
	GetResourceVersion() string
	SetResourceVersion(version string)
	GetSelfLink() string
	SetSelfLink(selfLink string)
	GetContinue() string
	SetContinue(c string)
	GetRemainingItemCount() *int64
	SetRemainingItemCount(c *int64)
}

http://www.niftyadmin.cn/n/1794495.html

相关文章

以boost::function和boost:bind取代虚函数

以boost::function和boost:bind取代虚函数

转自：http://blog.csdn.net/Solstice/archive/2008/10/13/3066268.aspx 这是一篇比较情绪化的blog，中心思想是“继承就像一条贼船，上去就下不来了”，而借助boost::function和boost::bind，大多数情况下，你都…
阅读更多...
【k8s源码篇】k8s类型定义3之顶层设计runtime.Object接口

【k8s源码篇】k8s类型定义3之顶层设计runtime.Object接口

揭开apimachinery runtime 的秘密 参考：深入剖析kubernetes的API对象类型定义 1 | schema 上一节我们学习到 metav1.TypeMeta 就是 sechema.ObjectKind 接口的实现 回顾 metav1.TypeMeta 结构体 type TypeMeta struct {// Kind 是一个字符串值，表示此…
阅读更多...
【wp】百度杯2017年春秋欢乐赛

【wp】百度杯2017年春秋欢乐赛

|0x01 小电影 |0x02 水果宴 |0x03 内涵图 百度杯”2017年春秋欢乐赛 第一场 ---0x01 小电影 分值：50分 类型：Misc已解答 题目：我说过这次比赛是让大家开开心心的度过的所以送给你们一个小电影 附件下载:ht去除tp://static2.ichunqiu.com/icq…
阅读更多...
textbox显示定位到最后一行（最新一行）

textbox显示定位到最后一行（最新一行）

this.textBox1.Select(this.txtMsgInfo.TextLength, 0); this.textBox1.ScrollToCaret();转载于:https://www.cnblogs.com/pnljs/p/3746339.html
阅读更多...
【k8s源码篇】k8s数据访问1之接口定义

【k8s源码篇】k8s数据访问1之接口定义

参考 K8s源码分析(12)-资源的数据访问层K8s源码分析(13)-资源的服务层接口定义 资源的数据 1 | 资源的数据访问层 1.1 | etcd 访问 众所周知，kubernetes 所有资源都是存储在 etcd clsuter 中的，它是一个典型的分布式 kv 数据库，提供存储…
阅读更多...
微服务工程消费dubbo服务的配置

微服务工程消费dubbo服务的配置

1. 应用场景微服务工程，按规范不做xml文件的配置，同时需要调用其他工程提供的dubbo服务2. 接口引入方式l Jar包引入方式通过maven pom文件，引入其他工程的api jar包。 （适用于微服务工程且提供dubbo服务）引入jar包后&a…
阅读更多...
jQuery几个易混淆之处（参考《众妙之门》及相关博客）

jQuery几个易混淆之处（参考《众妙之门》及相关博客）

parent() && parents() && closest() 这三个方法都与沿着DOM向上导航有关，在由选择器返回的元素上方，匹配父元素或之前的祖先元素，但是每个方法都有各自独特之处： 1. parent() 只匹配元素的直接父元素&#xff0…
阅读更多...
【k8s源码篇】k8s数据访问2之接口实现

【k8s源码篇】k8s数据访问2之接口实现

参考 K8s源码分析(14)-资源的服务层接口实现 K8s源码分析(15)-资源的服务层策略接口实现 接口实现 1 | 资源的服务层接口实现（增删改查类） 上一篇文章中，我们主要介绍了 kubernetes 中资源的服务层接口定义，包括增删改查类接…
阅读更多...
最新文章

Copyright @ 2022~2023