K8s源码分析(17)-资源API数据结构的创建

在上一篇文章里，我们主要介绍了 kubernetes 中资源 API 的具体数据结构，其中包括结构体 APIGroupInfo 代表了某一个组中所有版本资源的 API 信息具体数据结构，结构体 APIGroupVersion 代表了某一个组中的某一个版本里所有资源的 API 信息的具体数据结构，APIInstaller 结构体用来辅助资源 API 的注册。在本篇文章里我们主要来介绍结构体 APIGroupInfo 的创建。

根据以前文章，kubernetes 的资源分为核心组资源和非核心组资源。核心组资源，例如我们常见的 pod，service, endpoint, node 等资源对象实例。非核心组资源，例如我们常见的 deployment，statefulset， daemonset 等资源对象实例。同样，根据上文的介绍， 结构体 APIGroupVersion 代表了某一个组中的某一个版本里所有资源的 API 信息数据。那么一定会有非核心资源组的 APIGroupVersion 结构体和核心资源组的 APIGroupVersion 结构体。下面我们来介绍这两种类型结构体创建的过程。

非核心资源组 APIGroupInfo 的创建

对于非核心资源组 APIGroupInfo 结构体的创建，这里我们以 apps 资源组为例子。在 pkg/registry/${group}/rest/storage_${group} 这个源文件中进行创建：

//  pkg/registry/apps/rest/storage_apps.go
type StorageProvider struct{}


func (p StorageProvider) NewRESTStorage(apiResourceConfigSource serverstorage.APIResourceConfigSource, restOptionsGetter generic.RESTOptionsGetter) (genericapiserver.APIGroupInfo, bool, error) {
  apiGroupInfo := genericapiserver.NewDefaultAPIGroupInfo(apps.GroupName, legacyscheme.Scheme, legacyscheme.ParameterCodec, legacyscheme.Codecs)


  if apiResourceConfigSource.VersionEnabled(appsapiv1.SchemeGroupVersion) {
    storageMap, err := p.v1Storage(apiResourceConfigSource, restOptionsGetter)
    if err != nil {
      return genericapiserver.APIGroupInfo{}, false, err
    }
    apiGroupInfo.VersionedResourcesStorageMap[appsapiv1.SchemeGroupVersion.Version] = storageMap
  }


  return apiGroupInfo, true, nil
}


func (p StorageProvider) v1Storage(apiResourceConfigSource serverstorage.APIResourceConfigSource, restOptionsGetter generic.RESTOptionsGetter) (map[string]rest.Storage, error) {
  storage := map[string]rest.Storage{}


  // deployments
  deploymentStorage, err := deploymentstore.NewStorage(restOptionsGetter)
  if err != nil {
    return storage, err
  }
  storage["deployments"] = deploymentStorage.Deployment
  storage["deployments/status"] = deploymentStorage.Status
  storage["deployments/scale"] = deploymentStorage.Scale


  // statefulsets
  statefulSetStorage, err := statefulsetstore.NewStorage(restOptionsGetter)
  if err != nil {
    return storage, err
  }
  storage["statefulsets"] = statefulSetStorage.StatefulSet
  storage["statefulsets/status"] = statefulSetStorage.Status
  storage["statefulsets/scale"] = statefulSetStorage.Scale


  // daemonsets
  daemonSetStorage, daemonSetStatusStorage, err := daemonsetstore.NewREST(restOptionsGetter)
  if err != nil {
    return storage, err
  }
  storage["daemonsets"] = daemonSetStorage
  storage["daemonsets/status"] = daemonSetStatusStorage


  // replicasets
  replicaSetStorage, err := replicasetstore.NewStorage(restOptionsGetter)
  if err != nil {
    return storage, err
  }
  storage["replicasets"] = replicaSetStorage.ReplicaSet
  storage["replicasets/status"] = replicaSetStorage.Status
  storage["replicasets/scale"] = replicaSetStorage.Scale


  // controllerrevisions
  historyStorage, err := controllerrevisionsstore.NewREST(restOptionsGetter)
  if err != nil {
    return storage, err
  }
  storage["controllerrevisions"] = historyStorage


  return storage, nil
}

