Definitions
v1.Node
Node，也叫minion，在kubernetes中是工作节点。在缓存中（比如etcd），每个节点是唯一的。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind (类型) |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象的元数据(metadata)。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了一个节点的行为。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
当前节点的最新状态。由系统生成，只读。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.PersistentVolumeClaimList
PersistentVolumeClaimList是一个列表，包含多个 PersistentVolumeClaim条目。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组持久存储卷声明。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
true |
v1.PersistentVolumeClaim array |
v1.ObjectFieldSelector
ObjectFieldSelector 用来选择对象的某个APIVersioned字段。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
apiVersion |
我们用某个类型去呈现FieldPath，apiVersion指类型的版本号，默认是"v1"。 |
false |
string |
|
fieldPath |
针对某个特定的版本的API，要选择的字段的路径。 |
true |
string |
v1.SELinuxOptions
SELinuxOptions是指要赋给容器的标签(labels)。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
user |
User是指要赋给容器的SELinux用户标签。 |
false |
string |
|
role |
Role是指要赋给容器的SELinux角色标签。 |
false |
string |
|
type |
Type是指要赋给容器的SELinux类型标签。 |
false |
string |
|
level |
Level是指要赋给容器的SELinux级别标签。 |
false |
string |
v1.ContainerStateRunning
ContainerStateRunning指容器"运行中"的状态
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
startedAt |
容器上一次启动或者重启的时间 |
false |
string |
v1.VolumeMount
VolumeMount用来描述一个容器数据卷的挂载。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
这个字段必须与数据卷的名字相匹配。 |
true |
string |
|
readOnly |
如果挂载时设置为只读，则该字段为true，否则为可读写(false或者unspecified)。默认值为false。 |
false |
boolean |
false |
mountPath(挂载路径) |
指定数据卷在容器内的挂载路径。 |
true |
string |
v1.PersistentVolumeClaimSpec
PersistentVolumeClaimSpec用来描述存储设备的常见属性，允许针对某个特定供应商的设备自定义属性。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
accessModes (访问模式) |
AccessModes 包含了数据卷应具备的访问模式。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1 |
false |
||
resources (资源) |
Resources代表存储卷支持的最小资源。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources |
false |
||
volumeName (数据卷名字) |
VolumeName是持久存储卷的一个引用。 |
false |
string |
v1.CephFSVolumeSource
CephFSVolumeSource表示一次Ceph文件系统挂载，其生命周期与挂载到的pod一致。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
monitors (监控器) |
必须字段。monitors是Ceph monitor的集合。详情查看：http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it |
true |
string array |
|
user |
可选字段。User是一个rados用户名称，默认为admin。详情查看：http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it |
false |
string |
|
secretFile |
可选字段。SecretFile是用户秘钥文件的路径，默认为/etc/ceph/user.secret。详情查看：http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it |
false |
string |
|
secretRef |
可选字段。SecretRef是用户身份认证的秘钥，默认为空。详情查看：http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it |
false |
||
readOnly |
可选字段。默认为false (read/write)。该选项保证挂载数据卷时将其设置为只读。详情查看：http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it |
false |
boolean |
false |
v1.DownwardAPIVolumeSource
DownwardAPIVolumeSource代表一个包含了下行API信息的数据卷。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
items |
Items是下行API数据卷文件的列表。 |
false |
v1.DownwardAPIVolumeFile array |
unversioned.StatusCause
StatusCause提供api.Status的失败信息，其中包括一些同时出现多种错误的情况。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
reason |
机器可识别的错误原因描述。如果该字段的值为空，表示没有可用的错误信息。 |
false |
string |
|
message |
人可识别的错误原因描述。从人的角度出发，该字段具有很大的可读性。 |
false |
string |
|
field |
造成当前错误的资源的字段，一般以JSON方式序列化后的字符串命名。对于嵌套结构，可能会包含点(dot)和后缀表示法。数组下标从0开始计数。如果某个字段造成多个错误，那么该字段可能会在数组中出现多次。该字段为可选字段。 |
false |
string |
v1.GCEPersistentDiskVolumeSource
GCEPersistentDiskVolumeSource 代表Google Compute Engine上的一块持久存储盘。
GCE持久存储盘(简称GCE PD)必须存在，且在被挂载到容器之前必须首先被格式化。该存储盘必须和kubelet存在于同一个GCE项目和区域中。GCE PD以可读/可写模式只能被挂在一次。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
pdName |
GCE中PD资源的唯一名字，用来识别GCE中的磁盘。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
true |
string |
|
fsType |
要挂载的存储卷的文件类型。提示：必须保证宿主操作系统支持存储卷的文件类型，比如ext4, xfs, ntsf。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
true |
string |
|
partition |
你要挂载的存储卷分区。默认根据存储卷名称挂载。比如，对于存储卷/dev/sda1，你指定了分区为"1"。类似的，存储卷/dev/sda的对应分区为"0"。你也可以将该字段留空。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
false |
integer (int32) |
|
readOnly |
该选项保证挂载数据卷时将其设置为只读。默认为false (read/write)。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
false |
boolean |
false |
v1.ResourceQuotaSpec
ResourceQuotaSpec定义了资源限额上的硬性限制。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
hard |
Hard 是指对于每一个已命名资源的硬性限制。详情查看：http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota |
false |
v1.NamespaceStatus
NamespaceStatus指一个命名空间的当前状态信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
phase |
Phase是指命名空间在整个生命周期中所处的阶段。 详情查看：http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases |
false |
string |
v1.NamespaceSpec
NamespaceSpec描述了一个命名空间的属性。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
finalizers |
Finalizers是一组变量，如果一个对象要从存储中删除，那么对应的变量必须被先置为空。详情查看：http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers |
false |
v1.FinalizerName array |
v1.PersistentVolume
PersistentVolume (PV)是由管理员设置的存储资源，这些存储资源对于不同的节点来说并没有太大差别(跨节点)。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象的元数据。 详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了集群拥有的持久存储卷的规格，是由管理员提供的。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes |
false |
||
status |
Status表示持久存储卷的当前状态和信息。它是由系统生成的，是只读字段。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes |
false |
v1.PersistentVolumeStatus
PersistentVolumeStatus表示一个持久存储卷的当前状态。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
phase |
Phase表示存储卷处于哪个阶段。比如"可用 (available)"、"绑定到一个持久存储卷声明 (bound to a claim)"和"已释放 (released by a claim)"。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#phase |
false |
string |
|
message |
人可读写的一段信息，用于显示储存卷之所以处于当前状态的原因。 |
false |
string |
|
reason |
Reason是一个简单的驼峰式字符串，用于显示在命令行中，它用于描述出现的任何错误。程序可解析该字段的值。 |
false |
string |
v1.EndpointsList
EndpointsList是一组endpoints。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
endpoint列表。 |
true |
v1.Endpoints array |
v1.GitRepoVolumeSource
GitRepoVolumeSource是pod创建时从git仓库下载的一个存储卷。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
repository |
Repository URL |
true |
string |
|
revision |
特定版本代码提交的hash值。 |
true |
string |
v1.Capabilities
从运行中的容器添加和删除POSIX capabilities。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
add |
已添加的capabilities |
false |
v1.Capability array |
|
drop |
已删除的capabilities |
false |
v1.Capability array |
v1.PodTemplateList
PodTemplateList是一组Pod模板 (PodTemplates)。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组Pod模板 |
true |
v1.PodTemplate array |
v1.NodeCondition
NodeCondition表示一个节点的状态信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
type |
节点状态信息的类型，目前只有 Ready |
true |
string |
|
status |
节点状态的状态值，与状态类型(type)一一对应，可以是True, False或Unknown。 |
true |
string |
|
lastHeartbeatTime |
最后一次状态更新的时间。 |
false |
string |
|
lastTransitionTime |
最后一次状态切换的时间。 |
false |
string |
|
reason |
(简单表述)最后一次状态切换的原因。 |
false |
string |
|
message |
人可阅读的一段信息，显示最后一次状态切换的详细信息。 |
false |
string |
v1.LocalObjectReference
LocalObjectReference包含了一些寻址信息，通过这个字段的值你可以在相同的namespace下找到它指向的对象。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
被指向对象的名字。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
false |
string |
v1.ResourceQuotaStatus
ResourceQuotaStatus定义了资源的硬性限制和使用率。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
hard |
Hard是一组应用到每个已命名资源的硬性限制。详情查看：http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota |
false |
||
used |
Used是当前命名空间下总的资源使用率。 |
false |
v1.ExecAction
ExecAction描述了一个"run in container"的动作。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
command |
Command是一个要在容器中运行的命令，运行的当前目录为容器文件系统的根目录(/)。命令并不是在shell中执行的，所以传统的shell命令可能不好用。如果需要的话，你必须显式地调用shell。返回值0表示live/healthy，非零表示unhealthy。 |
false |
string array |
v1.ObjectMeta
ObjectMeta表示所有持久资源必须有的元数据，它包含了用户必须创建的所有对象。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
Name在一个命名空间内必须是唯一的。虽然在创建资源时，有些允许客户端请求自动生成名字，但也必须填写这个字段。Name最初是为了保证创建操作的幂等性和保证配置可定义设计的。它一旦确定便无法更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
false |
string |
|
generateName |
GenerateName是一个可选的前缀名字，当Name字段没有填写时，server使用它生成一个唯一的Name。如果使用这个字段，客户端传过来的名字将会失效，因为server会返回一个不同的Name。这个值也会和唯一的后缀一起使用。这个字段的检查规则与Name字段一致，由于suffix的长度限制，可能被截断，以保证在server端的唯一性 |
false |
string |
|
namespace |
Namespace定义了一个空间，在该空间内，名字(Name)必须是唯一的。一个空("")的命名空间和"default"命名空间是等价的，然而"default"命名空间是标准命名空间，并不是所有的对象都被必须放到该命名空间内。"default"命名空间中的对象的该字段为空。 |
false |
string |
|
selfLink |
SelfLink是一个代表这个对象本身的URL。该字段由系统自动生成，是一个只读字段。 |
false |
string |
|
uid |
UID表示当前对象在任何时间和空间中都是唯一的。该字段在资源创建成功后由系统自动生成，PUT操作不会改变该字段的值。 |
false |
string |
|
resourceVersion |
用来表示当前对象的内部版本号，client端根据这个字段来判断对象是否已经发生变化。它也能用在optimistic concurrency，变化检测和监控外界对一个或者一组资源做了哪些操作。client端必须显式地对待这些值，并且不做任何修改地传递给server端。这个字段可能只对特定资源有效。 |
false |
string |
|
generation |
一个序列号，它表示期望状态的一次生成(generation)。目前只有replication controllers支持。该字段由系统生成的，是一个只读字段。 |
false |
integer (int64) |
|
creationTimestamp |
CreationTimestamp代表该对象在server端生成的时间。前后独立的两次创建操作并不能保证该字段也是有序的。client端不能设置这个字段。显示格式遵循RFC3339规范，以UTC方式显示。 |
false |
string |
|
deletionTimestamp |
DeletionTimestamp是只资源(要)被删除的时间，由遵循RFC3339格式。用户请求删除资源时，服务器端生成该字段，生成以后client端不能直接修改。到该字段指定的时间以后，资源会被删除，删除以后 资源列表中将看不到该资源，也无法通过名字检索该资源。该字段一旦设置，该字段只能被修改为已指定时间之前的某个时间，也可以在已指定时间之前删除该资源，而不能取消或者修改为已指定时间之后的时间。举个例子，一个用户请求在30s内删除一个pod，对应的kubelet会向pod内的所有容器发送一个优雅的termination信号，一旦pod资源被删除，kubelet会发送强制的termination信号。如果不设置该字段，将不向容器发送termination信号而是直接终止。 |
false |
string |
|
deletionGracePeriodSeconds |
在被系统删除之前，该对象允许被优雅删除的时间，以秒为单位。只有设置deletionTimestamp字段后，该字段才生效。该字段只能被缩短，不能取消设置或者延长。该字段是只读字段。 |
false |
integer (int64) |
|
labels |
labels用来对对象进行组织和分类，类型为map[string]string。它与replication controller和services的选择器(selectors)检查匹配。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/labels.md |
false |
||
annotations |
Annotations是一种非结构化的map[string]string，可以通过kubernetes系统外的工具对其进行修改和读取。不能根据这个字段执行查询操作，在修改对象时，也必须带上该字段。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/annotations.md |
false |
v1.LimitRangeSpec
LimitRangeSpec定义了一类资源的限制，包括最小和最大可用范围。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
limits |
Limits是一组LimitRangeItem对象。 |
true |
v1.LimitRangeItem array |
v1.ISCSIVolumeSource
ISCSIVolumeSource 是一种ISCSI磁盘，它可以以read/write模式挂载，但只能挂载一次
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
targetPortal |
iSCSI目标地址，可以是IP地址，如果端口号不是默认端口号 (比如tcp port860和3260)，也可以是ip_addr:port。 |
true |
string |
|
iqn |
目标iSCSI磁盘的名字 |
true |
string |
|
lun |
目标iSCSI磁盘的逻辑单元号。 |
true |
integer (int32) |
|
fsType |
要挂载的磁盘的文件系统类型。注意：必须保证磁盘的文件系统与操作系统的文件系统相兼容，比如采用"ext4", "xfs", "ntfs"格式。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi |
true |
string |
|
readOnly |
该选项保证挂载数据卷时将其设置为只读。默认为false。 |
false |
boolean |
false |
v1.EmptyDirVolumeSource
EmptyDirVolumeSource是一个临时文件目录，生命周期与pod一致。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
medium |
该目录之后运行的存储介质的类型，默认为""，即使用节点的存储介质类型。该字段必须为空字符串(默认)或者Memory。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir |
false |
string |
v1.NodeList
NodeList只是注册到maser上的所有节点的列表。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组节点 |
true |
v1.Node array |
unversioned.Patch
Patch定义了Kubernetes PATCH请求的具体名字和类型。
v1.PersistentVolumeClaim
PersistentVolumeClaim是用户对持久存储卷的请求和请求声明。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了pod创建者请求的数据卷的属性(characteristics)。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
false |
||
status |
Status代表当前持久存储卷声明的当前状态和信息。该字段是只读的。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
false |
v1.NamespaceList
NamespaceList是一组命名空间。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
Items是一组命名空间对象。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md |
true |
v1.Namespace array |
v1.ServiceAccount
ServiceAccount将一组字段绑定到一起，这些字段分别是：用户用户或外围系统可辨识的Name(用于身份识别)、能够被认证或者授权的原则、一组secrets。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
secrets |
Secrets是一组secret，使用当前ServiceAccount的pods有权使用Secrets。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/secrets.md |
false |
v1.ObjectReference array |
|
imagePullSecrets |
ImagePullSecrets是同一namespace中一组secret的引用，使用当前ServiceAccount的pod有权使用它下载镜像。ImagePullSecrets与Secrets不同，Secrets可以被挂载到pod中，而ImagePullSecrets只能被kubelet使用。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret |
false |
v1.LocalObjectReference array |
v1.NodeAddress
NodeAddress包含了节点地址的信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
type |
节点地址类型，可以是域名、外网ip或者内网ip。 |
true |
string |
|
address |
节点地址 |
true |
string |
v1.Namespace
Namespace是为名字 (Name)定义了域，可以同时使用多个Namespace。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了Namespace的行为。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status描述了Namespace的当前状态。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.FlockerVolumeSource
FlockerVolumeSource代表一个Flock存储设备，它是由Flocker agent挂载的。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
datasetName |
必填字段：存储卷的名字。依据Flocker负载情况，这个值被存储在metada中。 |
true |
string |
v1.PersistentVolumeClaimVolumeSource
PersistentVolumeClaimVolumeSource是同一个命名空间下用户持久存储卷声明 (PVC)的引用。通过这个字段可以找到绑定的持久存储卷 (PV)，并将该PV挂载到指定的pod上。从本质上来说，PersistentVolumeClaimVolumeSource是对其他用户(或系统)拥有的存储卷类型的一个封装。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
claimName |
ClaimName是Pod使用存储卷时，对应的PersistentVolumeClaim的名字。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
true |
string |
|
readOnly |
在挂载时强制将存储卷设置为只读。默认为false。 |
false |
boolean |
false |
unversioned.ListMeta
ListMeta定义了综合资源的元数据，包括列表或各种状态对象。一个资源只能有ObjectMeta和ListMeta中的一个。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
selfLink |
SelfLink是当前对象的URL。该字段由系统生成的，是一个只读字段。 |
false |
string |
|
resourceVersion |
用来表示当前对象的内部版本号，client端根据这个字段来判断对象是否已经发生变化。它也能用在optimistic concurrency，变化检测和监控外界对一个或者一组资源做了哪些操作。client端必须显式地对待这些值，并且不做任何修改地传递给server端。这个字段可能只对特定资源有效。该字段由系统生成的，是一个只读字段。 详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
false |
string |
v1.ResourceQuotaList
ResourceQuotaList is a list of ResourceQuota items.
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
Items is a list of ResourceQuota objects. 详情查看：http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota |
true |
v1.ResourceQuota array |
v1.PersistentVolumeClaimStatus
PersistentVolumeClaimStatus是一个持久存储卷声明的当前状态。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
phase |
Phase代表一个PersistentVolumeClaim处于哪个阶段。 |
false |
string |
|
accessModes |
AccessModes包含了支持当前PVC声明的存储卷的访问模式。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1 |
false |
||
capacity |
底层存储卷的实际资源量。 |
false |
v1.EndpointSubset
EndpointSubset是一组带有端口号的地址。扩展endpoint集是由地址和端口号构成的坐标集。举个例子：
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
}
上面的endpoint集最终可以写成如下形式：
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
b: [ 10.10.1.1:309, 10.10.2.2:309 ]
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
addresses |
拥有端口号的IP地址，ip和对应的端口号构成可访问的endpoints (系统标记为ready)，这些endpoints可以用来做负载均衡，以供client端使用。 |
false |
v1.EndpointAddress array |
|
notReadyAddresses |
拥有端口号的IP地址，但是IP和对应的端口号构成的endpoints由于某些原因而没有被系统标记为ready。可能的原因有：尚未初始化成功、未能通过最近一次的可用性检查(readiness check)，或者未能通过最近一次的活性检查(liveness check)。 |
false |
v1.EndpointAddress array |
|
ports |
端口号，与相关联的IP地址可构成 可用的endpoints。 |
false |
v1.EndpointPort array |
v1.SecretVolumeSource
SecretVolumeSource会修改Secret使其适用于VolumeSource。详情查看：http://releases.k8s.io/HEAD/docs/design/secrets.md
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
secretName |
SecretName是在当前pod的命名空间中 一个secret的名字。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets |
true |
string |
v1.EnvVarSource
EnvVarSource表示环境变量(EnvVar)值的来源。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
fieldRef |
用于加密pod的一个字段，目前只支持加密Name和Namespace。 |
true |
v1.LoadBalancerIngress
LoadBalancerIngress表示负载均衡器的入口状态，对应服务的所有流量都应该被发往该入口。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
ip |
如果负载均衡器入口是基于IP的，比如GCE或者openstack的均衡器，那么会设置IP字段。 |
false |
string |
|
hostname |
如果负载均衡器入口是局域DNS的，比如AWS的均衡器，那么会设置hostname字段。 |
false |
string |
v1.Service
Service是对软件服务(比如mysql)的命名抽象，它是由两部分组成：1. 代理监听的本地端口(比如3306)；2. 用于确定哪些pods应答请求的选择器(selector)。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了一个servicce的行为。http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
最近一次观察到的service的状态。该字段由系统生成的，是一个只读字段。 详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.ServiceAccountList
ServiceAccountList是一组ServiceAccount对象。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
ServiceAccount列表。详情查看：http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts |
true |
v1.ServiceAccount array |
v1.LimitRangeList
LimitRangeList一组LimitRange条目。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组LimitRange对象。详情查看：http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md |
true |
v1.LimitRange array |
v1.Endpoints
Endpoints用来支撑service的endpoints集合，实际的请求都是要通过service分发到不同的endpoints去处理。例如：
Name: "mysvc",
Subsets: [
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
},
{
Addresses: [{"ip": "10.10.3.3"}],
Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
},
]
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
subsets |
所有endpoints子集合(subset)的并集。不同的地址(addresses)根据他们共享的IP被放到不同的子集合中。一个具有多个端口的地址(address)，如果一些端口是ready，而另一些由于来自于不同的容器而not ready，可能会在多个子集合中显示，但是会带有不同的端口号。任何一个地址，都不可能在同一个子集合的Addresses和NotReadyAddresses字段中同时存在。地址和端口号的集合组成一个service。 |
true |
v1.EndpointSubset array |
v1.DeleteOptions
DeleteOptions可能会在删除一个API对象时提供。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
gracePeriodSeconds |
定义了对象将在多少秒后删除，必须是非负值。该字段为0意味着立即删除。如果该字段为空(nil)，将采用默认值。如果没有指定默认值，那么将采用该对象的值。 |
true |
integer (int64) |
v1.Volume
Volume表示pod中的一个已命名存储卷，该存储卷可以被pod中的所有容器访问。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
存储卷名字。必须是一个DNS）LABEL，并且在一个pod中必须是唯一的。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
true |
string |
|
hostPath |
HostPath是指存储卷在宿主机上的文件/目录路径，该路径被直接暴露给容器。只有系统级Agent或者享有特权的进程才允许查看宿主机文件系统，因此大多数容器不需要这个字段。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath |
false |
||
emptyDir |
EmptyDir表示一个临时目录，其生命周期与所在的pod一致。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir |
false |
||
gcePersistentDisk |
GCEPersistentDisk表示GCE磁盘资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
false |
||
awsElasticBlockStore |
AWSElasticBlockStore代表AWS磁盘资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
false |
||
gitRepo |
GitRepo表示一个特定版本的git 仓库。 |
false |
||
secret |
Secret是存在于存储卷中的secret。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets |
false |
||
nfs |
NFS代表一次宿主机上的nfs磁盘挂载，随pod产生而挂载，随pod删除卸载。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs |
false |
||
iscsi |
ISCSI代表ISCSI磁盘资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。详情查看：http://releases.k8s.io/HEAD/examples/iscsi/README.md |
false |
||
glusterfs |
Glusterfs代表一次宿主机上的Glusterfs磁盘挂载，随pod产生而挂载，随pod删除卸载。 详情查看：http://releases.k8s.io/HEAD/examples/glusterfs/README.md |
false |
||
persistentVolumeClaim |
PersistentVolumeClaimVolumeSource表示指向同一个命名空间下一个PersistentVolumeClaim的索引。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims |
false |
||
rbd |
RBD代表一次宿主机上的Rados块设备挂载，随pod产生而挂载，随pod删除卸载。详情查看：http://releases.k8s.io/HEAD/examples/rbd/README.md |
false |
||
cinder |
Cinder表示一个cinder存储卷，它被挂载到运行kubelet的宿主机上。详情查看：http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
||
cephfs |
CephFS代表一次宿主机上的Ceph文件系统挂载，随pod产生而挂载，随pod删除卸载。 |
false |
||
flocker |
Flocker表示一个Flocker存储卷，它被挂载到运行着kubelet的宿主机上，依赖于Flocker control service的正常运行。 |
false |
||
downwardAPI |
DownwardAPI代表使用该存储卷的pod的下行Api。 |
false |
||
fc |
FC表示一个Fibre Channel资源，它被挂载到运行着kubelet的宿主机上，直接暴露给pod。 |
false |
integer
v1.Probe
Probe (探针)描述了一个将对容器执行的健康状态检查，以确定该容器在运行中并且可以处理请求。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
exec |
Exec定义了要执行的动作，必须且只能指定下面的一个动作(tbd)。 |
false |
||
httpGet |
HTTPGet定义了一个将要发送的http请求。 |
false |
||
tcpSocket |
TCPSocket定义了一个将要发送的tcp请求，目前尚不支持tcp钩子。 |
false |
||
initialDelaySeconds |
容器启动以后，需要等待一段时间才去初始化探针。该字段表示等待的秒数。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
false |
integer (int64) |
|
timeoutSeconds |
探针运行的超时时间，默认为1秒，最小值为1。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
false |
integer (int64) |
|
periodSeconds |
运行探针程序的周期（以秒为单位），默认是10秒，最小值为1。 |
false |
integer (int64) |
|
successThreshold |
探针运行失败系统认定容器不可用以后，至少连续运行 |
false |
integer (int32) |
|
failureThreshold |
探针运行成功系统认定容器可用以后，至少连续运行 |
false |
integer (int32) |
v1.ReplicationController
ReplicationController表示一个replication controller的配置。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
如果ReplicationController的labels为空，metadata被默认为与该replication controller管理的pod是一致的。标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了replication controller期望行为的规格。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status是最近一次观察到的replication controller的状态。由于窗口期(window time),改状态可能与实际状态不符。该字段由系统生成的，是一个只读字段。 详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.Capability
v1.LimitRange
LimitRange设定了一个Namespace中每种资源的使用率限制。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了要实施的资源限制。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.DownwardAPIVolumeFile
DownwardAPIVolumeFile表示包含pod字段的文件的信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
path |
必填字段。表示要创建的文件的相对路径，不能包含任何绝对路径或者".."，必须采用utf8编码。该字段的第一部分不能以".."开头。 |
true |
string |
|
fieldRef |
必填字段。可以选择pod的某个字段，目前支持annotations, labels, name, namespace。 |
true |
v1.PodStatus
PodStatus代表一个pod的状态信息。PodStatus会跟踪系统的实际运行状态。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
phase |
pod当前运行在哪个阶段(pending, running, etc.)。 详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-phase |
false |
string |
|
conditions |
pod当前的服务状态。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions |
false |
v1.PodCondition array |
|
message |
人可读的信息，包含了Pod处于当前状态原因详情。 |
false |
string |
|
reason |
以驼峰式显示的简单信息，包含了Pod处于当前状态的原因，比如"OutOfDisk |
false |
string |
|
hostIP |
pod所在的宿主机的ip地址。如果pod还没有被scheduled，那么该字段为空。 |
false |
string |
|
podIP |
Pod的IP地址，在集群内可访问。如果还没有分配，则该字段为空。 |
false |
string |
|
startTime |
遵循RFC3339格式的时间，表示kubelet认可该对象的时间，该时间一般在kubelet为Pod拉取镜像之前。 |
false |
string |
|
containerStatuses |
在Manifest中，每个容器都有一个条目。该字段是一个条目。这些条目和 |
false |
v1.ContainerStatus array |
v1.PodSpec
PodSpec是pod的描述。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
volumes |
一组可被pod内容器挂载的存储卷。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md |
false |
v1.Volume array |
|
containers |
一组隶属于当前pod的容器。目前尚不支持pod内容器的增加和删除。每个Pod内必须至少有一个容器。该字段不能被更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/containers.md |
true |
v1.Container array |
|
restartPolicy |
pod内所有容器的重启策略，目前有三种：Always (总是), OnFailure (失败时重启), Never(不重启)。默认值为Always。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy |
false |
string |
|
terminationGracePeriodSeconds |
需要优雅地终止pod时，可选的时间间隔 (单位：秒)。在client端发送删除请求时，该字段可以被缩减，但必须是非负值。如果值为0，则意味着立即删除。如果该字段为空(nil)，将使用默认值。Grace Period(缓冲期) 是指pod中运行的进程从接收到一个termination信号到接收到kill信号被强制杀死之间的一段时间，单位是秒。考虑到进程进行自我清理的时间，terminationGracePeriodSeconds要设置得稍微长一些。默认值为30s。 |
false |
integer (int64) |
|
activeDeadlineSeconds |
(tbd) Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
false |
integer (int64) |
|
dnsPolicy |
pod内部容器的DNS策略，可以是：ClusterFirst或Default. 默认采用"ClusterFirst"。 |
false |
string |
|
nodeSelector |
NodeSelector是一个选择器，pod通过它选择分配到哪些节点上。只有当pod的该字段与节点的labels匹配时，才会被分配。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md |
false |
||
serviceAccountName |
ServiceAccountName是用来运行当前pod的ServiceAccount。详情查看：http://releases.k8s.io/HEAD/docs/design/service_accounts.md |
false |
string |
|
serviceAccount |
DeprecatedServiceAccount是ServiceAccountName的别名，目前已作废，请使用ServiceAccountName。 |
false |
string |
|
nodeName |
NodeName请求将当前pod分配到特定节点。如果该字段非空，则调度器会假设该节点满足pod的资源需求，而简单地把当前pod分配到指定的节点。 |
false |
string |
|
hostNetwork |
为当前pod请求到的宿主机网络，使用宿主机网络的命名空间。如果该选项设置为true，则必须指定pod要使用的端口号。默认为false。 |
false |
boolean |
false |
hostPID |
使用宿主机的pid命名空间。该字段是可选字段，默认值为false。 |
false |
boolean |
false |
hostIPC |
使用宿主机的ipc命名空间。该字段是可选字段，默认值为false。 |
false |
boolean |
false |
securityContext |
SecurityContext保存了pod级别的安全属性和常用的容器设置。该字段是可选字段，默认为空。每个字段的默认值会有所不同，具体查阅字段对应的type description。 |
false |
||
imagePullSecrets |
ImagePullSecrets是一组可选的引用，它们只想同意命名空间下的secret，PodSepc使用这些secret拉取镜像。如果指定了该值，这些secrets将会被发送到每一个独立的镜像拉取对象。例如，对于docker而言，只有DockerConfig类型额secret才有效。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod |
false |
v1.LocalObjectReference array |
v1.ContainerPort
ContainerPort代表了单个容器的网络端口。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
如果指定改名字，那么必须是一个IANA_SVC_NAME，并且在pod内是唯一的。pod内的每个已命名port对象都必须有一个唯一的name。services可以通过name来定位该port对象。 |
false |
string |
|
hostPort |
映射到主机上的端口号。如果指定它的值，则必须是一个有效的端口号(0~65535)。如果指定了HostNetwork字段，那么它必须与ContainerPort字段匹配。大多数容器不需要使用该字段。 |
false |
integer (int32) |
|
containerPort |
映射到pod IP地址上的端口号，0~65535。 |
true |
integer (int32) |
|
protocol |
该端口对象使用的协议，必须是UDP或TCP。默认值是"TCP". |
false |
string |
|
hostIP |
将external port绑定到的IP。 |
false |
string |
v1.ResourceQuota
ResourceQuota设置了每个命名空间的总计资源限制。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec定义了期望的配额。http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status表示实际的资源配额和当前的使用率。http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.EventList
EventList是一组事件(event)。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组事件对象列表。 |
true |
v1.Event array |
v1.Lifecycle
Lifecycle描述了管理系统应对容器生命周期事件所采取的的一系列动作。对于PostStart和PreStop动作会阻塞容器操作直到动作完成。有一个情况例外：容器运行失败时，处理函数被丢弃。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
postStart |
PostStart动作会在容器创建以后立即被执行。如果动作执行失败，容器会被终止，并根据重启策略重启。在当前动作结束之前，对于该容器的任何其他操作都会被阻塞。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details |
false |
||
preStop |
PreStop动作会在容器终止以后立即被执行，该动作执行完成以后容器即终止。不管该动作执行结果如何，容器最终都会被终止。在当前动作结束之前，对于该容器的任何其他操作都会被阻塞。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details |
false |
v1.ReplicationControllerSpec
ReplicationControllerSpec描述了replication controller的规格。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
replicas |
Replicas指定了期望的副本(replica)数量。这是一个指针类型，可以区分0和nil。默认值为1。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller |
false |
integer (int32) |
|
selector |
Selector是一个针对pod的label查询规格，查询结果应该与replicas字段的值一致。如果该字段为空，则默认采用pod模板中的labels。Label的键和值都必须与该Selector匹配，replication controller才能操作关联的pods。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors |
false |
||
template |
Template用来检测replica数量，如果不满足replicas字段定义的值，那么会创建新的pod。如果TemplateRef字段也被设置，那么优先使用本字段。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#pod-template |
false |
v1.NodeStatus
NodeStatus指节点的当前状态信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
capacity |
Capacity表示节点的可用资源。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity for more details. |
false |
||
phase |
NodePhase表示节点处于生命周期中的那个阶段。详情查看：http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase |
false |
string |
|
conditions |
Conditions指一组最近探测到的节点状态信息。详情查看：http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition |
false |
v1.NodeCondition array |
|
addresses |
一组可访问的地址，如果有的话，可以从云服务提供商获取到。详情查看：http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses |
false |
v1.NodeAddress array |
|
daemonEndpoints |
运行在该节点上的 后台程序暴露出来的Endpoints。 |
false |
||
nodeInfo |
用来唯一识别一个节点的ids/uuids集合。详情查看：http://releases.k8s.io/HEAD/docs/admin/node.md#node-info |
false |
v1.GlusterfsVolumeSource
GlusterfsVolumeSource表示一次Glusterfs磁盘挂载，随pod创建挂载，随pod删除卸载。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
endpoints |
EndpointsName即endpoint名字， 通过这个endpoint可以读取Glusterfs的拓扑结构。详情查看：http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod |
true |
string |
|
path |
Path是当前Glusterfs存储卷的路径。详情查看：http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod |
true |
string |
|
readOnly |
ReadOnly字段用来保证挂载Glusterfs存储卷时采用只读模式。默认值为false。详情查看：http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod |
false |
boolean |
false |
v1.Handler
Handler定义了一个动作(action)。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
exec |
Exec定义了要执行的动作，必须且只能指定下面的一个动作(tbd)。 |
false |
||
httpGet |
HTTPGet定义了一个将要发送的http请求。 |
false |
||
tcpSocket |
TCPSocket定义了一个将要发送的tcp请求，目前尚不支持tcp钩子。 |
false |
v1.EventSource
EventSource包含了一个事件的信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
component |
Component是产生event的源。 |
false |
string |
|
host |
Host表示event是在哪台机器上产生的。 |
false |
string |
v1.PodCondition
PodCondition包含了pod的当前状态详情。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
type |
Type是conditon的类型，目前只有 Ready。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions |
true |
string |
|
status |
Status是condition的状态，可以为True、False或Unknown。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions |
true |
string |
|
lastProbeTime |
最近一次获取condition信息的时间。 |
false |
string |
|
lastTransitionTime |
最后一次condition状态发生变化的时间。 |
false |
string |
|
reason |
最后一次condition状态发生变化的时间。特点：唯一性、单个词语描述、驼峰式显示。 |
false |
string |
|
message |
最后一次condition状态变化的详情，以人可读的方式显示。 |
false |
string |
v1.RBDVolumeSource
RBDVolumeSource表示一次Rados块设备挂载，随pod创建挂载，随pod删除卸载。
v1.PodTemplate
PodTemplate定义了一个用于创建pod副本的模板。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
template |
Template表明pod将会基于这个模板创建。http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.ServiceStatus
ServiceStatus表示service的当前状态。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
loadBalancer |
LoadBalancer是指负载均衡器的当前状态。前提是设置了负载均衡器。 |
false |
v1.NFSVolumeSource
NFSVolumeSource表示一次NFS磁盘挂载。随pod创建挂载，随pod删除卸载。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
server |
Server表示NFS服务器的域名或者ip地址。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs |
true |
string |
|
path |
Path是指NFS设置的exports路径。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs |
true |
string |
|
readOnly |
ReadOnly设置是否以只读方式挂载NFS export，默认值是false。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs |
false |
boolean |
false |
v1.FCVolumeSource
只能以read/write模式挂载一次的光纤磁盘。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
targetWWNs |
必填字段：FC目标磁盘的全局名称(WWN)。 |
true |
string array |
|
lun |
必填字段：FC目标磁盘的逻辑单元号。(tbd) |
true |
integer (int32) |
|
fsType |
必填字段：磁盘的文件系统类型，必须是宿主机操作系统支持的类型，比如"ext4", "xfs", "ntfs"。 |
true |
string |
|
readOnly |
可选字段，默认为false(read/write)。该选项保证挂载数据卷时将其设置为只读。 |
false |
boolean |
false |
v1.EndpointPort
EndpointPort是描述单个port对象的元组。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
port对象的名字，与ServicePort.Name对应。必须是DNS_LABEL。如果已经定义了port字段的值，该字段是可选的。 |
false |
string |
|
port |
endpoint的端口号 |
true |
integer (int32) |
|
protocol |
该port对象使用的协议，必须是UDP或者TCP。默认值为TCP。 |
false |
string |
v1.TCPSocketAction
TCPSocketAction定义了对socket的动作。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
port |
访问容器需要的port对象的端口号或名字。端口号必须是1~65535，名字必须是IANA_SVC_NAME。 |
true |
string |
unversioned.StatusDetails
StatusDetails是一组附加属性，server端返回响应时，可能会添加。Reason字段会说明包含了哪些附加字段。client端可以忽略不匹配的属性，并且默认所有附加属性均为empty、invalid或者undefined。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
StatusReason相关的资源的name属性。前提是该资源只有一个名字。 |
false |
string |
|
kind |
StatusReason相关的资源的kind属性。对于某些操作，这个字段的值可能会与请求到的资源kind不同。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
causes |
status为failure时，StatusReason的详细信息。并不是所有的StatusReasons都会提供详细额原因。 |
false |
unversioned.StatusCause array |
|
retryAfterSeconds |
如果设置了该字段，(tbd) If specified, the time in seconds before the operation should be retried. |
false |
integer (int32) |
v1.HTTPGetAction
HTTPGetAction定义了对HTTP Get请求的动作。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
path |
访问HTTP server的路径。 |
false |
string |
|
port |
port对象的名字或者端口号，可以用来访问容器。端口号必须是1~65535，名字必须是IANA_SVC_NAME。 |
true |
string |
|
host |
要连接的域名，默认是pod IP。 |
false |
string |
|
scheme |
连接host使用的协议(Scheme)，默认是HTTP。 |
false |
string |
v1.LoadBalancerStatus
LoadBalancerStatus表示一个负载均衡器的状态。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
ingress |
Ingress是负载均衡器的一组入口。发往service的流量应该被发送到这些入口。 |
false |
v1.LoadBalancerIngress array |
v1.SecretList
SecretList是一组secret。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
Items是一组secret对象。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/secrets.md |
true |
v1.Secret array |
v1.Container
要运行在pod中的单应用容器。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
容器名字，会被用作DNS_LABEL。pod中的每个容器都必须有一个唯一的名字(DNS_LABEL)。名字一旦确定就不能更改。 |
true |
string |
|
image |
Docker镜像名。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/images.md |
false |
string |
|
command |
指令入口数组。注意：这些指令不在shell中执行。如果未设置该字段，那么使用docker镜像自带的指令入口(CMD)。使用环境变量时，变量名$(VAR_NAME)会被展开。如果使用了不存在的环境变量，那么输入字符串不会改变(即不展开环境变量名)。T可以使用$$对环境变量中的$进行转义。不管环境变量是否存在，转义的环境变量名都不会被展开。环境变量一旦设置，就无法更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands |
false |
string array |
|
args |
指令入口参数列表。如果未设置该字段，那么使用docker镜像自带的指令入口(CMD)。使用环境变量时，变量名$(VAR_NAME)会被展开。如果使用了不存在的环境变量，那么输入字符串不会改变(即不展开环境变量名)。可以使用$$对环境变量中的$进行转义。不管环境变量是否存在，转义的环境变量名都不会被展开。环境变量一旦设置，就无法更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands |
false |
string array |
|
workingDir |
容器运行的当前目录，与docker默认目录一致，即docker镜像中设置的目录。一旦设置，就无法更改。 |
false |
string |
|
ports |
从容器暴露出来的一组port对象。该字段不能更改。 |
false |
v1.ContainerPort array |
|
env |
容器中设置的一组环境变量。该字段不能更改。 |
false |
v1.EnvVar array |
|
resources |
计算出该容器需要的资源。该字段不能更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources |
false |
||
volumeMounts |
挂载到容器文件系统的Pod存储卷。该字段不能更改。 |
false |
v1.VolumeMount array |
|
livenessProbe |
周期性探测容器活性的探针。如果探测失败，系统将会重启容器。该字段不能更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
false |
||
readinessProbe |
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. 详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
false |
||
lifecycle |
系统对容器事件采取的动作。该字段不能更改。 |
false |
||
terminationMessagePath |
可选字段。容器终止时，要把终止信息写入到容器文件系统的某个路径下。写入的信息一般是一个简短的最终状态表述，比如assertion failure。默认路径是/dev/termination-log。该字段不能更改。 |
false |
string |
|
imagePullPolicy |
Image拉取策略，有以下几种：Always, Never, IfNotPresent。如果指定镜像tag为:latest，那么默认是Always；否则，默认是IfNotPresent。该字段不能更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images |
false |
string |
|
securityContext |
Pod运行时携带的安全配置项。详情查看：http://releases.k8s.io/HEAD/docs/design/security_context.md |
false |
||
stdin |
容器是否在运行时给stdin分配了buffer。如果该字段没有设置，从容器的stdin读取数据会返回EOF。该字段默认值为false。 |
false |
boolean |
false |
stdinOnce |
容器运行时是否在一个client读取stdin以后，就关闭stdin防止其它的client读取。如果stdin字段被设置为true，那么stdin会允许多个client去读取。如果stdinOnce被设置为true，那么stdin会在容器启动时开放，第一个连接它的client会写入数据，断开以后，stdin也会关闭。除非容器重启，stdin才会打开。如果设置成false，容器中读取stdin的进程永远都不会接收到EOF。该字段默认为false。 |
false |
boolean |
false |
tty |
容器是否给自己分配一个tty。如果分配的话，需要设置stdin为true。该字段默认值是false。 |
false |
boolean |
false |
v1.PersistentVolumeSpec
PersistentVolumeSpec表示持久存储卷的规格。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
capacity |
持久存储卷资源和容量。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity |
false |
||
gcePersistentDisk |
GCEPersistentDisk表示GCE磁盘资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。该磁盘由管理员配置。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk |
false |
||
awsElasticBlockStore |
AWSElasticBlockStore表示AWS磁盘资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
false |
||
hostPath |
HostPath表示宿主机上的一个目录，由开发者或测试人员配置。这只是用作单节点的开发和测试，不能用作生产环境。该模式不支持磁盘挂载，也不能再多节点集群中使用。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath |
false |
||
glusterfs |
Glusterfs表示Glusterfs磁盘资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。该磁盘由管理员设置。详情查看：http://releases.k8s.io/HEAD/examples/glusterfs/README.md |
false |
||
nfs |
NFS表示挂载到宿主机上的nfs磁盘，由管理员设置。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs |
false |
||
rbd |
RBD 表示Rados块设备，它被挂载到运行kubelet的宿主机上，直接暴露给pod。详情查看：http://releases.k8s.io/HEAD/examples/rbd/README.md |
false |
||
iscsi |
ISCSI表示ISCSI磁盘资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。该磁盘由管理员设置。 |
false |
||
cinder |
Cinder表示Cinder存储卷，它被挂载到运行kubelet的宿主机上，直接暴露给pod。该磁盘由管理员设置。详情查看：http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
||
cephfs |
CephFS表示Ceph文件系统存储卷，它被挂载到运行kubelet的宿主机上，直接暴露给pod。 |
false |
||
fc |
FC表示Fibre Channel资源，它被挂载到运行kubelet的宿主机上，直接暴露给pod。 |
false |
||
flocker |
Flocker表示一个Flocker存储卷，它被挂载到运行着kubelet的宿主机上，依赖于Flocker control service的正常运行。 |
false |
||
accessModes |
AccessModes包含了所有数据卷挂载方式。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes |
false |
||
claimRef |
ClaimRef是PersistentVolume和PersistentVolumeClaim双向绑定的一部分。绑定时，该值non-nil. claim.VolumeName是比较权威(tbd)的PV和PVC绑定。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#binding |
false |
||
persistentVolumeReclaimPolicy |
定义了一个持久存储卷被对应的PVC释放时要做的操作。可选项有两个：Retail(default)和Recycle。Recycle (回收)操作必须通过持久存储卷底层插件来提供支持。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#recycling-policy |
false |
string |
v1.PodSecurityContext
PodSecurityContext包含了pod级别的安全属性和常见的容器配置。container.securityContext的优先级要高于PodSecurityContext。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
seLinuxOptions |
会应用到该宿主机上所有容器的SELinux配置。如果不指定该字段，容器运行时会随机为容器分配一个SELinux配置。也可以在SecurityContext中设置该选项。如果在SecurityContext和PodSecurityContext中均设置了该选项，优先采用SecurityContext中的配置。 |
false |
||
runAsUser |
运行容器进程CMD的用户id(UID)。如果不指定该字段，则默认采用镜像metadata中的UID置。也可以在SecurityContext中设置该选项。如果在SecurityContext和PodSecurityContext中均设置了该选项，优先采用SecurityContext中的配置。 |
false |
integer (int64) |
|
runAsNonRoot |
容器是否必须在非root用户下运行。如果该字段为true，kubelet将会在运行时验证镜像，以保证容器不是作为root(UID=0)用户启动的，如果镜像验证不通过，那么将无法启动容器。如果不设置该字段，或者设置为false，那么kubelet将不执行类似的镜像检查。也可以在SecurityContext中设置该选项。如果在SecurityContext和PodSecurityContext中均设置了该选项，优先采用SecurityContext中的配置。 |
false |
boolean |
false |
supplementalGroups |
与容器的Group类似，但除容器的GID之外，应用到容器第一个进程的组。如果不指定该字段，没有任何组会被添加到容器中。 |
false |
[integer] array |
|
fsGroup |
一个应用到pod中所有容器的特殊的组。一些存储卷类型允许Kubelet改变pod拥有的对应存储卷: |
false |
integer (int64) |
v1.ReplicationControllerStatus
ReplicationControllerStatus represents the current status of a replication controller.
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
replicas |
Replicas是最近探测到的pod副本的数量。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller |
true |
integer (int32) |
|
observedGeneration |
ObservedGeneration反应了最近观察到的replication controller的generation(tbd)。 |
false |
integer (int64) |
v1.FinalizerName
v1.ServicePort
ServicePort包含了service的端口信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
当前端口对象的名字，必须是DNS_LABEL。一个ServiceSpec对象中的所有port对象都必须有唯一的名字。该字段会映射到EndpointPort对象的Name字段。如果在一个Service中有且只有一个ServicePort已经定义，那么该字段是可选的。 |
false |
string |
|
protocol |
本port对象使用的IP协议，支持"TCP"和"UDP"，默认是TCP。 |
false |
string |
|
port |
当前service对外暴露的端口号 |
true |
integer (int32) |
|
targetPort |
当前service用于访问pods的端口号或者端口名字。如果是端口号，则必须是1~65535.如果是名字，则必须是IANA_SVC_NAME。如果该字段是一个字符串，系统将会在目标pod中的容器中的所有port对象中查找该端口。如果不指定该字段，系统将使用Port对象的值(一组端口映射）。该字段的默认是为service的端口号。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/services.md#defining-a-service |
false |
string |
|
nodePort |
设置type=NodePort或者LoadBalancer时，service暴露到宿主机上的端口。通常是由系统分配的。如果指定了该端口，如果该端口号没有被占用，将会分配给该服务；如果宿主机上该端口被占用，那么将分配失败。默认情况下，如果ServiceType需要的话，系统会自动分配一个。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/services.md#type—nodeport |
false |
integer (int32) |
v1.ComponentCondition
组件的状态信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
type |
组件的condition类型，目前有效值："Healthy" |
true |
string |
|
status |
组件的condition状态。目前有效值为："Healthy": "True", "False", or "Unknown"。 |
true |
string |
|
message |
组件的condition信息，比如说：一次健康状态检查返回的信息。 |
false |
string |
|
error |
组件的Condition错误码，比如一次健康状态检查返回的错误码。 |
false |
string |
v1.ComponentStatusList
组件的所有condition的状态，类型是ComponentStatus列表。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组ComponentStatus对象。 |
true |
v1.ComponentStatus array |
v1.HostPathVolumeSource
HostPathVolumeSource表示宿主机的目录。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
path |
宿主机上目录的路径。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath |
true |
string |
json.WatchEvent
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
type |
要监控的事件的类型，可以是：ADDED, MODIFIED, DELETED, 或 ERROR。 |
false |
string |
|
object |
被监控的对象，它的类型与资源endpoint的类型相匹配。如果类型为ERROR，该对象是一个Status对象。 |
false |
string |
v1.Binding
Binding将两个对象绑定在一起。比如，pod与node通过scheduler(调度器)绑定在一起。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
target |
要绑定到当前对象的目标对象。 |
true |
v1.ContainerStateTerminated
ContainerStateTerminated表示容器的终止状态。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
exitCode |
容器终止时的退出状态(返回值)。 |
true |
integer (int32) |
|
signal |
容器终止时接收到的信号。 |
false |
integer (int32) |
|
reason |
容器终止的原因。 |
false |
string |
|
message |
容器的终止信息。= |
false |
string |
|
startedAt |
最近一次容器启动的时间。 |
false |
string |
|
finishedAt |
最近一次容器终止的时间。 |
false |
string |
|
containerID |
容器的ID，以docker://<container_id>的格式显示。 |
false |
string |
v1.CinderVolumeSource
CinderVolumeSource表示Openstack中的一个cinder存储卷。Cinder存储卷必须在挂载到容器之前就存在，必须和kubelet所在的地域相同。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
volumeID |
唯一表示一个cinder存储卷的ID。详情查看：http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
true |
string |
|
fsType |
必填字段：磁盘的文件系统类型，必须是宿主机操作系统支持的类型，目前只支持"ext3"和"ext4"。详情查看：http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
string |
|
readOnly |
可选字段，默认为false(read/write)。该选项保证挂载数据卷时将其设置为只读。详情查看：http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
boolean |
false |
v1.SecurityContext
SecurityContext是容器的安全配置。一些配置选项在SecurityContext和PodSecurityContext都会出现，如果两个地方均有设置，那么优先采用SecurityContext中的配置。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
capabilities |
容器运行时是否可以add/drop安全配置。默认采用容器运行环境的配置。 |
false |
||
privileged |
是否在特权模式下运行容器。特权模式下运行的容器，其中的进程权限与宿主机上root用户的权限一样大。该字段默认值为false。 |
false |
boolean |
false |
seLinuxOptions |
容器的SELinux选项。如果不指定该选项，容器运行外环境会随机指定一个SELinux选项。该选项也可以在PodSecurityContext中设置，如果在SecurityContext和PodSecurityContext均有设置，优先采用SecurityContext中的设置。 |
false |
||
runAsUser |
运行容器进程CMD的用户ID(UID)。如果不指定，则默认采用容器镜像中的设置。该选项也可以在PodSecurityContext设置，如果在SecurityContext和PodSecurityContext均有设置，优先采用SecurityContext中的设置。 |
false |
integer (int64) |
|
runAsNonRoot |
容器是否必须非root用户下运行。如果该字段为true，Kubelet会校验镜像以确保容器不在root用户(UID 0)下运行，一旦检测到，容器就会启动失败。如果不设置该字段或者将其设置为false，那么就不会执行校验操作。该选项也可以在PodSecurityContext设置，如果在SecurityContext和PodSecurityContext均有设置，优先采用SecurityContext中的设置。 |
false |
boolean |
false |
v1.ContainerState
ContainerState表示容器可能所处的状态。只能指定下面字段中的一个，如果不指定，则默认是ContainerStateWaiting。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
waiting |
容器的等待状态信息 |
false |
||
running |
容器运行状态信息 |
false |
||
terminated |
容器终止状态信息 |
false |
v1.AWSElasticBlockStoreVolumeSource
表示AWS上的持久存储卷。
Amazon Elastic Block Store (EBS)在被kubelet挂载之前，必须提前被创建、格式化，并且和kubelet在同一个可用区中。注意：AWS EBS存储卷一次只能被挂载到一个实例上。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
volumeID |
AWS EBS存储卷的唯一标识ID。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
true |
string |
|
fsType |
要挂载的存储卷的文件类型。提示：必须保证宿主操作系统支持存储卷的文件类型，比如ext4, xfs, ntsf。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
true |
string |
|
partition |
指定你要挂载的是存储卷的哪个分区。如果不设置，默认通过存储卷名字挂载。例如，对于存储卷/dev/dsa1，你指定了了分区号为"1"，类似地，存储卷分区/dev/sda的分区号为"0"(也可以置空)。 |
false |
integer (int32) |
|
readOnly |
设置为true时，会将VolumeMounts下的ReadOnly属性置为true。如果不设置，默认为false。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore |
false |
boolean |
false |
v1.ContainerStatus
ContainerStatus包含容器当前状态的详情。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
必须是DNS_LABEL，同一个pod中的容器名字必须是唯一的，一旦创建无法更改。 |
true |
string |
|
state |
容器当前状态详情。 |
false |
||
lastState |
容器的终止状态详情。 |
false |
||
ready |
容器是否已经传入了活性检测探针。 |
true |
boolean |
false |
restartCount |
容器被重启的次数，计数是基于已经死掉且没有被删除的容器个数。注意：由于垃圾回收机制，该值不会大于5。 |
true |
integer (int32) |
|
image |
容器使用的镜像。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/images.md |
true |
string |
|
imageID |
容器使用的镜像的ID。 |
true |
string |
|
containerID |
容器的ID，以docker://<container_id>的格式显示。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#container-information |
false |
string |
v1.ReplicationControllerList
ReplicationControllerList是replication controller的集合。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组replication controllers对象。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md |
true |
v1.ReplicationController array |
v1.NodeDaemonEndpoints
NodeDaemonEndpoints是运行在节点上的后台程序监听的所有端口。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kubeletEndpoint |
Kubelet监听的Endpoint |
false |
v1.Secret
Secret保存了特定类型的secret数据。该字段的长度必须必MaxSecretSize小(单位：字节)。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
data |
Data包含了secret数据。数据里的key必须是一个有效的DNS_SUBDOMAIN或者("."+DNS_SUBDOMAIN)。secret数据以base64方式序列化，因此可以显示任意格式的数据而不限于string类型。详情查看：https://tools.ietf.org/html/rfc4648#section-4 |
false |
||
type |
用来方便对secret数据进行程序化处理。 |
false |
string |
v1.Event
Event用于报告集群中发生的事件。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
true |
||
involvedObject |
与事件相关的对象。 |
true |
||
reason |
对象状态转变为当前状态的原因，以简短的、机器可读的字符串表示。 |
false |
string |
|
message |
当前状态的描述，以人可读的方式显示。 |
false |
string |
|
source |
报告该事件的组件，以简短的、机器可读的字符串表示。 |
false |
||
firstTimestamp |
该事件第一次被记录的时间，server接收到到事件的时间保存在TypeMeta中。 |
false |
string |
|
lastTimestamp |
该事件最近一次被记录的时间。 |
false |
string |
|
count |
该事件出现的次数。 |
false |
integer (int32) |
v1.EnvVar
EnvVar表示容器中的环境变量。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
name |
环境变量的名字，必须是C_IDENTIFIER。 |
true |
string |
|
value |
在容器或者service中预定义了环境变量$(VAR_NAME)时，变量名$(VAR_NAME)会被展开。如果使用了不存在的环境变量，那么输入字符串不会改变(即不展开环境变量名)。可以使用$$对环境变量中的$进行转义。不管环境变量是否存在，转义的环境变量名都不会被展开。环境变量一旦设置，就无法更改。该字段默认值为空字符串""。 |
false |
string |
|
valueFrom |
环境变量值的来源。如果该字段不为空，则不可用Source for the environment variable’s value. Cannot be used if value is not empty. (tbd) |
false |
v1.ResourceRequirements
ResourceRequirements定义了计算资源需求。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
limits |
允许使用的计算资源的上限。详情查看：http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications |
false |
||
requests |
需要的计算资源的下限。如果不设置容器的requests，默认为显式定义的limits。如果没有显式定义limits，则requests默认为实际值(implementation-defined value)。详情查看：http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications |
false |
v1.PersistentVolumeAccessMode
v1.ComponentStatus
ComponentStatus(也叫ComponentStatusList)保存了集群的校验信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
conditions |
一组组件状态对象。 |
false |
v1.ComponentCondition array |
v1.LimitRangeItem
LimitRangeItem定义了每种类型资源的使用量的上下限。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
type |
limit应用到的资源的类型。 |
false |
string |
|
max |
对于这类资源的最大使用限制。 |
false |
||
min |
对于这类资源的最小使用限制。 |
false |
||
default |
如果limit没有设置，则limit采用当前字段定义的值。 |
false |
||
defaultRequest |
如果request没有设置，则request采用当前字段定义的值。 |
false |
||
maxLimitRequestRatio |
如果设置了MaxLimitRequestRatio，则对应的资源必须设置非0值的request和limit，并且limit/request<=enumerated value="">(tbd)。当前字段表示对应资源的最大使用率。 |
false |
v1.PodTemplateSpec
PodTemplateSpec表示根据模板创建pod时携带的数据。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
pod期望行为的规格。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.PodList
PodList is a list of Pods.
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组pod对象。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/pods.md |
true |
v1.Pod array |
v1.ServiceList
ServiceList表示一组services。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组service对象。 |
true |
v1.Service array |
v1.PersistentVolumeList
PersistentVolumeList是一组持久存储卷(PersistentVolume)。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
一组持久存储卷对象。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md |
true |
v1.PersistentVolume array |
v1.ObjectReference
ObjectReference包含了被引用对象的信息，通过这些信息您可以探测或者修改被引用对象。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
被引用对象的类型(kind)。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
namespace |
被引用对象的命名空间。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md |
false |
string |
|
name |
被引用对象的名字。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names |
false |
string |
|
uid |
被引用对象的UID。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids |
false |
string |
|
apiVersion |
被引用对象的API version。 |
false |
string |
|
resourceVersion |
创建当前引用时，生成的resourceVersion。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
false |
string |
|
fieldPath |
如果当前引用指向的是某个对象的一部分，而不是整个对象，fieldPath是一个有效的JSON或Go语言对象，比如desiredState.manifest.containers[2]。举个例子，如果被引用对象是pod中的一个容器，当前字段的值就像这样："spec.containers{name}"，这里"name"是指触发事件的容器的名字；如果没有容器名字，是这样："spec.containers[2]"(这里是指pod中index为2的容器)。这种语法只能用于引用定义规范的对象。 |
false |
string |
unversioned.Status
Status是API调用的返回值。如果API调用不返回其它对象，则会返回该值。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准列表的元数据。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
status |
操作的状态，是"Success"或"Failure"。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
string |
|
message |
当前操作的状态，以人可读的方式表示。 |
false |
string |
|
reason |
操作状态处于"Failure"时，以机器可读的方式表示的原因信息。该字段为空意味着没有可用信息。Reason比HTTP状态码更清晰，但并不会覆盖HTTP状态码。 |
false |
string |
|
details |
基于reason字段的扩展信息。每个reason字段都有对相应的扩展信息。该字段是可选的，返回的数据符合reason类型定义，但不保证符合其他规格。 |
false |
||
code |
当前状态对应的的HTTP返回值。0意味着没有设置。 |
false |
integer (int32) |
v1.ContainerStateWaiting
ContainerStateWaiting容器的等待状态。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
reason |
简短的原因，描述为什么容器不是running状态。 |
false |
string |
|
message |
较为详细的原因，描述为什么容器不是running状态。 |
false |
string |
v1.NodeSystemInfo
NodeSystemInfo 是一组ids/uuids，以唯一地表示一个节点。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
machineID |
机器ID |
true |
string |
|
systemUUID |
System UUID |
true |
string |
|
bootID |
Boot ID |
true |
string |
|
kernelVersion |
内核版本，通过uname -r命令获取(e.g. 3.16.0-0.bpo.4-amd64). |
true |
string |
|
osImage |
操作系统发行版，从/etc/os-release获取。(e.g. Debian GNU/Linux 7 (wheezy)). |
true |
string |
|
containerRuntimeVersion |
容器运行环境版本，通过运行时远程API调用获取。(e.g. docker://1.5.0). |
true |
string |
|
kubeletVersion |
Kubelet版本。 |
true |
string |
|
kubeProxyVersion |
KubeProxy版本。 |
true |
string |
v1.ServiceSpec
ServiceSpec描述了用户创建的service的属性。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
ports |
service暴露出的ports。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies |
true |
v1.ServicePort array |
|
selector |
service会将流量转发给label与该selector匹配的pods。Pod的label key和value都必须匹配，才能接收到service的流量。如果将该字段置空，那么所有的pod都会被选中；如果不设置该字段，那么需要手动设置service的endpoint。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview |
false |
||
clusterIP |
ClusterIP一般是master赋给service的IP地址。如果指定了该值，并且尚未被其他service占用，那么会把该值分配给当前service；如果其它service已经使用了该值，那么创建service将会失败。该字段有效的值可以是：None, 空字符串(""), 或者一个有效的IP地址。None通常用于不需要proxy的无头service。该字段一旦创建，不能更改。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies |
false |
string |
|
type |
暴露出的service的类型。必须是ClusterIP, NodePort, 或LoadBalancer。默认值为ClusterIP。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/services.md#external-services |
false |
string |
|
externalIPs |
externalIPs是一组外网ip，集群中的节点会使用这些ip接收请求。这些IP不是由Kubernetes管理的，因此用户必须为打到这些节点上的流量负责。常用的例子是把外部的负载均衡器(haproxy,nginx)接入到Kubernetes系统。在v1之前，deprecatedPublicIPs字段实现了类似的功能。使用这个字段时，调用者应该清除deprecatedPublicIPs字段。 |
false |
string array |
|
deprecatedPublicIPs |
deprecatedPublicIPs是一个过时的字段，目前已经被externalIPs取代。为了保持向下兼容，介质2016年8月20日之前，这个字段任然会出现在v1的API中。任何新的API修改都会丢弃这个字段。如果你同时设置了deprecatedPublicIPs 和externalIPs，系统将使用deprecatedPublicIPs。 |
false |
string array |
|
sessionAffinity |
目前支持"ClientIP"和"None"。它用来维持会话亲和性，目前仅支持基于client端IP的方式。该字段默认值为None (round-robin方式选择endpoint)。详情查看：http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies |
false |
string |
|
loadBalancerIP |
只有当ServiceType为LoadBalancer时，此字段才生效。系统将依据该字段指定的IP创建负载均衡器。创建负载均衡器的操作还要依赖云服务提供商底层的网络支持。如果云服务供应商底层不支持该特性，那么该字段会被忽略。 |
false |
string |
v1.Pod
Pod是存在于一个宿主机上容器的集合，由client端创建，然后由server端分配到宿主机上。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
kind |
Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看：Kind 是指当前对象代表的REST资源类型。client端向endpoint提交请求时，server端可以根据client提交到的endpoint来推断出这个字段的值。该字段的值是不可变的，以驼峰风格显示。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
APIVersion定义了表征方式的版本信息，apiVersion不同意味着当前对象表述出来可能是不一样的。server端会自动识别该字段并将其转换为内部可识别的类型，如果无法识别该字段，则可能拒绝接收该对象。详情查看： http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
标准对象元数据。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Pod期望行为的规格。详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
最近一次观察到的Pod的状态，得到的数据可能与当前的实际情况不一致。该字段由系统生成的，是一个只读字段。 详情查看：http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.NodeSpec
NodeSpec描述了节点创建时拥有的属性。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
podCIDR |
PodCIDR表示分配到该节点上的Pod IP地址段。 |
false |
string |
|
externalID |
通过外部数据库给节点设置的外部ID (比如云服务提供商)。该字段已废弃。 |
false |
string |
|
providerID |
云服务供应商赋予的节点ID，以 <ProviderName>://<ProviderSpecificNodeID>的格式显示。 |
false |
string |
|
unschedulable |
当前节点是否不可调度，即是否可以将新pod分配到该节点上。默认情况下，当前节点是可调度的。详情查看：http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration"` |
false |
boolean |
false |
v1.EndpointAddress
EndpointAddress是描述单个IP地址对象的元组。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
ip |
endpoint的IP，不能是环路loopback (127.0.0.0/8), link-local (169.254.0.0/16), 和 link-local multicast ((224.0.0.0/24)。 |
true |
string |
|
targetRef |
指向一个对象的引用，该对象提供endpoint。 |
false |
v1.DaemonEndpoint
DaemonEndpoint包含了单个后台endpoint的信息。
| Name | 描述 | 是否必须 | 类型 | 默认值 |
|---|---|---|---|---|
Port |
特定endpoint的端口号。 |
true |
integer (int32) |
any
代表无类型的JSON map，详情查看关于此类对象的结构。