Kubernetes API

Kubernetes API

Kubernetes API 是通过 RESTful 接口提供 Kubernetes 功能服务并负责集群状态存储的应用程序。

Kubernetes 资源和"意向记录"都是作为 API 对象储存的,并可以通过调用 RESTful 风格的 API 进行修改。 API 允许以声明方式管理配置。 用户可以直接和 Kubernetes API 交互,也可以通过 kubectl 这样的工具进行交互。 核心的 Kubernetes API 是很灵活的,可以扩展以支持定制资源。


工作负载资源

Service 资源

配置和存储资源

身份认证资源

鉴权资源

策略资源

扩展资源

集群资源

公共定义

常用参数

FieldSelectorRequirement

FieldSelectorRequirement 是一种选择器,包含键(key)、值(values)以及用于关联键与值的运算符(operator)。

MicroTime

MicroTime 是具有微秒级精度的 Time 版本。

OwnerReference

OwnerReference 包含足以识别所属对象的信息。所属对象必须与从属对象位于同一命名空间,或者是集群作用域对象,因此其中不包含命名空间字段。

PolicyRule

PolicyRule 包含描述策略规则的信息,但不包含关于该规则适用于哪些对象或适用于哪个命名空间的信息。

Preconditions

在执行某项操作(更新、删除等)之前,必须满足 Preconditions。

Quantity

Quantity 是数字的定点表示。它提供了方便的 JSON 和 YAML 编组/解组功能,以及 String()AsInt64() 访问器。

序列化格式如下:


   (Note that <suffix> may be empty, from the "" case in <decimalSI>.)

<digit>           ::= 0 | 1 | ... | 9 <digits>          ::= <digit> | <digit><digits> <number>          ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign>            ::= "+" | "-" <signedNumber>    ::= <number> | <sign><number> <suffix>          ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI>        ::= Ki | Mi | Gi | Ti | Pi | Ei

   (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)

<decimalSI>       ::= m | "" | k | M | G | T | P | E

   (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)

<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> ```

无论使用三种指数形式中的哪一种,任何 Quantity 都不能表示幅度大于 2^63-1 的数字,也不能超过 3 位小数。更大或更精确的数字将被截断或向上取整。(例如:0.1m 将向上取整为 1m。)如果将来需要更大或更小的数量,这可能会被扩展。

当 Quantity 从字符串解析时,它会记住其后缀类型,并在再次序列化时使用相同的类型。

在序列化之前,Quantity 将被置于 "规范形式"(canonical form)。这意味着指数/后缀将向上或向下调整(尾数相应增加或减少),使得:

- 不会丢失精度 - 不会输出小数位 - 指数(或后缀)尽可能大。

除非数字为负数,否则符号将被省略。

示例:

- 1.5 将被序列化为 "1500m" - 1.5Gi 将被序列化为 "1536Mi"

只要格式正确,非规范值仍可被解析,但会以其规范形式重新输出。(因此请始终使用规范形式,或者不要进行 diff。)

此格式旨在使不编写某种特殊处理代码就使用这些数字变得困难,希望以此促使实现者也使用定点实现。

RoleRef

RoleRef 包含指向所使用角色的信息。

RuleWithOperations

RuleWithOperations 是由 operations 和 resources 组成的元组。建议确保所有元组展开均有效。

ServerAddressByClientCIDR

ServerAddressByClientCIDR 帮助客户端根据其匹配的 clientCIDR,确定应使用的服务器地址。

ServiceReference

ServiceReference 持有对 Service.legacy.k8s.io 的引用。

Subject

Subject 包含对角色绑定所适用的对象或用户身份的引用。 它可以是直接的 API 对象引用,也可以是针对非对象(如用户和组名称)的值。

Time

Time 类型是对 time.Time 的封装,支持正确地序列化为 YAML 和 JSON 格式。该类型还针对 time 包提供的许多工厂方法提供了相应的封装版本。

Toleration

该容忍度所关联的 Pod,能够容忍任何与三元组 <key, value, effect> 相匹配的污点(taint),匹配依据由 <operator> 指定。

TypedLocalObjectReference

TypedLocalObjectReference 包含足够的信息,使你能够在同一命名空间内定位所引用的类型化对象。

TypedLocalObjectReference

TypedLocalObjectReference 允许引用同一命名空间内的类型化对象。

UserInfo

UserInfo 包含实现 user.Info 接口所需的用户信息。

Variable

Variable 是指用于组合的变量定义;Variable 被定义为一种具名表达式。

WatchEvent

event 表示针对受监控资源发生的单个事件。

最后修改 August 31, 2023 at 10:38 PM PST: sync kubernetes-api/_index label-selector endpoints-v1 (64f8db0a48)