• 源文件中定义结构体 StorageProvider 用来实现 APIGroupInfo 的创建逻辑。

• StorageProvider 结构体中定义了具体方法 NewRESTStorage()， 这个方法主要用来创建 APIGroupInfo 结构体实例，同时根据是否开启不同版本的配置来调用子方法，生成不同版本资源的 API 信息。

• 对于每个版本的资源，映射资源名称和资源操作类的关系。

• 资源的名称格式统一定义为 ${resource-name} 或者是 ${resource-name}/${sub-resource-name}。例如， 在我们这里把 deployments 定义为资源的具体名称，deployment/status 做为该资源的 status 子资源。同时这个格式也是将来该资源注册的 REST API 的访问路径。

• 资源操作类为以前文章介绍的 Storage 类型的实现。

核心资源组 APIGroupInfo 的创建

对于核心资源组 APIGroupInfo 结构体创建，在 pkg/registry/core/rest/storage_core.go 源码文件中定义：

// pkg/registry/core/rest/storage_core.go
type LegacyRESTStorageProvider struct {
     ......
}


func (c LegacyRESTStorageProvider) NewLegacyRESTStorage(restOptionsGetter generic.RESTOptionsGetter) (LegacyRESTStorage, genericapiserver.APIGroupInfo, error){
  apiGroupInfo := genericapiserver.APIGroupInfo{
    PrioritizedVersions:          legacyscheme.Scheme.PrioritizedVersionsForGroup(""),
    VersionedResourcesStorageMap: map[string]map[string]rest.Storage{},
    Scheme:                       legacyscheme.Scheme,
    ParameterCodec:               legacyscheme.ParameterCodec,
    NegotiatedSerializer:         legacyscheme.Codecs,
  }
                ......
   podTemplateStorage, err := podtemplatestore.NewREST(restOptionsGetter)
  if err != nil {
    return LegacyRESTStorage{}, genericapiserver.APIGroupInfo{}, err
  }


  eventStorage, err := eventstore.NewREST(restOptionsGetter, uint64(c.EventTTL.Seconds()))
  if err != nil {
    return LegacyRESTStorage{}, genericapiserver.APIGroupInfo{}, err
  }
  limitRangeStorage, err := limitrangestore.NewREST(restOptionsGetter)
  if err != nil {
    return LegacyRESTStorage{}, genericapiserver.APIGroupInfo{}, err
  }
                ......
  restStorageMap := map[string]rest.Storage{
    "pods":             podStorage.Pod,
    "pods/attach":      podStorage.Attach,
    "pods/status":      podStorage.Status,
    "pods/log":         podStorage.Log,
    "pods/exec":        podStorage.Exec,
    "pods/portforward": podStorage.PortForward,
    "pods/proxy":       podStorage.Proxy,
    "pods/binding":     podStorage.Binding,
    "bindings":         podStorage.LegacyBinding,


    "podTemplates": podTemplateStorage,


    "replicationControllers":        controllerStorage.Controller,
    "replicationControllers/status": controllerStorage.Status,


    "services":        serviceRest,
    "services/proxy":  serviceRestProxy,
    "services/status": serviceStatusStorage,


    "endpoints": endpointsStorage,


    "nodes":        nodeStorage.Node,
                  ......
  }
  ......
}

• 定义结构体 LegacyRESTStorageProvider 主要用来实现 APIGroupInfo 的创建逻辑。

• 该结构体的 NewLegacyRESTStorage() 方法创建 APIGroupInfo 实例， 代表核心组中所有资源的 API 信息。

• 对于每个资源，映射资源名称和资源操作类的关系。

• 资源的名称格式统一定义为 ${resource-name} 或者是 ${resource-name}/${sub-resource-name}。例如 pods 为资源名，pods/status 为该资源的 status 子资源。同时这个格式也是将来该资源注册的 REST API 的访问路径。

• 资源操作类为以前文章介绍的 Storage 类型的实现。

目前先我们写到这里，在下一篇文章中我们继续来介绍 kubernetes 资源 API 的注册。