接着 Kubernetes:kube-apiserver 之启动流程(一) 加以介绍。
创建 APIExtensions Server
创建完通用 APIServer 后继续创建 APIExtensions Server。
1func (c completedConfig) New(delegationTarget genericapiserver.DelegationTarget) (*CustomResourceDefinitions, error) {
2 genericServer, err := c.GenericConfig.New("apiextensions-apiserver", delegationTarget)
3
4 s := &CustomResourceDefinitions{
5 GenericAPIServer: genericServer,
6 }
7
8 // 存储建立 REST API 到资源实体的信息
9 apiGroupInfo := genericapiserver.NewDefaultAPIGroupInfo(apiextensions.GroupName, Scheme, metav1.ParameterCodec, Codecs)
10
11 // 资源实体
12 storage := map[string]rest.Storage{}
13
14 // customresourcedefinitions
15 if resource := "customresourcedefinitions"; apiResourceConfig.ResourceEnabled(v1.SchemeGroupVersion.WithResource(resource)) {
16 // 创建资源实体
17 customResourceDefinitionStorage, err := customresourcedefinition.NewREST(Scheme, c.GenericConfig.RESTOptionsGetter)
18 if err != nil {
19 return nil, err
20 }
21 storage[resource] = customResourceDefinitionStorage
22 storage[resource+"/status"] = customresourcedefinition.NewStatusREST(Scheme, customResourceDefinitionStorage)
23 }
24 if len(storage) > 0 {
25 apiGroupInfo.VersionedResourcesStorageMap[v1.SchemeGroupVersion.Version] = storage
26 }
27
28 if err := s.GenericAPIServer.InstallAPIGroup(&apiGroupInfo); err != nil {
29 return nil, err
30 }
APIGroupInfo 对象用于描述资源组信息,storage 存储资源到资源实体的对应关系。
资源实体,通过 NewREST() 函数创建。
1# kubernetes/vendor/k8s.io/apiextensions-apiserver/pkg/registry/customresourcedefinition/etcd.go
2package customresourcedefinition
3
4// NewREST returns a RESTStorage object that will work against API services.
5func NewREST(scheme *runtime.Scheme, optsGetter generic.RESTOptionsGetter) (*REST, error) {
6 strategy := NewStrategy(scheme)
7
8 store := &genericregistry.Store{
9 NewFunc: func() runtime.Object { return &apiextensions.CustomResourceDefinition{} },
10 NewListFunc: func() runtime.Object { return &apiextensions.CustomResourceDefinitionList{} },
11 PredicateFunc: MatchCustomResourceDefinition,
12 DefaultQualifiedResource: apiextensions.Resource("customresourcedefinitions"),
13 SingularQualifiedResource: apiextensions.Resource("customresourcedefinition"),
14
15 CreateStrategy: strategy,
16 UpdateStrategy: strategy,
17 DeleteStrategy: strategy,
18 ResetFieldsStrategy: strategy,
19
20 // TODO: define table converter that exposes more than name/creation timestamp
21 TableConvertor: rest.NewDefaultTableConvertor(apiextensions.Resource("customresourcedefinitions")),
22 }
23 options := &generic.StoreOptions{RESTOptions: optsGetter, AttrFunc: GetAttrs}
24 if err := store.CompleteWithOptions(options); err != nil {
25 return nil, err
26 }
27 return &REST{store}, nil
28}
可以看到,资源实体是在资源包 customresourcedefinition 的 etcd.go 中创建的,创建的资源实体负责和 etcd 交互。
(关于 etcd 交互的部分先不讲,后续会专门介绍。)
创建完资源实体后,通过 apiGroupInfo.VersionedResourcesStorageMap[v1.SchemeGroupVersion.Version] = storage 将资源实体存储到 apiGroupInfo。
继续调用 InstallAPIGroup(apiGroupInfo *APIGroupInfo) 安装 REST API。
1# kubernetes/vendor/k8s.io/apiserver/pkg/server/genericapiserver.go
2func (s *GenericAPIServer) InstallAPIGroup(apiGroupInfo *APIGroupInfo) error {
3 return s.InstallAPIGroups(apiGroupInfo)
4}
5
6func (s *GenericAPIServer) InstallAPIGroups(apiGroupInfos ...*APIGroupInfo) error {
7 for _, apiGroupInfo := range apiGroupInfos {
8 // 调用 installAPIResources
9 if err := s.installAPIResources(APIGroupPrefix, apiGroupInfo, openAPIModels); err != nil {
10 return fmt.Errorf("unable to install api resources: %v", err)
11 }
12 }
13 s.DiscoveryGroupManager.AddGroup(apiGroup)
14 s.Handler.GoRestfulContainer.Add(discovery.NewAPIGroupHandler(s.Serializer, apiGroup).WebService())
15}
16
17// installAPIResources is a private method for installing the REST storage backing each api groupversionresource
18func (s *GenericAPIServer) installAPIResources(apiPrefix string, apiGroupInfo *APIGroupInfo, typeConverter managedfields.TypeConverter) error {
19 for _, groupVersion := range apiGroupInfo.PrioritizedVersions {
20 apiGroupVersion, err := s.getAPIGroupVersion(apiGroupInfo, groupVersion, apiPrefix)
21 if err != nil {
22 return err
23 }
24
25 // 调用 InstallREST
26 discoveryAPIResources, r, err := apiGroupVersion.InstallREST(s.Handler.GoRestfulContainer)
27 }
28}
29
30# kubernetes/vendor/k8s.io/apiserver/pkg/endpoints/groupversion.go
31func (g *APIGroupVersion) InstallREST(container *restful.Container) ([]apidiscoveryv2beta1.APIResourceDiscovery, []*storageversion.ResourceInfo, error) {
32 prefix := path.Join(g.Root, g.GroupVersion.Group, g.GroupVersion.Version)
33 installer := &APIInstaller{
34 group: g,
35 prefix: prefix,
36 minRequestTimeout: g.MinRequestTimeout,
37 }
38
39 // 调用 Install
40 apiResources, resourceInfos, ws, registrationErrors := installer.Install()
41 container.Add(ws)
42
43 return aggregatedDiscoveryResources, removeNonPersistedResources(resourceInfos), utilerrors.NewAggregate(registrationErrors)
44}
45
46# kubernetes/vendor/k8s.io/apiserver/pkg/endpoints/installer.go
47// Install handlers for API resources.
48func (a *APIInstaller) Install() ([]metav1.APIResource, []*storageversion.ResourceInfo, *restful.WebService, []error) {
49 for _, path := range paths {
50 // 注册资源 Handler
51 apiResource, resourceInfo, err := a.registerResourceHandlers(path, a.group.Storage[path], ws)
52 if err != nil {
53 errors = append(errors, fmt.Errorf("error in registering resource: %s, %v", path, err))
54 }
55 if apiResource != nil {
56 apiResources = append(apiResources, *apiResource)
57 }
58 if resourceInfo != nil {
59 resourceInfos = append(resourceInfos, resourceInfo)
60 }
61 }
62 return apiResources, resourceInfos, ws, errors
63}
如上例所示,注册资源 REST API 的调用链很长,通过逐层调用,走到 registerResourceHandlers 注册资源 handler。
registerResourceHandlers 函数非常的长,主要抓一点:注册 RESTful API 的资源 handler 需要什么?回答好这个问题基本上就能抓住 registerResourceHandlers 的精髓了。
注册资源 handler 需要知道资源的 API path 和资源实体(指和 etcd 交互的资源实例)的对应关系,接着需要知道哪些 action 可以访问 API path。
围绕这两块看资源 handler 的注册过程。
1func (a *APIInstaller) registerResourceHandlers(path string, storage rest.Storage, ws *restful.WebService) (*metav1.APIResource, *storageversion.ResourceInfo, error) {
2 // what verbs are supported by the storage, used to know what verbs we support per path
3 creater, isCreater := storage.(rest.Creater)
4 namedCreater, isNamedCreater := storage.(rest.NamedCreater)
5 lister, isLister := storage.(rest.Lister)
6 getter, isGetter := storage.(rest.Getter)
7 getterWithOptions, isGetterWithOptions := storage.(rest.GetterWithOptions)
8 gracefulDeleter, isGracefulDeleter := storage.(rest.GracefulDeleter)
9 collectionDeleter, isCollectionDeleter := storage.(rest.CollectionDeleter)
10 updater, isUpdater := storage.(rest.Updater)
11 patcher, isPatcher := storage.(rest.Patcher)
12 watcher, isWatcher := storage.(rest.Watcher)
13 connecter, isConnecter := storage.(rest.Connecter)
14 storageMeta, isMetadata := storage.(rest.StorageMetadata)
15 storageVersionProvider, isStorageVersionProvider := storage.(rest.StorageVersionProvider)
16 gvAcceptor, _ := storage.(rest.GroupVersionAcceptor)
17
18
19 // Get the list of actions for the given scope.
20 switch {
21 case !namespaceScoped:
22 ...
23 default:
24 // Handler for standard REST verbs (GET, PUT, POST and DELETE).
25 actions := []action{}
26
27 actions = appendIf(actions, action{"LIST", resourcePath, resourceParams, namer, false}, isLister)
28 actions = appendIf(actions, action{"POST", resourcePath, resourceParams, namer, false}, isCreater)
29 actions = appendIf(actions, action{"DELETECOLLECTION", resourcePath, resourceParams, namer, false}, isCollectionDeleter)
30 // DEPRECATED in 1.11
31 actions = appendIf(actions, action{"WATCHLIST", "watch/" + resourcePath, resourceParams, namer, false}, allowWatchList)
32
33 actions = appendIf(actions, action{"GET", itemPath, nameParams, namer, false}, isGetter)
34 if getSubpath {
35 actions = appendIf(actions, action{"GET", itemPath + "/{path:*}", proxyParams, namer, false}, isGetter)
36 }
37 actions = appendIf(actions, action{"PUT", itemPath, nameParams, namer, false}, isUpdater)
38 actions = appendIf(actions, action{"PATCH", itemPath, nameParams, namer, false}, isPatcher)
39 actions = appendIf(actions, action{"DELETE", itemPath, nameParams, namer, false}, isGracefulDeleter)
40 // DEPRECATED in 1.11
41 actions = appendIf(actions, action{"WATCH", "watch/" + itemPath, nameParams, namer, false}, isWatcher)
42 actions = appendIf(actions, action{"CONNECT", itemPath, nameParams, namer, false}, isConnecter)
43 actions = appendIf(actions, action{"CONNECT", itemPath + "/{path:*}", proxyParams, namer, false}, isConnecter && connectSubpath)
44 }
45
46 for _, action := range actions {
47 switch action.Verb {
48 case "GET": // Get a resource.
49 var handler restful.RouteFunction
50 if isGetterWithOptions {
51 handler = restfulGetResourceWithOptions(getterWithOptions, reqScope, isSubresource)
52 } else {
53 handler = restfulGetResource(getter, reqScope)
54 }
55
56 route := ws.GET(action.Path).To(handler).
57 Doc(doc).
58 Param(ws.QueryParameter("pretty", "If 'true', then the output is pretty printed.")).
59 Operation("read"+namespaced+kind+strings.Title(subresource)+operationSuffix).
60 Produces(append(storageMeta.ProducesMIMETypes(action.Verb), mediaTypes...)...).
61 Returns(http.StatusOK, "OK", producedObject).
62 Writes(producedObject)
63
64 routes = append(routes, route)
65 }
66
67 for _, route := range routes {
68 route.Metadata(ROUTE_META_GVK, metav1.GroupVersionKind{
69 Group: reqScope.Kind.Group,
70 Version: reqScope.Kind.Version,
71 Kind: reqScope.Kind.Kind,
72 })
73 route.Metadata(ROUTE_META_ACTION, strings.ToLower(action.Verb))
74 ws.Route(route)
75 }
76 }
77}
可以看到,通过资源实体 storage 支持的接口类型可以反射出资源支持的方法。接着将支持的方法加入 actions。actions 存储的是 action.Verb 和支持的资源 API path 信息。
拿到 actions 后,通过匹配 actions.Verb 建立 action.Verb -> action.Path -> handler 的路由。其中,创建 handler 需要用到 storage,因为 handler 是通过 storage 和 etcd 交互的。
通过 go-restful 库建立上述路由,接着 ws.Route(route) 将 route 加入到 restful.WebService 中。
回头看 InstallREST。
1func (g *APIGroupVersion) InstallREST(container *restful.Container) ([]apidiscoveryv2beta1.APIResourceDiscovery, []*storageversion.ResourceInfo, error) {
2
3 apiResources, resourceInfos, ws, registrationErrors := installer.Install()
4 container.Add(ws)
5
6 return aggregatedDiscoveryResources, removeNonPersistedResources(resourceInfos), utilerrors.NewAggregate(registrationErrors)
7}
8
9func (s *GenericAPIServer) installAPIResources(apiPrefix string, apiGroupInfo *APIGroupInfo, typeConverter managedfields.TypeConverter) error {
10 discoveryAPIResources, r, err := apiGroupVersion.InstallREST(s.Handler.GoRestfulContainer)
11}
通过 container.Add(ws) 将 ws 添加到 go-restful 的 container 中,该 container 即为 APIExtensions Server 的 Handler 所提供的 GoRestfulContainer。
这里介绍了 APIExtensions Server 的 REST API 创建过程。对于 KubeAPIServer 和 AggregatorServer 的创建过程与之类似,不过多介绍。
REST API 创建好以后,下一步就到如何运行 kube-apiserver了。
运行 kube-apiserver
kube-apiserver 作为提供 RESTful API 的组件,其运行主要是监听端口和启动服务。理清了这点,就能在复杂的运行代码中找出头绪。
调用 APIAggregator.PrepareRun 和 preparedAPIAggregator.Run 运行 kube-apiserver。
1func Run(opts options.CompletedOptions, stopCh <-chan struct{}) error {
2 prepared, err := server.PrepareRun()
3 if err != nil {
4 return err
5 }
6
7 return prepared.Run(stopCh)
8}
启动过程在 PrepareRun 中。
1func (s *APIAggregator) PrepareRun() (preparedAPIAggregator, error) {
2 prepared := s.GenericAPIServer.PrepareRun()
3 return preparedAPIAggregator{APIAggregator: s, runnable: prepared}, nil
4}
运行 prepared.Run(stopCh) 实际调用的是 preparedGenericAPIServer.Run 方法。
1func (s preparedGenericAPIServer) Run(stopCh <-chan struct{}) error {
2 // 调用 preparedGenericAPIServer.NonBlockingRun
3 stoppedCh, listenerStoppedCh, err := s.NonBlockingRun(stopHttpServerCh, shutdownTimeout)
4 if err != nil {
5 return err
6 }
7}
8
9func (s preparedGenericAPIServer) NonBlockingRun(stopCh <-chan struct{}, shutdownTimeout time.Duration) (<-chan struct{}, <-chan struct{}, error) {
10 if s.SecureServingInfo != nil && s.Handler != nil {
11 var err error
12 // 调用 SecureServingInfo.Serve
13 stoppedCh, listenerStoppedCh, err = s.SecureServingInfo.Serve(s.Handler, shutdownTimeout, internalStopCh)
14 if err != nil {
15 close(internalStopCh)
16 return nil, nil, err
17 }
18 }
19}
20
21func (s *SecureServingInfo) Serve(handler http.Handler, shutdownTimeout time.Duration, stopCh <-chan struct{}) (<-chan struct{}, <-chan struct{}, error) {
22 // 组 http.Server
23 secureServer := &http.Server{
24 Addr: s.Listener.Addr().String(),
25 Handler: handler,
26 MaxHeaderBytes: 1 << 20,
27 TLSConfig: tlsConfig,
28
29 IdleTimeout: 90 * time.Second, // matches http.DefaultTransport keep-alive timeout
30 ReadHeaderTimeout: 32 * time.Second, // just shy of requestTimeoutUpperBound
31 }
32
33 return RunServer(secureServer, s.Listener, shutdownTimeout, stopCh)
34}
35
36func RunServer(
37 server *http.Server,
38 ln net.Listener,
39 shutDownTimeout time.Duration,
40 stopCh <-chan struct{},
41) (<-chan struct{}, <-chan struct{}, error) {
42 go func() {
43 // 调用 http 的 Server.Serve 提供 `RESTful API` 服务
44 err := server.Serve(listener)
45
46 msg := fmt.Sprintf("Stopped listening on %s", ln.Addr().String())
47 }
48}
可以看到,最终调用 http 包的 Server.Serve 提供 RESTful API 服务。
至此,已介绍完 kube-apiserver 从启动到运行的核心逻辑。下一篇,将重点介绍 kube-apiserver 是怎么和 etcd 进行交互的。