这是 Kubernetes 文档的参考部分。
API 参考 {#api-reference}
- 术语表 —— 一个全面的、标准化的 Kubernetes 术语表
- Kubernetes API 参考
- Kubernetes API 单页参考
- 使用 Kubernetes API —— Kubernetes 的 API 概述
- API 的访问控制 —— 关于 Kubernetes 如何控制 API 访问的详细信息
- 常见的标签、注解和污点
官方支持的客户端库 {#officially-supported-client-libraries}
如果你需要通过编程语言调用 Kubernetes API,你可以使用客户端库。 以下是官方支持的客户端库:
- Kubernetes Go 语言客户端库
- Kubernetes Python 语言客户端库
- Kubernetes Java 语言客户端库
- Kubernetes JavaScript 语言客户端库
- Kubernetes C# 语言客户端库
- Kubernetes Haskell 语言客户端库
CLI
- kubectl —— 主要的 CLI 工具,用于运行命令和管理 Kubernetes 集群。
- JSONPath —— 通过 kubectl 使用 JSONPath 表达式的语法指南。
- kubeadm —— 此 CLI 工具可轻松配置安全的 Kubernetes 集群。
组件 {#components}
-
kubelet —— 在每个节点上运行的主代理。kubelet 接收一组 PodSpec 并确保其所描述的容器健康地运行。
-
kube-apiserver —— REST API,用于验证和配置 API 对象(如 Pod、服务或副本控制器等)的数据。
-
kube-controller-manager —— 一个守护进程,其中包含 Kubernetes 所附带的核心控制回路。
-
kube-proxy —— 可进行简单的 TCP/UDP 流转发或针对一组后端执行轮流 TCP/UDP 转发。
-
kube-scheduler —— 一个调度程序,用于管理可用性、性能和容量。
-
应该在控制平面和工作节点上打开的端口和协议列表
配置 API {#config-apis}
本节包含用于配置 kubernetes 组件或工具的 "未发布" API 的文档。 尽管这些 API 对于用户或操作者使用或管理集群来说是必不可少的, 它们大都没有以 RESTful 的方式在 API 服务器上公开。
-
admission.k8s.io/v1
-
apiserver.k8s.io/v1beta1
-
apiserver.config.k8s.io/v1
-
kube-apiserver 事件速率限制 (v1alpha1)
eventratelimit.admission.k8s.io/v1alpha1
-
kubelet.config.k8s.io/v1alpha1
-
kubelet.config.k8s.io/v1beta1
-
kubelet.config.k8s.io/v1
-
credentialprovider.kubelet.k8s.io/v1
-
kube-controller-manager 配置 (v1alpha1)
kubecontrollermanager.config.k8s.io/v1alpha1cloudcontrollermanager.config.k8s.io/v1alpha1
-
kubeproxy.config.k8s.io/v1alpha1
-
audit.k8s.io/v1
-
client.authentication.k8s.io/v1beta1
-
client.authentication.k8s.io/v1
-
apiserver.config.k8s.io/v1
-
imagepolicy.k8s.io/v1alpha1
kubeadm 的配置 API {#config-api-for-kubeadm}
外部 API {#external-apis}
这些是 Kubernetes 项目所定义的 API,但不是由核心项目实现的:
设计文档 {#design-docs}
Kubernetes 功能的设计文档归档,不妨考虑从 Kubernetes 架构和 Kubernetes 设计概述开始阅读。
编码
诸如 之类的工具可以处理不同的格式/编码。这些包括:
- CBOR,用于网络,但不可作为 kubectl 输出格式使用。
- 请参阅 CBOR 资源编码
- JSON,可作为
kubectl输出格式使用,也用于 HTTP 层。 - KYAML,YAML 的 Kubernetes 方言。
- KYAML 本质上是一种输出格式;任何可以向 Kubernetes 提供 KYAML 的地方, 也可以提供任何其他有效的 YAML 输入。
- YAML,可作为
kubectl输出格式使用,也用于 HTTP 层。
Kubernetes 还拥有一个自定义的 protobuf 编码, 该编码仅用于 HTTP 消息。
kubectl 工具支持一些其他的输出格式,例如自定义列;
请参阅 kubectl 参考文档中的输出格式。
来源:Kubernetes 文档贡献者 · 作者与贡献记录 · CC BY 4.0。离线整理了版式、链接和媒体显示。
