https://skyao.net/learning-kubernetes/source/repositories/api/ Recent content in api 仓库 on Kubernetes学习笔记 Hugo -- gohugo.io zh-cn Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/overview/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/overview/ <h2 id="api-信息">api 信息</h2> <h3 id="api-列表">api 列表</h3> <ul> <li>admission</li> <li>admissionregistration</li> <li>apidiscovery</li> <li>apiserverinternal</li> <li>apps</li> <li>authentication</li> <li>authorization</li> <li>autoscaling</li> <li>batch</li> <li>certificates</li> <li>coordination</li> <li>core</li> <li>discovery</li> <li>doc.go</li> <li>events</li> <li>extensions</li> <li>flowcontrol</li> <li>imagepolicy</li> <li>networking</li> <li>node</li> <li>policy</li> <li>rbac</li> <li>resource</li> <li>scheduling</li> <li>storage</li> <li>storagemigration</li> </ul> <h3 id="api-版本">API 版本</h3> <p>大部分 api 都有多个版本，如：</p> <ul> <li>v1</li> <li>v1alpha1</li> <li>v1beta1</li> </ul> <p>代码学习中，我们以 v1 版本为主。</p> <h2 id="api-代码结构">api 代码结构</h2> <p>基本上每个 api 文件夹都有如下的文件列表：</p> <ul> <li>doc.go</li> <li>generated.pb.go</li> <li>register.go</li> <li>types.go</li> <li>types_swagger_doc_generated.go</li> <li>zz_generated.deepcopy.go</li> <li>zz_generated.prerelease-lifecycle.go</li> </ul> <h3 id="docgo">doc.go</h3> <p>这是包的文档文件，包含包的用途说明和基本的文档注释</p> <p>通常会包含 +k8s:openapi-gen=true 这样的代码生成标记</p> <p>定义了包的帮助文档和代码生成器的元数据。</p> <p>打开看源码，发现除了 license 之外，只定义了 package 名字和该 package 相关的注解，如：</p> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>// +k8s:deepcopy-gen<span style="color:#ce5c00;font-weight:bold">=</span>package </span></span><span style="display:flex;"><span>// +k8s:protobuf-gen<span style="color:#ce5c00;font-weight:bold">=</span>package </span></span><span style="display:flex;"><span>// +k8s:openapi-gen<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87">false</span> </span></span><span style="display:flex;"><span>// +k8s:prerelease-lifecycle-gen<span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#204a87">true</span> </span></span><span style="display:flex;"><span>// +groupName<span style="color:#ce5c00;font-weight:bold">=</span>admission.k8s.io </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span>package v1 </span></span></code></pre></div><h3 id="generatedpbgo">generated.pb.go</h3> <p>generated.pb.go 是 Protocol Buffers 的生成文件（由 generated.proto 生成），包含了 AdmissionReview 等类型的 Protocol Buffers 序列化相关代码，用于 Kubernetes API 的 gRPC 通信和存储序列化。</p> <p>代码都是从 generated.proto 文件生成的，没啥好看的，直接看 generated.proto 文件好了。</p> <h3 id="generatedproto">generated.proto</h3> <p>generated.proto 是Protocol Buffers 的定义文件，定义了当前 API 类型的 protobuf 消息格式。</p> <p>generated.proto 文件会被 protoc 编译器用来生成 generated.pb.go</p> <h3 id="registergo">register.go</h3> <p>register.go 包含 API 类型的注册逻辑，将 API 中的类型注册到 Kubernetes API 的 Scheme 中。</p> <p>register.go 定义了如何将 Go 类型与 API 版本/组进行映射，包含 AddToScheme 函数，其他组件可以调用它来注册这些类型。</p> <h3 id="typesgo">types.go</h3> <p>最重要的文件，包含核心 API 类型的 Go 定义，定义了 API 相关的各种结构体，包含字段定义、标签注释和验证逻辑，有详细的字段注释说明每个字段的用途</p> <h3 id="types_swagger_doc_generatedgo">types_swagger_doc_generated.go</h3> <p>自动生成的 Swagger 文档，包含 API 类型的详细文档，用于生成 Kubernetes API 参考文档。</p> <p>这些注释会被 Kubernetes API 文档工具使用。</p> <h3 id="zz_generateddeepcopygo">zz_generated.deepcopy.go</h3> <p>自动生成的 DeepCopy 方法实现，包含 api 类型的深拷贝方法，由 deepcopy-gen 工具根据 types.go 中的标记生成。</p> <p>Kubernetes 运行时需要这些方法来安全地复制对象。</p> <h3 id="zz_generatedprerelease-lifecyclego">zz_generated.prerelease-lifecycle.go</h3> <p>自动生成的 API 生命周期相关代码，包含 API 版本的弃用和移除策略，由 prerelease-lifecycle-gen 工具生成。</p> <p>用于管理 API 版本的生命周期（alpha/beta/stable 状态转换）。</p> https://skyao.net/learning-kubernetes/source/repositories/api/admission/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/admission/ https://skyao.net/learning-kubernetes/source/repositories/api/admissionregistration/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/admissionregistration/ https://skyao.net/learning-kubernetes/source/repositories/api/apidiscovery/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/apidiscovery/ https://skyao.net/learning-kubernetes/source/repositories/api/apiserverinternal/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/apiserverinternal/ https://skyao.net/learning-kubernetes/source/repositories/api/apps/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/apps/ https://skyao.net/learning-kubernetes/source/repositories/api/authentication/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/authentication/ https://skyao.net/learning-kubernetes/source/repositories/api/authorization/ Wed, 14 May 2025 00:00:00 +0000 https://skyao.net/learning-kubernetes/source/repositories/api/authorization/