第 4 章 API 对象引用


4.1. 通用对象引用

4.1.1. io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList schema

描述
MutatingWebhookConfigurationList 是 MutatingWebhookConfiguration 列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(MutatingWebhookConfiguration)

MutatingWebhookConfiguration 列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.2. io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList schema

描述
ValidatingWebhookConfigurationList 是 ValidatingWebhookConfiguration 列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ValidatingWebhookConfiguration)

ValidatingWebhookConfiguration 列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.3. io.k8s.api.apps.v1.ControllerRevisionList schema

描述
ControllerRevisionList 是一个包含 ControllerRevision 对象列表的资源。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ControllerRevision)

items 是 ControllerRevisions 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.4. io.k8s.api.apps.v1.DaemonSetList schema

描述
DaemonSetList 是守护进程集的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(DaemonSet)

守护进程集列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.5. io.k8s.api.apps.v1.DeploymentList schema

描述
DeploymentList 是一个 Deployments 列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Deployment)

items 是 Deployments 列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。

4.1.6. io.k8s.api.apps.v1.ReplicaSetList schema

描述
ReplicaSetList 是 ReplicaSets 的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ReplicaSet)

ReplicaSets 列表。更多信息: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.7. io.k8s.api.apps.v1.StatefulSetList schema

描述
StatefulSetList 是 StatefulSets 的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(StatefulSet)

items 是有状态的集合的列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表的元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.8. io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList schema

描述
HorizontalPodAutoscalerList 是 pod 横向自动扩展对象的列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(HorizontalPodAutoscaler)

items 是 pod 横向自动扩展对象的列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

metadata 是标准列表元数据。

4.1.9. io.k8s.api.batch.v1.CronJobList schema

描述
CronJobList 是 cron 任务的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(CronJob)

items 是 CronJobs 的列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.10. io.k8s.api.batch.v1.JobList schema

描述
JobList 是作业的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Job)

items 是作业列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.11. io.k8s.api.certificates.v1.CertificateSigningRequestList schema

描述
CertificateSigningRequestList 是 CertificateSigningRequest 对象的集合
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(CertificateSigningRequest)

items 是 CertificateSigningRequest 对象的集合

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

 

4.1.12. io.k8s.api.coordination.v1.LeaseList schema

描述
LeaseList 是 Lease 对象的列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Lease)

items 是 schema 对象列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.13. io.k8s.api.core.v1.Affinity schema

描述
affinity 是一组关联性调度规则。
类型
对象
模式
属性类型描述

nodeAffinity

nodeAffinity

描述 pod 的节点关联性调度规则。

podAffinity

podAffinity

描述 pod 关联性调度规则(例如,将这个 pod 放置到同一节点、区域等)中。

podAntiAffinity

podAntiAffinity

描述 pod 反关联性调度规则(例如,避免将此 pod 放置到同一节点、区域等)中。

4.1.14. io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource schema

描述

代表 AWS 中的 Persistent Disk 资源。

挂载到容器前必须存在 AWS EBS 磁盘。磁盘还必须与 kubelet 位于同一个 AWS 区域。AWS EBS 磁盘只能以读写模式挂载。AWS EBS 卷支持所有权管理和 SELinux 重新标记。

类型
对象
必填
  • volumeID
模式
属性类型描述

fsType

字符串

fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

分区

整数

partition 是您要挂载的卷中的分区。如果省略,则默认为按卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷分区是 "0" (或者您可以将属性留空)。

readOnly

布尔值

readonly 值 true 将强制 VolumeMounts 中的 readOnly 设置。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

字符串

VolumeId 是 AWS (Amazon EBS 卷)中的持久磁盘资源的唯一 ID。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

4.1.15. io.k8s.api.core.v1.AzureDiskVolumeSource schema

描述
azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。
类型
对象
必填
  • diskName
  • diskURI
模式
属性类型描述

cachingMode

字符串

cachingMode 是主机缓存模式: None、Read Only、Read Write。

可能枚举值: - "None" - "ReadOnly" - "ReadWrite"

diskName

字符串

diskname 是 blob 存储中的数据磁盘的名称

diskURI

字符串

diskURI 是 blob 存储中数据磁盘的 URI

fsType

字符串

fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

kind

字符串

kind expected 值是 Shared: multiple blob disk per storage account Managed: azure disk per storage account Managed: azure managed data disk (only in managed availability set))。默认为 shared

possible enum 值: - "Dedicated" - "Managed" - "Shared"

readOnly

布尔值

只读默认值为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

4.1.16. io.k8s.api.core.v1.AzureFilePersistentVolumeSource schema

描述
azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。
类型
对象
必填
  • secretName
  • shareName
模式
属性类型描述

readOnly

布尔值

只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretName

字符串

secretName 是包含 Azure Storage Account Name 和 Key 的 secret 名称

secretNamespace

字符串

secretNamespace 是包含 Azure Storage Account Name 和 Key default 的 secret 的命名空间与 Pod 相同

shareName

字符串

sharename 是 azure Share Name

4.1.17. io.k8s.api.core.v1.AzureFileVolumeSource schema

描述
azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。
类型
对象
必填
  • secretName
  • shareName
模式
属性类型描述

readOnly

布尔值

只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretName

字符串

secretName 是包含 Azure Storage Account Name 和 Key 的 secret 名称

shareName

字符串

sharename 是 azure 共享名称

4.1.18. io.k8s.api.core.v1.Capabilities schema

描述
从正在运行的容器中添加和删除 POSIX 功能。
类型
对象
模式
属性类型描述

add

数组(字符串)

添加了功能

drop

数组(字符串)

删除的功能

4.1.19. io.k8s.api.core.v1.CephFSPersistentVolumeSource schema

描述
代表 Ceph 文件系统挂载,最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。
类型
对象
必填
  • monitor
模式
属性类型描述

monitor

数组(字符串)

Monitors is Required: Monitor is a collection of Ceph monitors more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

字符串

路径为可选: 作为挂载的 root 使用,而不是完整的 Ceph 树,默认为 /

readOnly

布尔值

readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

字符串

secretfile 是可选:SecretFile 是 User 的密钥环的路径,默认为 /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

SecretReference

secretRef 是可选的:SecretRef 是对 User 的身份验证 secret 的引用,默认为空。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

user

字符串

用户是可选的: User 是 rados 用户名,默认为 admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

4.1.20. io.k8s.api.core.v1.CephFSVolumeSource schema

描述
代表 Ceph 文件系统挂载,最后一个 pod Cephfs 卷的生命周期不支持所有权管理或 SELinux 重新标记。
类型
对象
必填
  • monitor
模式
属性类型描述

monitor

数组(字符串)

Monitors is Required: Monitor is a collection of Ceph monitors more info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

字符串

路径为可选: 作为挂载的 root 使用,而不是完整的 Ceph 树,默认为 /

readOnly

布尔值

readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

字符串

secretfile 是可选:SecretFile 是 User 的密钥环的路径,默认为 /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

LocalObjectReference

secretRef 是可选的:SecretRef 是对 User 的身份验证 secret 的引用,默认为空。更多信息: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

user

字符串

用户是可选的: User 是 rados 用户名,默认为 admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

4.1.21. io.k8s.api.core.v1.CinderPersistentVolumeSource schema

描述
代表 Openstack 中的 cinder 卷资源。挂载到容器之前必须存在 Cinder 卷。卷还必须与 kubelet 位于同一区域。Cinder 卷支持所有权管理和 SELinux 重新标记。
类型
对象
必填
  • volumeID
模式
属性类型描述

fsType

字符串

要挂载的 fstype Filesystem 类型。必须是主机操作系统支持的文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

布尔值

readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

SecretReference

secretRef 是可选的:指向包含用于连接 OpenStack 的参数的 secret 对象。

volumeID

字符串

用于识别 cinder 中的卷的卷 ID。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

4.1.22. io.k8s.api.core.v1.CinderVolumeSource schema

描述
代表 Openstack 中的 cinder 卷资源。挂载到容器之前必须存在 Cinder 卷。卷还必须与 kubelet 位于同一区域。Cinder 卷支持所有权管理和 SELinux 重新标记。
类型
对象
必填
  • volumeID
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

布尔值

只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

LocalObjectReference

secretRef 是可选的:指向包含用于连接 OpenStack 的参数的 secret 对象。

volumeID

字符串

用于识别 cinder 中的卷的卷 ID。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

4.1.23. io.k8s.api.core.v1.ClaimSource schema

描述

ClaimSource 描述了对 ResourceClaim 的引用。

应设置其中一个字段。这个类型的消费者必须将空对象视为一个未知值。

类型
对象
模式
属性类型描述

resourceClaimName

字符串

ResourceClaimName 是与这个 pod 相同的命名空间中的 ResourceClaim 对象的名称。

resourceClaimTemplateName

字符串

ResourceClaimTemplateName 是与这个 pod 相同的命名空间中的 ResourceClaimTemplate 对象的名称。

模板将用于创建新的 ResourceClaim,它将绑定到此 pod。删除此 pod 后,ResourceClaim 也会被删除。ResourceClaim 的名称将是 <pod name>-<resource name>,其中 <resource name> 是 PodResourceClaim.Name。如果串联名称对 ResourceClaim 无效(如太长,则 Pod 验证将拒绝 pod)。

没有为 pod 拥有该名称的现有 ResourceClaim 不会被用于 pod,以避免错误地使用不相关的资源。然后,调度和 pod 启动会被阻断,直到删除不相关的 ResourceClaim。

此字段不可变,在创建 ResourceClaim 后,control plane 不会对对应的 ResourceClaim 进行更改。

4.1.24. io.k8s.api.core.v1.ComponentStatusList schema

描述
组件的所有条件的状态作为 ComponentStatus 对象列表。弃用:此 API 在 v1.19+ 中弃用
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ComponentStatus)

组件状态对象列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.25. io.k8s.api.core.v1.ConfigMapEnvSource schema

描述

ConfigMapEnvSource 选择一个 ConfigMap 来填充环境变量。

目标 ConfigMap 的 Data 字段的内容将以环境变量的形式表示键值对。

类型
对象
模式
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否必须定义 ConfigMap

4.1.26. io.k8s.api.core.v1.ConfigMapKeySelector schema

描述
从 ConfigMap 中选择一个键。
类型
对象
必填
  • key
模式
属性类型描述

key

字符串

要选择的密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否必须定义 ConfigMap 还是其键

4.1.27. io.k8s.api.core.v1.ConfigMapList schema

描述
ConfigMapList 是一个包含 ConfigMap 对象列表的资源。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ConfigMap)

items 是 ConfigMap 的列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.28. io.k8s.api.core.v1.ConfigMapProjection schema

描述

将 ConfigMap 调整为投射卷。

目标 ConfigMap 的 Data 字段的内容将作为文件出现在投射卷中,使用 Data 字段中的密钥作为文件名,除非 items 元素填充了键到路径的特定映射。请注意,这与没有默认模式的 configmap 卷源相同。

类型
对象
模式
属性类型描述

items

数组(KeyToPath)

如果未指定项目,则引用 ConfigMap 的 Data 字段中的每一键值对将投射到卷中,名称为键,内容是值。如果指定,列出的键将投射到指定的路径中,且未列出的密钥将不存在。如果指定了在 ConfigMap 中不存在的密钥,则卷设置将错误,除非标记为可选。路径必须是 relative,且不能包含 '..' 路径或以 '..' 开头。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

可选指定是否必须定义 ConfigMap 还是其键

4.1.29. io.k8s.api.core.v1.ConfigMapVolumeSource schema

描述

将 ConfigMap 调整为卷。

目标 ConfigMap 的 Data 字段的内容将作为文件显示在卷中,使用 Data 字段中的密钥作为文件名,除非 items 元素填充了键到路径的特定映射。ConfigMap 卷支持所有权管理和 SELinux 重新标记。

类型
对象
模式
属性类型描述

defaultMode

整数

defaultMode 是可选的:用于默认设置创建文件的权限的模式位。必须是 0000 到 0777 之间的数值,也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值,JSON 需要模式位的十进制值。默认值为 0644。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项(如 fsGroup )冲突,结果可以是设置其他模式位。

items

数组(KeyToPath)

如果未指定项目,则引用 ConfigMap 的 Data 字段中的每一键值对将投射到卷中,名称为键,内容是值。如果指定,列出的键将投射到指定的路径中,且未列出的密钥将不存在。如果指定了在 ConfigMap 中不存在的密钥,则卷设置将错误,除非标记为可选。路径必须是 relative,且不能包含 '..' 路径或以 '..' 开头。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

可选指定是否必须定义 ConfigMap 还是其键

4.1.30. io.k8s.api.core.v1.Container schema

描述
要在 pod 中运行的单一应用程序容器。
类型
对象
必填
  • name
模式
属性类型描述

args

数组(字符串)

入口点的参数。如果没有提供,则使用容器镜像的 CMD。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量,输入字符串中的引用将不会改变。双引号被减少为一个 $,它允许转义 $(VAR_NAME)语法:例如:" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

命令

数组(字符串)

ENTRYPOINT 数组.不会在 shell 中执行。如果没有提供,则使用容器镜像的 ENTRYPOINT。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量,输入字符串中的引用将不会改变。双引号被减少为一个 $,它允许转义 $(VAR_NAME)语法:例如:" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

数组(EnvVar)

要在容器中设置的环境变量列表。无法更新。

envFrom

数组(EnvFromSource)

用于在容器中填充环境变量的源列表。源中定义的键必须是 C_IDENTIFIER。当容器启动时,所有无效的密钥都会被报告为事件。当多个源中存在键时,与最后一个源关联的值将具有优先权。由带有重复键的 Env 定义的值将具有优先权。无法更新。

image

字符串

容器镜像名称。更多信息: https://kubernetes.io/docs/concepts/containers/images 此字段是可选的,允许更高级别的配置管理默认或覆盖工作负载控制器中的容器镜像,如 Deployment 和 StatefulSets。

imagePullPolicy

字符串

镜像拉取策略。Always, Never, IfNotPresent 之一。如果指定了 :latest 标签,则默认为 Always,否则为 IfNotPresent。无法更新。更多信息: https://kubernetes.io/docs/concepts/containers/images#updating-images

可能枚举值: - "Always" 表示 kubelet 始终会尝试拉取最新的镜像。如果拉取失败,则容器将失败。- "IfNotPresent" 表示 kubelet 在磁盘上不存在时拉取。如果镜像不存在,且拉取失败,则容器将失败。- "Never" 表示 kubelet 不会拉取镜像,但只使用本地镜像。如果镜像不存在,容器将失败

生命周期

生命周期

管理系统应采取的操作来响应容器生命周期事件。无法更新。

livenessProbe

probe

容器存活度的定期探测.如果探测失败,将重启容器。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

name

字符串

指定为 DNS_LABEL 的容器的名称。pod 中的每个容器都必须具有唯一名称(DNS_LABEL)。无法更新。

ports

数组(ContainerPort)

要从容器公开的端口列表。不在此处指定端口 不会阻止公开该端口。任何正在侦听容器内的默认"0.0.0.0"地址的端口都可以从网络访问。使用战略合并补丁修改此阵列可能会破坏数据。如需更多信息,请参阅 https://github.com/kubernetes/kubernetes/issues/108255。无法更新。

readinessProbe

probe

容器服务的定期探测就绪。如果探测失败,容器将从服务端点中删除。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

resizePolicy

数组(ContainerResizePolicy)

容器的资源重新定义策略大小。

资源

ResourceRequirements

此容器所需的计算资源。无法更新。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

securityContext

SecurityContext

securityContext 定义容器应使用运行的安全选项。如果设置,SecurityContext 的字段会覆盖 PodSecurityContext 的等效字段。更多信息: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

startupProbe

probe

startupProbe 表示 Pod 已成功初始化。如果指定,则不会执行其他探测,直到成功完成为止。如果这个探测失败,则 Pod 将重启,就像 livenessProbe 失败一样。这可用于在 Pod 生命周期开始时提供不同的探测参数,当可能需要很长时间才能加载数据或温缓存,而不是在 steady-state 操作期间进行。这不能被更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

stdin

布尔值

此容器是否应该为容器运行时中的 stdin 分配缓冲区。如果没有设置,则从容器中的 stdin 读取总是会导致 EOF。默认值为 false。

stdinOnce

布尔值

容器运行时是否应该在单个附加打开后关闭 stdin 频道。当 stdin 为 true 时,stdin 流将在多个附加会话之间保持打开。如果将 stdinOnce 设为 true,则 stdin 在容器启动时打开,会为空,直到第一个客户端附加到 stdin,然后保持打开并接受数据,直到客户端断开连接,而时间 stdin 被关闭并保持关闭,直到容器重启为止。如果此标志为 false,则从 stdin 读取的容器进程永远不会收到 EOF。默认值为 false

terminationMessagePath

字符串

可选:将容器终止消息写入的文件路径被挂载到容器文件系统中。编写的消息应该是简短的最终状态,如断言失败消息。如果大于 4096 字节,则节点将被截断。所有容器的消息长度限制为 12kb。默认为 /dev/termination-log。无法更新。

terminationMessagePolicy

字符串

指明如何填充终止消息。文件将使用 terminationMessagePath 的内容在成功和失败时填充容器状态消息。如果终止消息文件为空,并且容器退出并显示错误,则 FallbackToLogsOnError 将使用容器日志输出的最后块。日志输出限制为 2048 字节或 80 行,以较大者为准。默认为 file。无法更新。

可能的 enum 值: - "FallbackToLogsOnError" 会在容器退出时读取容器状态消息的最新内容,且 terminationMessagePath 没有内容。- "File" 是默认行为,并将容器状态消息设置为容器终止MessagePath 的内容。

tty

布尔值

此容器是否应为自己分配 TTY,还需要 'stdin' 为 true。默认值为 false。

volumeDevices

数组(VolumeDevice)

volumeDevices 是容器使用的块设备列表。

volumeMounts

数组(VolumeMount)

要挂载到容器文件系统中的 Pod 卷。无法更新。

workingDir

字符串

容器的工作目录。如果没有指定,则使用容器运行时的默认值,这可能会在容器镜像中配置。无法更新。

4.1.31. io.k8s.api.core.v1.ContainerPort schema

描述
containerPort 代表单一容器中的网络端口。
类型
对象
必填
  • containerPort
模式
属性类型描述

containerPort

整数

在 pod 的 IP 地址上公开的端口号。这必须是有效的端口号 0 < x < 65536。

hostIP

字符串

将外部端口绑定到的主机 IP。

hostPort

整数

要在主机上公开的端口号。如果指定,这必须是有效的端口号,0 < x < 65536。如果指定了 HostNetwork,则必须匹配 ContainerPort。大多数容器都不需要此操作。

name

字符串

如果指定,这必须是 IANA_SVC_NAME,并在 pod 中唯一。pod 中的每个指定端口都必须具有唯一的名称。服务可以引用的端口的名称。

protocol

字符串

端口的协议。必须是 UDP、TCP 或 SCTP。默认为 "TCP"。

可能的值有: - "SCTP" 是 SCTP 协议。- "TCP" 是 TCP 协议。- "UDP" 是 UDP 协议。

4.1.32. io.k8s.api.core.v1.ContainerResizePolicy schema

描述
ContainerResizePolicy 代表容器的资源大小策略。
类型
对象
必填
  • resourceName
  • restartPolicy
模式
属性类型描述

resourceName

字符串

应用此资源调整大小策略的资源名称。支持的值:cpu、memory。

restartPolicy

字符串

在调整指定资源大小时,重启策略会应用。如果没有指定,则默认为 NotRequired。

4.1.33. io.k8s.api.core.v1.CSIPersistentVolumeSource schema

描述
代表由外部 CSI 卷驱动程序(Beta 功能)管理的存储
类型
对象
必填
  • driver
  • volumeHandle
模式
属性类型描述

controllerExpandSecretRef

SecretReference

controllerExpandSecretRef 是对包含要传递给 CSI 驱动程序的敏感信息的 secret 对象的引用,以完成 CSI ControllerExpandVolume 调用。此字段是可选的,如果不需要 secret,则可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会被传递。

controllerPublishSecretRef

SecretReference

controllerPublishSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用,以完成 CSI ControllerPublishVolume 和 ControllerUnpublishVolume 调用。此字段是可选的,如果不需要 secret,则可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会被传递。

driver

字符串

driver 是要用于此卷的驱动程序名称。必需。

fsType

字符串

要挂载的 fstype。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".

nodeExpandSecretRef

SecretReference

nodeExpandSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用,以完成 CSI NodeExpandVolume 调用。这是一个 beta 字段,由 CSINodeExpandSecret 功能门启用。如果不需要 secret,则可以省略此字段。如果 secret 对象包含多个 secret,则所有 secret 都会被传递。

nodePublishSecretRef

SecretReference

nodePublishSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用,以完成 CSI NodePublishVolume 和 NodeUnpublishVolume 调用。此字段是可选的,如果不需要 secret,则可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会被传递。

nodeStageSecretRef

SecretReference

nodeStageSecretRef 是包含传递给 CSI 驱动程序的 secret 对象的引用,以完成 CSI NodeStageVolume 和 NodeStageVolume 和 NodeUnstageVolume 调用。此字段是可选的,如果不需要 secret,则可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会被传递。

readOnly

布尔值

传递给 ControllerPublishVolumeRequest 的 readonly 值。默认为 false (读/写)。

volumeAttributes

对象(字符串)

要发布的卷的 volumeAttributes。

volumeHandle

字符串

volumeHandle 是 CSI 卷插件的 CreateVolume 返回的唯一卷名称,以在所有后续调用中引用卷。必需。

4.1.34. io.k8s.api.core.v1.CSIVolumeSource schema

描述
代表由外部 CSI 驱动程序管理的卷的源位置
类型
对象
必填
  • driver
模式
属性类型描述

driver

字符串

driver 是处理这个卷的 CSI 驱动程序的名称。请参考您的管理员获取集群中注册的正确名称。

fsType

字符串

要挂载的 fstype。Ex. "ext4", "xfs", "ntfs".如果没有提供,空值会被传递给关联的 CSI 驱动程序,该驱动程序将决定要应用的默认文件系统。

nodePublishSecretRef

LocalObjectReference

nodePublishSecretRef 是对包含要传递给 CSI 驱动程序的 secret 对象的引用,以完成 CSI NodePublishVolume 和 NodeUnpublishVolume 调用。此字段是可选的,如果不需要 secret,则可能为空。如果 secret 对象包含多个 secret,则所有 secret 引用都会传递。

readOnly

布尔值

readonly 指定卷的只读配置。默认为 false (读/写)。

volumeAttributes

对象(字符串)

volumeAttributes 存储传递给 CSI 驱动程序的特定于驱动程序的属性。如需支持的值,请参考您的驱动程序文档。

4.1.35. io.k8s.api.core.v1.DownwardAPIProjection schema

描述
代表下下 API 信息,用于项目到投射卷中。请注意,这与没有默认模式的卷源相同。
类型
对象
模式
属性类型描述

items

数组(DownwardAPIVolumeFile)

items 是 DownwardAPIVolume 文件列表

4.1.36. io.k8s.api.core.v1.DownwardAPIVolumeFile schema

描述
DownwardAPIVolumeFile 代表信息,以创建包含 pod 字段的文件
类型
对象
必填
  • path
模式
属性类型描述

fieldRef

ObjectFieldSelector

必需:选择 pod 的字段:只支持注解、标签、名称和命名空间。

模式

整数

可选:用于在此文件上设置权限的模式位,必须是 0000 到 0777 之间或 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值,JSON 需要模式位的十进制值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项(如 fsGroup )冲突,结果可以是设置其他模式位。

path

字符串

必需:Path 是要创建的文件的相对路径名称。不能绝对或包含 '..' 路径。必须采用 utf-8 编码。相对路径的第一个项目不能以 '..' 开头。

resourceFieldRef

ResourceFieldSelector

选择容器的资源:当前仅支持资源限值和请求(limits.cpu、limit.memory、request.cpu 和 requests.memory)。

4.1.37. io.k8s.api.core.v1.DownwardAPIVolumeSource schema

描述
DownwardAPIVolumeSource 代表包含 Downward API 信息的卷。Downward API 卷支持所有权管理和 SELinux 重新标记。
类型
对象
模式
属性类型描述

defaultMode

整数

可选:默认在创建的文件中使用的模式位。必须是可选:用于默认设置创建文件的权限的模式位。必须是 0000 到 0777 之间的数值,也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值,JSON 需要模式位的十进制值。默认值为 0644。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项(如 fsGroup )冲突,结果可以是设置其他模式位。

items

数组(DownwardAPIVolumeFile)

items 是 Downward API 卷文件列表

4.1.38. io.k8s.api.core.v1.EmptyDirVolumeSource schema

描述
表示 pod 的空目录。空目录卷支持所有权管理和 SELinux 重新标记。
类型
对象
模式
属性类型描述

字符串

Medium 代表这个目录应该支持哪些存储类型。默认值为 "",它需要使用节点的默认介质。必须是空字符串(默认)或 Memory。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

sizeLimit

数量

sizeLimit 是此 EmptyDir 卷所需的本地存储总量。大小限制也适用于内存介质。内存用量 EmptyDir 的最大用法是此处指定的 SizeLimit 和 pod 中所有容器的内存限值总和。默认值为 nil,表示限制未定义。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

4.1.39. io.k8s.api.core.v1.EndpointsList schema

描述
EndpointsList 是端点列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Endpoints)

端点列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.40. io.k8s.api.core.v1.EnvFromSource schema

描述
EnvFromSource 代表一组 ConfigMap 的源
类型
对象
模式
属性类型描述

configMapRef

ConfigMapEnvSource

要从中选择的 ConfigMap

prefix

字符串

用于添加到 ConfigMap 中每个键的可选标识符。必须是 C_IDENTIFIER。

secretRef

SecretEnvSource

要从中选择的 Secret

4.1.41. io.k8s.api.core.v1.EnvVar schema

描述
EnvVar 代表容器中存在的环境变量。
类型
对象
必填
  • name
模式
属性类型描述

name

字符串

环境变量的名称。必须是 C_IDENTIFIER。

value

字符串

变量引用 $(VAR_NAME)使用容器中之前定义的环境变量和任何服务环境变量进行扩展。如果无法解析变量,输入字符串中的引用将不会改变。双引号被减少为一个 $,它允许转义 $(VAR_NAME)语法:例如:" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展,无论变量是否存在。默认值为 ""。

valueFrom

EnvVarSource

环境变量的值的源。如果 value 不是空,则无法使用。

4.1.42. io.k8s.api.core.v1.EnvVarSource schema

描述
EnvVarSource 代表 EnvVarar 的值的一个源。
类型
对象
模式
属性类型描述

configMapKeyRef

ConfigMapKeySelector

选择 ConfigMap 的密钥。

fieldRef

ObjectFieldSelector

选择 pod 的字段:支持 metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

resourceFieldRef

ResourceFieldSelector

选择容器的资源:当前仅支持资源限值和请求(limits.cpu、limits.memory、limits.ephemeral-storage、request.cpu、request.memory 和 requests.ephemeral-storage)。

secretKeyRef

SecretKeySelector

在 pod 命名空间中选择 secret 的密钥

4.1.43. io.k8s.api.core.v1.EphemeralContainer schema

描述

EphemeralContainer 是一个临时容器,您可以为用户发起的活动(如调试)添加到现有 Pod 中。临时容器没有资源或调度保证,在 Pod 退出或重启时不会重启它们。如果临时容器导致 Pod 超过其资源分配,kubelet 可能会驱除 Pod。

要添加临时容器,请使用现有 Pod 的 ephemeralcontainers 子资源。可能无法删除或重启临时容器。

类型
对象
必填
  • name
模式
属性类型描述

args

数组(字符串)

入口点的参数。如果没有提供,则使用镜像的 CMD。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量,输入字符串中的引用将不会改变。双引号被减少为一个 $,它允许转义 $(VAR_NAME)语法:例如:" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

命令

数组(字符串)

ENTRYPOINT 数组.不会在 shell 中执行。如果没有提供,则使用镜像的 ENTRYPOINT。变量引用 $(VAR_NAME)使用容器环境扩展。如果无法解析变量,输入字符串中的引用将不会改变。双引号被减少为一个 $,它允许转义 $(VAR_NAME)语法:例如:" (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会被扩展,无论变量是否存在。无法更新。更多信息: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

env

数组(EnvVar)

要在容器中设置的环境变量列表。无法更新。

envFrom

数组(EnvFromSource)

用于在容器中填充环境变量的源列表。源中定义的键必须是 C_IDENTIFIER。当容器启动时,所有无效的密钥都会被报告为事件。当多个源中存在键时,与最后一个源关联的值将具有优先权。由带有重复键的 Env 定义的值将具有优先权。无法更新。

image

字符串

容器镜像名称。更多信息: https://kubernetes.io/docs/concepts/containers/images

imagePullPolicy

字符串

镜像拉取策略。Always, Never, IfNotPresent 之一。如果指定了 :latest 标签,则默认为 Always,否则为 IfNotPresent。无法更新。更多信息: https://kubernetes.io/docs/concepts/containers/images#updating-images

可能枚举值: - "Always" 表示 kubelet 始终会尝试拉取最新的镜像。如果拉取失败,则容器将失败。- "IfNotPresent" 表示 kubelet 在磁盘上不存在时拉取。如果镜像不存在,且拉取失败,则容器将失败。- "Never" 表示 kubelet 不会拉取镜像,但只使用本地镜像。如果镜像不存在,容器将失败

生命周期

生命周期

临时容器不允许使用生命周期。

livenessProbe

probe

临时容器不允许探测。

name

字符串

指定为 DNS_LABEL 的临时容器的名称。此名称在所有容器、init 容器和临时容器中必须是唯一的。

ports

数组(ContainerPort)

临时容器不允许使用端口。

readinessProbe

probe

临时容器不允许探测。

resizePolicy

数组(ContainerResizePolicy)

容器的资源重新定义策略大小。

资源

ResourceRequirements

临时容器不允许使用资源。临时容器使用已分配给 pod 的备用资源。

securityContext

SecurityContext

可选: SecurityContext 定义临时容器应使用的安全选项。如果设置,SecurityContext 的字段会覆盖 PodSecurityContext 的等效字段。

startupProbe

probe

临时容器不允许探测。

stdin

布尔值

此容器是否应该为容器运行时中的 stdin 分配缓冲区。如果没有设置,则从容器中的 stdin 读取总是会导致 EOF。默认值为 false。

stdinOnce

布尔值

容器运行时是否应该在单个附加打开后关闭 stdin 频道。当 stdin 为 true 时,stdin 流将在多个附加会话之间保持打开。如果将 stdinOnce 设为 true,则 stdin 在容器启动时打开,会为空,直到第一个客户端附加到 stdin,然后保持打开并接受数据,直到客户端断开连接,而时间 stdin 被关闭并保持关闭,直到容器重启为止。如果此标志为 false,则从 stdin 读取的容器进程永远不会收到 EOF。默认值为 false

targetContainerName

字符串

如果设置,则此临时容器目标的 PodSpec 中的容器名称。临时容器将在此容器的命名空间中运行(IPC、PID 等)。如果没有设置,则临时容器将使用 Pod spec 中配置的命名空间。

容器运行时必须实施对此功能的支持。如果运行时不支持以命名空间为目标,则设置此字段的结果未定义。

terminationMessagePath

字符串

可选:将容器终止消息写入的文件路径被挂载到容器文件系统中。编写的消息应该是简短的最终状态,如断言失败消息。如果大于 4096 字节,则节点将被截断。所有容器的消息长度限制为 12kb。默认为 /dev/termination-log。无法更新。

terminationMessagePolicy

字符串

指明如何填充终止消息。文件将使用 terminationMessagePath 的内容在成功和失败时填充容器状态消息。如果终止消息文件为空,并且容器退出并显示错误,则 FallbackToLogsOnError 将使用容器日志输出的最后块。日志输出限制为 2048 字节或 80 行,以较大者为准。默认为 file。无法更新。

可能的 enum 值: - "FallbackToLogsOnError" 会在容器退出时读取容器状态消息的最新内容,且 terminationMessagePath 没有内容。- "File" 是默认行为,并将容器状态消息设置为容器终止MessagePath 的内容。

tty

布尔值

此容器是否应为自己分配 TTY,还需要 'stdin' 为 true。默认值为 false。

volumeDevices

数组(VolumeDevice)

volumeDevices 是容器使用的块设备列表。

volumeMounts

数组(VolumeMount)

要挂载到容器文件系统中的 Pod 卷。临时容器不允许进行 subPath 挂载。无法更新。

workingDir

字符串

容器的工作目录。如果没有指定,则使用容器运行时的默认值,这可能会在容器镜像中配置。无法更新。

4.1.44. io.k8s.api.core.v1.EphemeralVolumeSource schema

描述
代表由普通存储驱动程序处理的临时卷。
类型
对象
模式
属性类型描述

volumeClaimTemplate

PersistentVolumeClaimTemplate

将用于创建独立 PVC 来置备卷。嵌入了此 EphemeralVolumeSource 的 pod 将是 PVC 的所有者,即 PVC 将与 pod 一起删除。PVC 的名称将是 < pod name>-<volume name>,其中 <volume name> 是 PodSpec.Volumes 数组条目中的名称。如果串联的名称对 PVC 无效,则 Pod 验证将拒绝 pod (例如,太长)。

没有为 pod 拥有该名称的现有 PVC 不会被 用于 pod,以避免错误地使用不相关的卷。然后,启动 pod 会被阻断,直到删除不相关的 PVC。如果 pod 使用预先创建的 PVC,则在 pod 存在后,PVC 必须使用所有者引用 pod 更新。通常,这不应该是必需的,但在手动重新创建损坏的集群时可能很有用。

此字段是只读的,在创建后 Kubernetes 不会对 PVC 进行任何更改。

必需,不能是 nil。

4.1.45. io.k8s.api.core.v1.EventList schema

描述
EventList 是事件列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(事件)

事件列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.46. io.k8s.api.core.v1.EventSource schema

描述
EventSource 包含事件的信息。
类型
对象
模式
属性类型描述

component

字符串

生成事件的组件。

主机

字符串

生成事件的节点名称。

4.1.47. io.k8s.api.core.v1.ExecAction schema

描述
ExecAction 描述了 "run in container" 操作。
类型
对象
模式
属性类型描述

命令

数组(字符串)

命令是在容器内执行的命令行,命令的工作目录是容器文件系统中的 root ('/')。命令只是 exec'd,它不在 shell 中运行,因此传统的 shell 指令('|' 等)不起作用。要使用 shell,您需要明确调用该 shell。0 的退出状态被视为 live/healthy,非零为不健康。

4.1.48. io.k8s.api.core.v1.FCVolumeSource schema

描述
代表光纤通道卷。Fibre Channel 卷只能以读写模式挂载。Fibre Channel 卷支持所有权管理和 SELinux 重新标记。
类型
对象
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

LUN

整数

LUN 是可选的: FC 目标 lun 号

readOnly

布尔值

readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

targetWWNs

数组(字符串)

targetWWN 可选: FC 目标全球名称(WWN)

wwids

数组(字符串)

wwids 可选:FC 卷全局广泛的标识符(wwids) Either wwids 或 targetWWNs 和 lun 的组合必须同时设置,但不能同时设置。

4.1.49. io.k8s.api.core.v1.FlexPersistentVolumeSource schema

描述
FlexPersistentVolumeSource 代表使用基于 exec 的插件置备/附加的通用持久性卷资源。
类型
对象
必填
  • driver
模式
属性类型描述

driver

字符串

driver 是要用于此卷的驱动程序名称。

fsType

字符串

fstype 是要挂载的 Filesystem 类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统取决于 FlexVolume 脚本。

options

对象(字符串)

选项是可选的:此字段包含额外的命令选项(若有)。

readOnly

布尔值

readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

SecretReference

secretRef 是可选的:SecretRef 是对包含要传递给插件脚本的敏感信息的 secret 对象的引用。如果没有指定 secret 对象,则这可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会传递给插件脚本。

4.1.50. io.k8s.api.core.v1.FlexVolumeSource schema

描述
FlexVolume 代表一个通用卷资源,它使用基于 exec 的插件置备/附加。
类型
对象
必填
  • driver
模式
属性类型描述

driver

字符串

driver 是要用于此卷的驱动程序名称。

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认文件系统取决于 FlexVolume 脚本。

options

对象(字符串)

选项是可选的:此字段包含额外的命令选项(若有)。

readOnly

布尔值

readonly 是可选的:默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

LocalObjectReference

secretRef 是可选的:secretRef 是对包含要传递给插件脚本的敏感信息的 secret 对象的引用。如果没有指定 secret 对象,则这可能为空。如果 secret 对象包含多个 secret,则所有 secret 都会传递给插件脚本。

4.1.51. io.k8s.api.core.v1.FlockerVolumeSource schema

描述
代表由 Flocker 代理挂载的 Flocker 卷。应该只设置其中一个 datasetName 和 datasetUUID。flocker 卷不支持所有权管理或 SELinux 重新标记。
类型
对象
模式
属性类型描述

datasetName

字符串

datasetName 是存储在 Flocker 的 dataset 的 dataset 的 dataset 的 Name。

datasetUUID

字符串

datasetUUID 是 dataset 的 UUID。这是 Flocker 数据集的唯一标识符

4.1.52. io.k8s.api.core.v1.GCEPersistentDiskVolumeSource schema

描述

代表 Google Compute Engine 中的 Persistent Disk 资源。

在挂载到容器前,GCE PD 必须已经存在。磁盘还必须与 kubelet 位于同一个 GCE 项目和区。GCE PD 只能以读写一次挂载,或者多次只读。GCE PDs 支持所有权管理和 SELinux 重新标记。

类型
对象
必填
  • pdName
模式
属性类型描述

fsType

字符串

fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

分区

整数

partition 是您要挂载的卷中的分区。如果省略,则默认为按卷名称挂载。示例:对于卷 /dev/sda1,您可以将分区指定为 "1"。同样,/dev/sda 的卷分区是 "0" (或者您可以将属性留空)。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

pdName

字符串

pdName 是 GCE 中的 PD 资源的唯一名称。用于识别 GCE 中的磁盘。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

readOnly

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

4.1.53. io.k8s.api.core.v1.GitRepoVolumeSource schema

描述

代表填充 git 存储库内容的卷。Git 仓库卷不支持所有权管理。Git repo 卷支持 SELinux 重新标记。

DEPRECATED: GitRepo 已被弃用。要使用 git 仓库置备容器,请将 EmptyDir 挂载到使用 git 克隆存储库的 InitContainer 中,然后将 EmptyDir 挂载到 Pod 的容器中。

类型
对象
必填
  • 软件仓库
模式
属性类型描述

目录

字符串

directory 是目标目录名称。不得包含或以 '..' 开头。如果提供了 '.',则卷目录将是 git 存储库。否则,如果指定,卷将包含具有指定名称的子目录中的 git 存储库。

软件仓库

字符串

repository 是 URL

revision

字符串

revision 是指定修订版本的提交哈希。

4.1.54. io.k8s.api.core.v1.GlusterfsPersistentVolumeSource schema

描述
代表 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。
类型
对象
必填
  • 端点
  • path
模式
属性类型描述

端点

字符串

Endpoints 是详细信息 Glusterfs 拓扑的端点名称。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

endpointsNamespace

字符串

endpointsNamespace 是包含 Glusterfs 端点的命名空间。如果此字段为空,则 EndpointNamespace 默认为与绑定 PVC 相同的命名空间。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

字符串

path 是 Glusterfs 卷路径。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

布尔值

此处的只读将强制使用只读权限挂载 Glusterfs 卷。默认为false。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

4.1.55. io.k8s.api.core.v1.GlusterfsVolumeSource schema

描述
代表 pod 生命周期的 Glusterfs 挂载。GlusterFS 卷不支持所有权管理或 SELinux 重新标记。
类型
对象
必填
  • 端点
  • path
模式
属性类型描述

端点

字符串

Endpoints 是详细信息 Glusterfs 拓扑的端点名称。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

字符串

path 是 Glusterfs 卷路径。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

布尔值

此处的只读将强制使用只读权限挂载 Glusterfs 卷。默认为false。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

4.1.56. io.k8s.api.core.v1.GRPCAction schema

描述
类型
对象
必填
  • port
模式
属性类型描述

port

整数

gRPC 服务的端口号。数字必须在 1 到 65535 之间。

service

字符串

service 是要放在 gRPC HealthCheckRequest 中的服务名称(请参阅 https://github.com/grpc/grpc/blob/master/doc/health-checking.md)。

如果没有指定,则默认的行为由 gRPC 定义。

4.1.57. io.k8s.api.core.v1.HostAlias schema

描述
HostAlias 包含将作为 pod 主机文件中的条目注入的 IP 和主机名之间的映射。
类型
对象
模式
属性类型描述

主机名

数组(字符串)

以上 IP 地址的主机名。

ip

字符串

主机文件条目的 IP 地址。

4.1.58. io.k8s.api.core.v1.HostPathVolumeSource schema

描述
代表映射到 pod 的主机路径。主机路径卷不支持所有权管理或 SELinux 重新标记。
类型
对象
必填
  • path
模式
属性类型描述

path

字符串

主机上目录的路径。如果路径是符号链接,它将遵循到实际路径的链接。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

字符串

HostPath Volume Defaults 为 "" more info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

可能枚举值:- "" 对于向后兼容,如果未设置 - "BlockDevice" A 块设备必须存在于给定路径 - "CharDevice" A 字符设备必须存在于给定路径上 - "Directory" A 目录必须存在于给定路径 - "DirectoryOrCreate" 中(如果给定路径不存在), 将根据需要创建一个空目录,且文件模式为 0755,其具有与 Kubelet 相同的组和所有权。- "File" A 文件必须存在于给定路径上 - "FileOrCreate" 如果给定路径上不存在,将根据需要创建一个空文件,该文件与文件模式 0644 具有相同的组和所有权。- "Socket" A UNIX 套接字必须存在于给定路径上。

4.1.59. io.k8s.api.core.v1.HTTPGetAction schema

描述
HTTPGetAction 描述了基于 HTTP 获取请求的操作。
类型
对象
必填
  • port
模式
属性类型描述

主机

字符串

要连接的主机名,默认为 pod IP。您可能想在 httpHeaders 中设置"主机"。

httpHeaders

数组(HTTPHeader)

在请求中设置的自定义标头。HTTP 允许重复标头。

path

字符串

在 HTTP 服务器上访问的路径。

port

IntOrString

在容器中要访问的端口的名称或数量。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

scheme

字符串

用于连接到主机的方案。默认为 HTTP。

可能枚举的值: - "HTTP" 表示使用的方案将是 http:// - "HTTPS" 意味着所使用的方案将是 https://

4.1.60. io.k8s.api.core.v1.HTTPHeader schema

描述
HTTPHeader 描述了 HTTP 探测中使用的自定义标头
类型
对象
必填
  • name
  • value
模式
属性类型描述

name

字符串

标头字段名称。这将在输出时规范,因此案例名称将理解为相同的标头。

value

字符串

标头字段值

4.1.61. io.k8s.api.core.v1.ISCSIPersistentVolumeSource schema

描述
ISCSIPersistentVolumeSource 代表 ISCSI 磁盘。ISCSI 卷只能以读写模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。
类型
对象
必填
  • targetPortal
  • IQN
  • LUN
模式
属性类型描述

chapAuthDiscovery

布尔值

chapAuthDiscovery 定义是否支持 iSCSI Discovery CHAP 身份验证

chapAuthSession

布尔值

chapAuthSession 定义是否支持 iSCSI Session CHAP 身份验证

fsType

字符串

fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

initiatorName

字符串

initiatorname 是自定义 iSCSI 启动器名称。如果同时使用 iscsiInterface 指定 initiatorName,则会为连接创建新的 iSCSI 接口 <target portal>:<volume name>。

IQN

字符串

IQN 是 iSCSI 限定名称的目标。

iscsiInterface

字符串

iscsiInterface 是使用 iSCSI 传输的接口名称。默认为 'default'(tcp)。

LUN

整数

LUN 是 iSCSI 目标 Lun 编号。

门户

数组(字符串)

门户是 iSCSI 目标门户列表。如果端口不是默认值(通常是 TCP 端口 860 和 3260),则门户可以是 IP 或 ip_addr:port。

readOnly

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。

secretRef

SecretReference

secretRef 是 iSCSI 目标和启动器验证的 CHAP Secret

targetPortal

字符串

targetPortal 是 iSCSI 目标门户。如果端口不是默认值(通常是 TCP 端口 860 和 3260),则门户可以是 IP 或 ip_addr:port。

4.1.62. io.k8s.api.core.v1.ISCSIVolumeSource schema

描述
代表 ISCSI 磁盘。ISCSI 卷只能以读写模式挂载。ISCSI 卷支持所有权管理和 SELinux 重新标记。
类型
对象
必填
  • targetPortal
  • IQN
  • LUN
模式
属性类型描述

chapAuthDiscovery

布尔值

chapAuthDiscovery 定义是否支持 iSCSI Discovery CHAP 身份验证

chapAuthSession

布尔值

chapAuthSession 定义是否支持 iSCSI Session CHAP 身份验证

fsType

字符串

fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

initiatorName

字符串

initiatorname 是自定义 iSCSI 启动器名称。如果同时使用 iscsiInterface 指定 initiatorName,则会为连接创建新的 iSCSI 接口 <target portal>:<volume name>。

IQN

字符串

IQN 是目标 iSCSI 限定名称。

iscsiInterface

字符串

iscsiInterface 是使用 iSCSI 传输的接口名称。默认为 'default'(tcp)。

LUN

整数

LUN 代表 iSCSI 目标 Lun 编号。

门户

数组(字符串)

门户是 iSCSI 目标门户列表。如果端口不是默认值(通常是 TCP 端口 860 和 3260),则门户可以是 IP 或 ip_addr:port。

readOnly

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。

secretRef

LocalObjectReference

secretRef 是 iSCSI 目标和启动器验证的 CHAP Secret

targetPortal

字符串

targetPortal 是 iSCSI 目标门户。如果端口不是默认值(通常是 TCP 端口 860 和 3260),则门户可以是 IP 或 ip_addr:port。

4.1.63. io.k8s.api.core.v1.KeyToPath schema

描述
将字符串键映射到卷中的路径。
类型
对象
必填
  • key
  • path
模式
属性类型描述

key

字符串

key 是项目的关键。

模式

整数

模式是可选的:用于设置此文件权限的模式位。必须是 0000 到 0777 之间的数值,也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值,JSON 需要模式位的十进制值。如果没有指定,则使用卷 defaultMode。这可能会与影响文件模式的其他选项(如 fsGroup )冲突,结果可以是设置其他模式位。

path

字符串

path 是要将密钥映射到的文件的相对路径。可能不是绝对路径。不得包含 path 元素 '..'。不能以字符串 '..' 开始。

4.1.64. io.k8s.api.core.v1.Lifecycle schema

描述
生命周期描述了管理系统在响应容器生命周期事件时应采取的操作。对于 PostStart 和 PreStop 生命周期处理程序,在操作完成前管理容器块,除非容器进程失败,在这种情况下,处理程序会中止。
类型
对象
模式
属性类型描述

postStart

LifecycleHandler

在创建容器后,postStart 会立即调用。如果处理程序失败,容器会根据重启策略终止并重启。对容器块的其他管理,直到 hook 完成为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

preStop

LifecycleHandler

由于 API 请求或管理事件(如存活度/启动探测失败、抢占、资源争用等)在容器终止前立即调用 preStop。如果容器崩溃或退出,则不会调用处理程序。Pod 的终止宽限期倒计时在执行 PreStop hook 前开始。无论处理程序的结果如何,容器最终都会在 Pod 终止宽限期内终止(除非终结器没有延迟)。对容器进行其他管理,直到 hook 完成或到达终止宽限期为止。更多信息: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

4.1.65. io.k8s.api.core.v1.LifecycleHandler schema

描述
LifecycleHandler 定义在生命周期 hook 中应执行的特定操作。必须指定其中一个字段,但必须指定 TCPSocket。
类型
对象
模式
属性类型描述

exec

ExecAction

exec 指定要执行的操作。

httpGet

HTTPGetAction

httpGet 指定要执行的 http 请求。

tcpSocket

TCPSocketAction

已弃用。tcpSocket 不支持作为 LifecycleHandler,并保持向后兼容。当指定了 tcp 处理程序时,没有此字段验证,生命周期 hook 会在运行时失败。

4.1.66. io.k8s.api.core.v1.LimitRangeList schema

描述
LimitRangeList 是 LimitRange 项目的列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(LimitRange)

items 是 LimitRange 对象列表。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.67. io.k8s.api.core.v1.LocalObjectReference schema

描述
LocalObjectReference 包含足够的信息,供您在同一个命名空间中找到引用的对象。
类型
对象
模式
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

4.1.68. io.k8s.api.core.v1.LocalVolumeSource schema

描述
local 代表与节点关联性直接附加的存储(Beta 功能)
类型
对象
必填
  • path
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。只有在路径是块设备时,它才会应用。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则默认值为自动选择文件系统。

path

字符串

到节点上卷的完整路径的路径。它可以是目录或块设备(disk, partition, …​)。

4.1.69. io.k8s.api.core.v1.NamespaceList schema

描述
NamespaceList 是命名空间列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Namespace)

items 是列表中的 Namespace 对象列表。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.70. io.k8s.api.core.v1.NFSVolumeSource schema

描述
代表 pod 的生命周期最后一个 NFS 挂载。NFS 卷不支持所有权管理或 SELinux 重新标记。
类型
对象
必填
  • server
  • path
模式
属性类型描述

path

字符串

NFS 服务器导出的路径。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

布尔值

此处的只读将强制使用只读权限挂载 NFS 导出。默认为false。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

字符串

server 是 NFS 服务器的主机名或 IP 地址。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs

4.1.71. io.k8s.api.core.v1.NodeAffinity schema

描述
节点关联性是一组节点关联性调度规则。
类型
对象
模式
属性类型描述

preferredDuringSchedulingIgnoredDuringExecution

数组(PreferredSchedulingTerm)

调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点,但可以选择违反了一个或多个表达式的节点。最首选节点是具有最大权重总和的节点,即对于满足所有调度要求(资源请求、requiredDuringScheduling 关联性表达式等)的每个节点,它通过迭代此字段元素并将 "weight" 添加到摘要中(如果节点与相应的 matchExpressions 匹配);节点具有最高总和和最高的节点。

requiredDuringSchedulingIgnoredDuringExecution

NodeSelector

如果在调度时不满足此字段指定的关联性要求,则 pod 不会调度到该节点上。如果在 Pod 执行期间由此字段指定的关联性要求满足(例如,由于更新),系统可能无法尝试最终从其节点中驱除 pod。

4.1.72. io.k8s.api.core.v1.NodeList schema

描述
NodeList 是所有使用 master 注册的节点的完整列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Node)

节点列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.73. io.k8s.api.core.v1.NodeSelector schema

描述
节点选择器表示一个或多个对一组节点的标签查询结果的联合;即,它代表节点选择器术语代表的选择器的 OR。
类型
对象
必填
  • nodeSelectorTerms
模式
属性类型描述

nodeSelectorTerms

数组(NodeSelectorTerm)

必需。节点选择器术语列表。条款是 ORed。

4.1.74. io.k8s.api.core.v1.NodeSelectorRequirement schema

描述
节点选择器要求是一个选择器,其中包含值、键和与键和值关联的操作器。
类型
对象
必填
  • key
  • operator
模式
属性类型描述

key

字符串

选择器应用到的标签键。

operator

字符串

代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt, 和 Lt.

possible enum 值:- "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn"

数组(字符串)

字符串值数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。如果 Operator 是 Gt 或 Lt,则值数组必须具有单个元素,该元素将解释为整数。这个数组会在策略性合并补丁中被替换。

4.1.75. io.k8s.api.core.v1.NodeSelectorTerm schema

描述
null 或 empty 节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。
类型
对象
模式
属性类型描述

matchExpressions

数组(NodeSelectorRequirement)

节点标签(label)的节点选择器要求列表。

matchFields

数组(NodeSelectorRequirement)

节点字段的节点选择器要求列表。

4.1.76. io.k8s.api.core.v1.ObjectFieldSelector schema

描述
ObjectFieldSelector 选择对象的 APIVersioned 字段。
类型
对象
必填
  • fieldPath
模式
属性类型描述

apiVersion

字符串

FieldPath 用术语编写的 schema 版本,默认为 "v1"。

fieldPath

字符串

在指定 API 版本中选择的字段路径。

4.1.77. io.k8s.api.core.v1.ObjectReference schema

描述
ObjectReference 包含足够信息供您检查或修改引用的对象。
类型
对象
模式
属性类型描述

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而非整个对象,则该字符串应包含有效的 JSON/Go 字段访问声明,如 desiredState.manifest.containers[2]。例如,如果对象引用是一个 pod 中的容器,它应该还以下类似: "spec.containers{name}"(其中 "name" 是指触发事件的容器的名称),如果不使用容器名称,则应类似于 "spec.containers[2]"(使用此 pod 中索引值为 2 的容器)。选择这个语法的原因是,为了有一些指向对象部分的正确定义方法。

kind

字符串

引用的类型。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

字符串

引用的命名空间。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

指定构成这个引用的 resourceVersion(如果存在)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

4.1.78. io.k8s.api.core.v1.PersistentVolumeClaim schema

描述
PersistentVolumeClaim 是用户对持久性卷的请求并声明
类型
对象
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

PersistentVolumeClaimSpec 描述了存储设备的通用属性,并允许特定于供应商的属性的源

status

对象

PersistentVolumeClaimStatus 是持久性卷声明的当前状态。

..spec Description::

+

PersistentVolumeClaimSpec 描述了存储设备的通用属性,并允许特定于供应商的属性的源

类型
对象
属性类型描述

accessModes

数组(字符串)

accessModes 包含卷应具有的所需访问模式。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

对象

TypedLocalObjectReference 包含足够信息,可让您找到同一命名空间中的 typed referenced 对象。

dataSourceRef

对象

dataSourceRef 指定在需要非空卷时,使用数据填充卷的对象。这可以是来自非空 API 组(非核心对象)或 PersistentVolumeClaim 对象的任何对象。当指定此字段时,只有在指定对象的类型与一些已安装的卷填充器或动态置备程序匹配时才会成功。此字段将替换 dataSource 字段的功能,因此如果这两个字段都不是空的,则它们必须具有相同的值。为向后兼容,当 namespace 没有在 dataSourceRef 中指定时,如果其中一个字段(dataSource 和 dataSourceRef)都自动设置为相同的值,另一个是非空的值。当在 dataSourceRef 中指定命名空间时,dataSource 不会设置为相同的值,且必须为空。dataSource 和 dataSourceRef: * While dataSource 有三个重要区别:但 dataSourceRef 只允许两种特定类型的对象,dataSourceRef 允许任何非核心对象和 PersistentVolumeClaim 对象。* 虽然 dataSource 忽略禁止的值(过滤它们),dataSourceRef 会保留所有值,并在指定了禁止的值时生成错误。* 虽然 dataSource 只允许本地对象,但 dataSourceRef 允许任何命名空间中的对象。(beta)使用此字段需要启用 AnyVolumeDataSource 功能门。(alpha)使用 dataSourceRef 的 namespace 字段需要启用 CrossNamespaceVolumeDataSource 功能门。

资源

对象

ResourceRequirements 描述计算资源要求。

selector

LabelSelector

selector 是卷上的标签查询,用于绑定。

storageClassName

字符串

storageClassName 是声明所需的 StorageClass 的名称。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeMode

字符串

volumeMode 定义声明所需的卷类型。当没有包括在 claim spec 中时,文件系统的值会被简化。

可能枚举值: - "Block" 表示卷不会被格式化为文件系统,并将保留原始块设备。- "Filesystem" 表示该卷将使用文件系统进行或格式化。

volumeName

字符串

volumeName 是支持此声明的 PersistentVolume 的绑定引用。

..spec.dataSource Description::

+

TypedLocalObjectReference 包含足够信息,可让您找到同一命名空间中的 typed referenced 对象。

类型
对象
必填
  • kind
  • name
属性类型描述

apiGroup

字符串

apiGroup 是被引用资源的组。如果没有指定 APIGroup,则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型,需要 APIGroup。

kind

字符串

kind 是被引用的资源类型

name

字符串

name 是被引用的资源的名称

..spec.dataSourceRef Description::

+

dataSourceRef 指定在需要非空卷时,使用数据填充卷的对象。这可以是来自非空 API 组(非核心对象)或 PersistentVolumeClaim 对象的任何对象。当指定此字段时,只有在指定对象的类型与一些已安装的卷填充器或动态置备程序匹配时才会成功。此字段将替换 dataSource 字段的功能,因此如果这两个字段都不是空的,则它们必须具有相同的值。为向后兼容,当 namespace 没有在 dataSourceRef 中指定时,如果其中一个字段(dataSource 和 dataSourceRef)都自动设置为相同的值,另一个是非空的值。当在 dataSourceRef 中指定命名空间时,dataSource 不会设置为相同的值,且必须为空。dataSource 和 dataSourceRef: * While dataSource 有三个重要区别:但 dataSourceRef 只允许两种特定类型的对象,dataSourceRef 允许任何非核心对象和 PersistentVolumeClaim 对象。* 虽然 dataSource 忽略禁止的值(过滤它们),dataSourceRef 会保留所有值,并在指定了禁止的值时生成错误。* 虽然 dataSource 只允许本地对象,但 dataSourceRef 允许任何命名空间中的对象。(beta)使用此字段需要启用 AnyVolumeDataSource 功能门。(alpha)使用 dataSourceRef 的 namespace 字段需要启用 CrossNamespaceVolumeDataSource 功能门。

类型
对象
必填
  • kind
  • name
属性类型描述

apiGroup

字符串

apiGroup 是被引用资源的组。如果没有指定 APIGroup,则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型,需要 APIGroup。

kind

字符串

kind 是被引用的资源类型

name

字符串

name 是被引用的资源的名称

namespace

字符串

namespace 是被引用的资源的命名空间。在指定命名空间时,引用命名空间中需要 gateway.networking.k8s.io/ReferenceGrant 对象,以允许该命名空间的所有者接受引用。详情请查看 ReferenceGrant 文档。(alpha)此字段需要启用 CrossNamespaceVolumeDataSource 功能门。

..spec.resources Description::

+

ResourceRequirements 描述计算资源要求。

类型
对象
属性类型描述

声明

array

声明列出了此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段是不可变的。它只能为容器设置。

claims[]

对象

ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。

limits

对象(数量)

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

对象(数量)

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

..spec.resources.claims Description::

+

声明列出了此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段是不可变的。它只能为容器设置。

类型
array

..spec.resources.claims[] Description::

+

ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。

类型
对象
必填
  • name
属性类型描述

name

字符串

name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中一个条目的名称匹配。它使得资源在容器内可用。

..status Description::

+

PersistentVolumeClaimStatus 是持久性卷声明的当前状态。

类型
对象
属性类型描述

accessModes

数组(字符串)

accessModes 包含支持 PVC 的卷的实际访问模式。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

allocatedResources

对象(数量)

allocatedResources 是 AllocatedResources 中的存储资源,跟踪分配给 PVC 的容量。当请求卷扩展操作时,它可能大于实际容量。对于存储配额,使用 allocatedResources 和 PVC.spec.resources 的较大的值。如果没有设置 allocatedResources,则只用于配额计算的 PVC.spec.resources。如果卷扩展容量请求较低,则仅当没有扩展操作且实际卷容量等于或小于请求的容量时,才会降低 allocatedResources。这是一个 alpha 字段,需要启用 RecoverVolumeExpansionFailure 功能。

capacity

对象(数量)

capacity 代表底层卷的实际资源。

conditions

array

conditions 是持久性卷声明的当前条件。如果底层持久性卷大小调整,则 Condition 将设置为 'ResizeStarted'。

conditions[]

对象

PersistentVolumeClaimCondition 包含有关 pvc 状态的详细信息

phase

字符串

phase 代表 PersistentVolumeClaim 的当前阶段。

可能枚举值: - "Bound" 用于绑定的 PersistentVolumeClaims - "Lost" 用于丢失其底层 PersistentVolume 的 PersistentVolumeClaim。这个声明被绑定到一个 PersistentVolume,这个卷不再存在,且其上的所有数据都丢失。- "Pending" 用于尚未绑定的 PersistentVolumeClaims

resizeStatus

字符串

resizeStatus 存储调整大小操作的状态。默认情况下,不会设置 ResizeStatus,但当扩展为 complete resizeStatus 时,通过调整大小 controller 或 kubelet 被设为空字符串。这是一个 alpha 字段,需要启用 RecoverVolumeExpansionFailure 功能。

可能枚举值: - "" when expansion is complete,通过调整大小 controller 或 kubelet 设置空字符串。- 当扩展失败时,会在扩展失败时使用终端错误设置 "ControllerExpansionFailed" State set。临时错误(如 timeout )不应设置这个状态,且应该修改 ResizeStatus,因为调整大小的控制器可以恢复卷扩展。- 在 control-plane 中扩展卷时, "ControllerExpansionInProgress" State set failed with an terminal error。临时错误不会设置 NodeExpansionFailed. - 当 kubelet 启动扩展卷时,"NodeExpansionInProgress" State set when "NodeExpansionPending" State set when resize controller has completed the volume but on the node is required on the node.

..status.conditions Description::

+

conditions 是持久性卷声明的当前条件。如果底层持久性卷大小调整,则 Condition 将设置为 'ResizeStarted'。

类型
array

..status.conditions[] Description::

+

PersistentVolumeClaimCondition 包含有关 pvc 状态的详细信息

类型
对象
必填
  • type
  • status
属性类型描述

lastProbeTime

时间

lastProbeTime 是我们探测到条件的时间。

lastTransitionTime

时间

lastTransitionTime 是条件从一个状态转换到另一个状态的时间。

message

字符串

Message 是人类可读的消息,指示最后一次转换的详细信息。

reason

字符串

原因是唯一的,这应该是简短的、机器易理解的字符串,它给出了状况最后一次转换的原因。如果报告了"ResizeStarted",这表示基础持久卷正在调整大小。

status

字符串

 

type

字符串

 

4.1.79. io.k8s.api.core.v1.PersistentVolumeClaimList schema

描述
PersistentVolumeClaimList 是 PersistentVolumeClaim 项列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(PersistentVolumeClaim)

items 是持久性卷声明列表。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.80. io.k8s.api.core.v1.PersistentVolumeClaimSpec schema

描述
PersistentVolumeClaimSpec 描述了存储设备的通用属性,并允许特定于供应商的属性的源
类型
对象
模式
属性类型描述

accessModes

数组(字符串)

accessModes 包含卷应具有的所需访问模式。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

dataSource

TypedLocalObjectReference

DataSource 字段可以用来指定:* 一个现有的 VolumeSnapshot 对象(snapshot.storage.k8s.io/VolumeSnapshot)* 一个现有的 PVC (PersistentVolumeClaim),如果置备程序或外部控制器可以支持指定的数据源,它将根据指定数据源的内容创建一个新卷。当启用 AnyVolumeDataSource 功能门时,DataSource 内容将复制到 dataSourceRef,当没有指定 dataSourceRef.namespace 时,dataSourceRef 内容将复制到 dataSource。如果指定了命名空间,则 dataSourceRef 将不会复制到 dataSource 中。

dataSourceRef

TypedObjectReference

dataSourceRef 指定在需要非空卷时,使用数据填充卷的对象。这可以是来自非空 API 组(非核心对象)或 PersistentVolumeClaim 对象的任何对象。当指定此字段时,只有在指定对象的类型与一些已安装的卷填充器或动态置备程序匹配时才会成功。此字段将替换 dataSource 字段的功能,因此如果这两个字段都不是空的,则它们必须具有相同的值。为向后兼容,当 namespace 没有在 dataSourceRef 中指定时,如果其中一个字段(dataSource 和 dataSourceRef)都自动设置为相同的值,另一个是非空的值。当在 dataSourceRef 中指定命名空间时,dataSource 不会设置为相同的值,且必须为空。dataSource 和 dataSourceRef: * While dataSource 有三个重要区别:但 dataSourceRef 只允许两种特定类型的对象,dataSourceRef 允许任何非核心对象和 PersistentVolumeClaim 对象。* 虽然 dataSource 忽略禁止的值(过滤它们),dataSourceRef 会保留所有值,并在指定了禁止的值时生成错误。* 虽然 dataSource 只允许本地对象,但 dataSourceRef 允许任何命名空间中的对象。(beta)使用此字段需要启用 AnyVolumeDataSource 功能门。(alpha)使用 dataSourceRef 的 namespace 字段需要启用 CrossNamespaceVolumeDataSource 功能门。

资源

ResourceRequirements

resources 代表卷应具有的最少资源。如果启用了 RecoverVolumeExpansionFailure 功能,则允许用户指定低于之前值的资源要求,但必须大于声明的 status 字段中记录的容量。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

selector

LabelSelector

selector 是卷上的标签查询,用于绑定。

storageClassName

字符串

storageClassName 是声明所需的 StorageClass 的名称。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

volumeMode

字符串

volumeMode 定义声明所需的卷类型。当没有包括在 claim spec 中时,文件系统的值会被简化。

可能枚举值: - "Block" 表示卷不会被格式化为文件系统,并将保留原始块设备。- "Filesystem" 表示该卷将使用文件系统进行或格式化。

volumeName

字符串

volumeName 是支持此声明的 PersistentVolume 的绑定引用。

4.1.81. io.k8s.api.core.v1.PersistentVolumeClaimTemplate schema

描述
PersistentVolumeClaimTemplate 用于生成 PersistentVolumeClaim 对象,作为 EphemeralVolumeSource 的一部分。
类型
对象
必填
  • spec
模式
属性类型描述

元数据

ObjectMeta

可以包含在创建时复制到 PVC 中的标签和注解。不允许其他字段,并在验证过程中被拒绝。

spec

PersistentVolumeClaimSpec

PersistentVolumeClaim 的规格。整个内容都会不动地复制到从该模板创建的 PVC 中。PersistentVolumeClaim 中的相同字段也有效。

4.1.82. io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource schema

描述
PersistentVolumeClaimVolumeSource 引用同一命名空间中的用户 PVC。此卷找到绑定的 PV,并为 pod 挂载这个卷。PersistentVolumeClaimVolumeSource 本质上是另一种类型的卷,它们归其他人(系统)所有。
类型
对象
必填
  • claimName
模式
属性类型描述

claimName

字符串

claimName 是使用此卷与 pod 相同的命名空间中的 PersistentVolumeClaim 的名称。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

readOnly

布尔值

readonly 将强制 VolumeMount 中的 ReadOnly 设置。默认 false。

4.1.83. io.k8s.api.core.v1.PersistentVolumeList schema

描述
PersistentVolumeList 是 PersistentVolume 项列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(PersistentVolume)

items 是持久性卷列表。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.84. io.k8s.api.core.v1.PersistentVolumeSpec schema

描述
PersistentVolumeSpec 是持久性卷的规格。
类型
对象
模式
属性类型描述

accessModes

数组(字符串)

accessModes 包含可挂载卷的所有方法。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

awsElasticBlockStore

AWSElasticBlockStoreVolumeSource

awsElasticBlockStore 代表附加到 kubelet 主机机器的 AWS Disk 资源,然后公开给 pod。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

AzureDiskVolumeSource

azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。

azureFile

AzureFilePersistentVolumeSource

azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。

capacity

对象(数量)

capacity 是持久性卷资源和容量的描述。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

cephfs

CephFSPersistentVolumeSource

CephFS 代表共享 pod 生命周期的主机上的 Ceph FS 挂载

cinder

CinderPersistentVolumeSource

Cinder 代表附加并挂载到 kubelet 主机上的 cinder 卷。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

claimRef

ObjectReference

claimRef 是 PersistentVolume 和 PersistentVolumeClaim 之间的双向绑定的一部分。当绑定时,预期为非il。claim.VolumeName 是 PV 和 PVC 之间的权威绑定。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

csi

CSIPersistentVolumeSource

CSI 代表由外部 CSI 驱动程序(Beta 功能)处理的存储。

fc

FCVolumeSource

FC 代表附加到 kubelet 主机的 Fibre Channel 资源,然后公开给 pod。

flexVolume

FlexPersistentVolumeSource

FlexVolume 代表一个通用卷资源,它使用基于 exec 的插件置备/附加。

flocker

FlockerVolumeSource

flocker 代表附加到 kubelet 主机机器的 Flocker 卷,并公开给 pod 以供其使用。这取决于运行 Flocker 控制服务

gcePersistentDisk

GCEPersistentDiskVolumeSource

gcePersistentDisk 代表附加到 kubelet 主机机器的 GCE Disk 资源,然后公开给 pod。由管理员调配。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

glusterfs

GlusterfsPersistentVolumeSource

GlusterFS 代表附加到主机并公开给 pod 的 Glusterfs 卷。由管理员调配。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

HostPathVolumeSource

hostpath 代表主机上的目录。由开发人员或测试程序调配。这仅适用于单节点开发和测试!在多节点集群中,不支持主机存储,在多节点集群中不支持 WILL NOT WORK。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

iscsi

ISCSIPersistentVolumeSource

iSCSI 代表附加到 kubelet 主机机器的 ISCSI 磁盘资源,然后公开给 pod。由管理员调配。

local

LocalVolumeSource

local 代表与节点关联性直接附加的存储

mountOptions

数组(字符串)

mountOptions 是挂载选项列表,如 ["ro", "soft"]。未验证 - 如果挂载无效,则挂载将失败。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

nfs

NFSVolumeSource

NFS 代表主机上的 NFS 挂载。由管理员调配。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#nfs

nodeAffinity

VolumeNodeAffinity

nodeAffinity 定义限制此卷可从中访问哪些节点。此字段会影响使用这个卷的 pod 的调度。

persistentVolumeReclaimPolicy

字符串

persistentVolumeReclaimPolicy 定义从声明中释放持久性卷时会发生什么。有效选项为 Retain (为手动创建的 PersistentVolume 的默认设置)、Delete (动态置备的 PersistentVolume 的默认)和 Recycle (已弃用)。Recycle 必须被此 PersistentVolume 底层的卷插件支持。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

可能枚举值: - "Delete" 表示该卷将从其声明中的 Kubernetes 中删除。卷插件必须支持 Deletion。- "Recycle" 意味着卷将被重新回收到其声明中未绑定持久性卷的池。卷插件必须支持 Recycling。- "Retain" 表示该卷将保留在其当前阶段(Released)中,供管理员手动回收。默认策略为 Retain。

photonPersistentDisk

PhotonPersistentDiskVolumeSource

photonPersistentDisk 代表在 kubelets 主机上附加并挂载的 PhotonController 持久磁盘

portworxVolume

PortworxVolumeSource

portworxVolume 代表附加并挂载到 kubelet 主机上的 portworx 卷

quobyte

QuobyteVolumeSource

quobyte 代表共享 pod 生命周期的主机上的 Quobyte 挂载

rbd

RBDPersistentVolumeSource

RBD 代表共享 pod 生命周期的主机上的 Rados 块设备挂载。更多信息: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

ScaleIOPersistentVolumeSource

scaleIO 代表一个在 Kubernetes 节点上附加并挂载的 ScaleIO 持久性卷。

storageClassName

字符串

storageClassName 是这个持久性卷所属的 StorageClass 的名称。空值意味着这个卷不属于任何 StorageClass。

storageos

StorageOSPersistentVolumeSource

storageos 代表附加到 kubelet 主机机器的 StorageOS 卷,并挂载到 pod 更多信息: https://examples.k8s.io/volumes/storageos/README.md

volumeMode

字符串

volumeMode 定义卷是否要与格式化的文件系统一起使用,或者保持在原始块状态。当没有包括在 spec 中时,文件系统的值会被简化。

可能枚举值: - "Block" 表示卷不会被格式化为文件系统,并将保留原始块设备。- "Filesystem" 表示该卷将使用文件系统进行或格式化。

vsphereVolume

VsphereVirtualDiskVolumeSource

vsphereVolume 代表在 kubelets 主机上附加并挂载的 vSphere 卷

4.1.85. io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource schema

描述
代表 Photon Controller 持久磁盘资源。
类型
对象
必填
  • pdID
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

pdID

字符串

pdID 是标识 Photon Controller 持久磁盘的 ID

4.1.86. io.k8s.api.core.v1.PodAffinity schema

描述
Pod 关联性是一组 pod 关联性调度规则。
类型
对象
模式
属性类型描述

preferredDuringSchedulingIgnoredDuringExecution

数组(WeightedPodAffinityTerm)

调度程序希望将 pod 调度到满足此字段指定的关联性表达式的节点,但可以选择违反了一个或多个表达式的节点。最首选节点是具有最大权重总和的节点,即对于满足所有调度要求(资源请求、requiredDuringScheduling 关联性表达式等)的每个节点,它通过迭代此字段元素并将 "weight" 添加到摘要中,如果节点具有与相应 podAffinityTerm 匹配的 pod;具有最高总和最高的节点是首选的节点。

requiredDuringSchedulingIgnoredDuringExecution

数组(PodAffinityTerm)

如果在调度时不满足此字段指定的关联性要求,则 pod 不会调度到该节点上。如果在 pod 执行期间由此字段指定的关联性要求满足(例如,因为 pod 标签更新),则系统可能无法最终尝试从其节点中驱除 pod。当有多个元素时,每个 podAffinityTerm 对应的节点列表会被干扰,例如,所有术语都必须满足。

4.1.87. io.k8s.api.core.v1.PodAffinityTerm schema

描述
定义一组 pod (与给定命名空间匹配的 labelSelector 匹配),此 pod 应该与 pod 共存(关联性)或不共存(反关联性)匹配,其中 co-located 定义在带有键 <topologyKey> 标签的节点上运行,其标签的值与运行 pod 的任何节点匹配
类型
对象
必填
  • topologyKey
模式
属性类型描述

labelSelector

LabelSelector

一个对一组资源的标签查询,本例中为 pod。

namespaceSelector

LabelSelector

对术语应用到的命名空间集合的标签查询。术语应用于此字段选择的命名空间的联合,以及 namespaces 字段中列出的命名空间。null selector 和 null 或 empty namespace 列表表示"此 pod 的命名空间"。空选择器({})与所有命名空间匹配。

命名空间

数组(字符串)

namespaces 指定术语应用到的命名空间名称的静态列表。术语应用于此字段中列出的命名空间,由 namespaceSelector. null 或空命名空间列表和 null namespaceSelector 选择的命名空间合并意味着"此 pod 的命名空间"。

topologyKey

字符串

此 pod 应该与指定命名空间中 labelSelector 匹配的 pod 在一起(关联性)或不并置(反关联性),其中 co-located 定义为在具有键 topologyKey 标签的节点中运行。不允许空的 topologyKey。

4.1.88. io.k8s.api.core.v1.PodAntiAffinity schema

描述
Pod 反关联性是一组 pod 反关联性调度规则。
类型
对象
模式
属性类型描述

preferredDuringSchedulingIgnoredDuringExecution

数组(WeightedPodAffinityTerm)

调度程序希望将 pod 调度到满足此字段指定的反关联性表达式的节点,但可以选择违反了一个或多个表达式的节点。最首选节点是具有最大权重总和的节点,即对于满足所有调度要求(资源请求、requiredDuringScheduling 反关联性表达式等)的每个节点,它通过迭代此字段元素来计算和将"权重"添加到节点具有与相应 podAffinityTerm 匹配的 pod;如果节点具有与相应 podAffinityTerm 匹配的 pod,则该节点是首选的。

requiredDuringSchedulingIgnoredDuringExecution

数组(PodAffinityTerm)

如果在调度时不满足由此字段指定的反关联性要求,则 pod 不会调度到节点上。如果在 pod 执行期间由此字段指定的反关联性要求满足(例如,因为 pod 标签更新),则系统可能无法最终尝试从其节点中驱除 pod。当有多个元素时,每个 podAffinityTerm 对应的节点列表会被干扰,例如,所有术语都必须满足。

4.1.89. io.k8s.api.core.v1.PodDNSConfig schema

描述
PodDNSConfig 还定义了 pod 的 DNS 参数,除了从 DNSPolicy 生成的。
类型
对象
模式
属性类型描述

nameservers

数组(字符串)

DNS 名称服务器 IP 地址列表。这将附加到从 DNSPolicy 生成的基本名称服务器。将删除重复的名称服务器。

options

数组(PodDNSConfigOption)

DNS 解析器选项列表。这将与 DNSPolicy 生成的基本选项合并。将删除重复的条目。Options 中给出的解析选项将覆盖基本 DNSPolicy 中显示的解析选项。

搜索

数组(字符串)

host-name 查找的 DNS 搜索域列表。这将附加到 DNSPolicy 生成的基本搜索路径中。将删除重复的搜索路径。

4.1.90. io.k8s.api.core.v1.PodDNSConfigOption schema

描述
PodDNSConfigOption 定义 pod 的 DNS 解析器选项。
类型
对象
模式
属性类型描述

name

字符串

必需。

value

字符串

 

4.1.91. io.k8s.api.core.v1.PodList schema

描述
PodList 是一个 Pod 列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Pod)

pod 列表。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.92. io.k8s.api.core.v1.PodOS schema

描述
PodOS 定义 pod 的 OS 参数。
类型
对象
必填
  • name
模式
属性类型描述

name

字符串

name 是操作系统的名称。目前支持的值有 linux 和 windows。额外值可能会在以后定义,可以是: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration 客户端应该应该处理附加值,并将此字段中的未识别的值视为 os: null

4.1.93. io.k8s.api.core.v1.PodReadinessGate schema

描述
PodReadinessGate 包含对 pod 条件的引用
类型
对象
必填
  • conditionType
模式
属性类型描述

conditionType

字符串

conditionType 指的是 pod 条件列表中具有匹配类型的条件。

4.1.94. io.k8s.api.core.v1.PodResourceClaim schema

描述
PodResourceClaim 通过 ClaimSource 准确引用一个 ResourceClaim。它添加一个名称,用于唯一标识 Pod 中的 ResourceClaim。需要访问 ResourceClaim 的容器使用此名称引用它。
类型
对象
必填
  • name
模式
属性类型描述

name

字符串

在 pod 中唯一标识此资源声明的名称。这必须是 DNS_LABEL。

source

ClaimSource

source 描述在什么位置查找 ResourceClaim。

4.1.95. io.k8s.api.core.v1.PodSchedulingGate schema

描述
PodSchedulingGate 与 Pod 关联,以保护其调度。
类型
对象
必填
  • name
模式
属性类型描述

name

字符串

调度授权的名称。每个调度最低要求都必须具有唯一的 name 字段。

4.1.96. io.k8s.api.core.v1.PodSecurityContext schema

描述
PodSecurityContext 包含 pod 级别的安全属性和通用容器设置。container.securityContext 中也存在一些字段。container.securityContext 的字段值优先于 PodSecurityContext 的字段值。
类型
对象
模式
属性类型描述

fsGroup

整数

适用于 pod 中所有容器的特殊补充组。有些卷类型允许 Kubelet 将该卷的所有权更改为 pod 拥有:

1.所属 GID 将是 FSGroup 2。set setgid 位(在卷中创建的新文件将归 FSGroup 所有)3。权限位为 OR'd with rw-rw----

如果未设置,Kubelet 将不修改任何卷的所有权和权限。请注意,当 spec.os.name 是窗口时,无法设置此字段。

fsGroupChangePolicy

字符串

fsGroupChangePolicy 定义在 Pod 中公开卷之前更改卷的所有权和权限的行为。此字段仅适用于支持 fsGroup 基于所有权(和权限)的卷类型。它对临时卷类型没有影响,如: secret、configmaps 和 emptydir。有效值为 "OnRootMismatch" 和 "Always"。如果没有指定,则使用 "Always"。请注意,当 spec.os.name 是窗口时,无法设置此字段。

可能枚举值: - "Always" 表示当卷挂载到 Pod 中时,应始终更改卷的所有权和权限。这个默认行为。- "OnRootMismatch" 表示只有在根目录的权限与卷上预期权限不匹配时才会更改卷的所有权和权限。这有助于缩短更改卷的所有权和权限所需的时间。

runAsGroup

整数

运行容器进程的入口点的 GID。如果未设置,则使用运行时默认值。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则在 SecurityContext 中指定的值优先于该容器。请注意,当 spec.os.name 是窗口时,无法设置此字段。

runAsNonRoot

布尔值

表示容器必须以非 root 用户身份运行。如果为 true,Kubelet 将在运行时验证镜像,以确保它不会以 UID 0 (root)运行,如果容器确实无法启动它,则无法启动它。如果未设置或 false,则不会执行这样的验证。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。

runAsUser

整数

运行容器进程的入口点的 UID。如果未指定,则默认为镜像元数据中指定的用户。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则在 SecurityContext 中指定的值优先于该容器。请注意,当 spec.os.name 是窗口时,无法设置此字段。

seLinuxOptions

seLinuxOptions

要应用到所有容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 SecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则在 SecurityContext 中指定的值优先于该容器。请注意,当 spec.os.name 是窗口时,无法设置此字段。

SeccompProfile

SeccompProfile

此 pod 中容器使用的 seccomp 选项。请注意,当 spec.os.name 是窗口时,无法设置此字段。

supplementalGroups

数组(整数)

除了容器的主 GID、fsGroup (如果指定)以及容器镜像中定义的组成员资格(如果指定)之外,应用于每个容器中的第一个进程运行的组列表。如果未指定,则不会将额外的组添加到任何容器中。请注意,容器进程的 uid 中定义的组成员资格仍然有效,即使它们没有包括在此列表中。请注意,当 spec.os.name 是窗口时,无法设置此字段。

sysctls

数组(Sysctl)

sysctl 包含用于 pod 的命名空间 sysctl 的列表。带有不支持的 sysctl (由容器运行时)的 Pod 可能无法启动。请注意,当 spec.os.name 是窗口时,无法设置此字段。

windowsOptions

WindowsSecurityContextOptions

应用到所有容器的 Windows 特定设置。如果未指定,则使用容器的 SecurityContext 选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。请注意,当 spec.os.name 是 linux 时,无法设置此字段。

4.1.97. io.k8s.api.core.v1.PodSpec schema

描述
PodSpec 是 pod 的描述。
类型
对象
必填
  • containers
模式
属性类型描述

activeDeadlineSeconds

整数

在系统主动尝试标记失败并终止相关的容器前,pod 可以在相对于 StartTime 的节点上处于活跃状态。值必须是正整数。

关联性

关联性

如果指定,pod 的调度限制

automountServiceAccountToken

布尔值

AutomountServiceAccountToken 指明是否应该自动挂载服务帐户令牌。

containers

数组(Container)

属于 pod 的容器列表。容器目前无法添加或删除。Pod 中必须至少有一个容器。无法更新。

dnsConfig

PodDNSConfig

指定 pod 的 DNS 参数。此处指定的参数将根据 DNSPolicy 合并到生成的 DNS 配置中。

DNSPolicy

字符串

为 pod 设置 DNS 策略。默认为 "ClusterFirst"。有效值为 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' 或 'None'。DNSConfig 中给定的 DNS 参数将与选择与 DNSPolicy 的策略合并。要将 DNS 选项与 hostNetwork 一起设置,您必须将 DNS 策略明确指定为 'ClusterFirstWithHostNet'。

可能枚举值: - "ClusterFirst" 表示 pod 应该先使用集群 DNS,除非 hostNetwork 为 true,如果可用,则回退到默认的(由 kubelet 决定)DNS 设置。- "ClusterFirstWithHostNet" 表示 pod 应该首先使用集群 DNS,如果可用,则回退到它。 在默认的(由 kubelet 决定)DNS 设置中。- "Default" 表示 pod 应该使用默认(由 kubelet 决定)DNS 设置。- "None" 表示 pod 应该使用空的 DNS 设置。名称服务器和搜索路径等 DNS 参数应该通过 DNSConfig 定义。

enableServiceLinks

布尔值

EnableServiceLinks 指示是否应将有关服务的信息注入到 pod 的环境变量中,与 Docker 链接的语法匹配。可选:默认为 true。

ephemeralContainers

数组(EphemeralContainer)

此 pod 中运行的临时容器列表。临时容器可以在现有 pod 中运行,以执行用户发起的操作,如调试。创建 pod 时无法指定此列表,无法通过更新 pod 规格来修改它。要将临时容器添加到现有 pod 中,请使用 pod 的 ephemeralcontainers 子资源。

hostAliases

数组(HostAlias)

hostAliases 是主机和 IP 的可选列表,如果指定,将注入到 pod 的主机文件中。这只适用于非主机网络 pod。

hostIPC

布尔值

使用主机的 ipc 命名空间。可选:默认为 false。

hostNetwork

布尔值

为此 pod 请求的主机网络。使用主机的网络命名空间。如果设置了这个选项,则必须指定要使用的端口。默认为 false。

hostPID

布尔值

使用主机的 pid 命名空间。可选:默认为 false。

hostUsers

布尔值

使用主机的用户命名空间。可选:默认为 true。如果设置为 true 或不存在,则 pod 将在主机用户命名空间中运行,当 pod 需要可供主机用户命名空间使用的功能时,如加载带有 CAP_SYS_MODULE 的内核模块。当设置为 false 时,会为 pod 创建一个新的 userns。设置 false 有助于缓解容器中断漏洞,即使允许用户以 root 身份运行其容器,而无需实际在主机上具有 root 特权。此字段是 alpha-level,仅被启用 UserNamespacesSupport 功能的服务器所接受。

hostname

字符串

如果没有指定 Pod 的主机名,则 pod 的主机名将设置为系统定义的值。

imagePullSecrets

数组(LocalObjectReference)

imagePullSecrets 是同一命名空间中 secret 的引用列表,用于拉取此 PodSpec 使用的任何镜像。如果指定,这些 secret 将传递给单独的 puller 实现,供它们使用。更多信息: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

initContainers

数组(Container)

属于 pod 的初始化容器列表。init 容器在容器启动前先执行。如果任何 init 容器失败,pod 被视为失败,并根据其 restartPolicy 处理。init 容器或普通容器的名称必须在所有容器间唯一。Init 容器可能没有生命周期操作、就绪度探测、存活度探测或启动探测。init 容器的 resourceRequirements 在调度过程中考虑,方法是为每个资源类型找到最高 request/limit,然后使用该值或普通容器的总和。限制以类似的方式应用到 init 容器。目前无法添加或删除 init 容器。无法更新。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

nodeName

字符串

nodeName 是一个将此 pod 调度到特定节点的请求。如果是非空,调度程序只会将此 pod 调度到该节点上,假设它符合资源要求。

nodeSelector

对象(字符串)

nodeSelector 是一个选择器,必须为 true 才能使 pod 适合节点。必须与 pod 标签匹配的选择器,才能调度到该节点上。更多信息: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

OS

PodOS

指定 pod 中容器的 OS。如果设置了,则一些 pod 和容器字段会被限制。

如果 OS 字段设为 linux,则必须取消设置以下字段: -securityContext.windowsOptions

如果 OS 字段设置为 windows,则必须取消设置以下字段: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.hostUsers - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup

开销

对象(数量)

开销代表了与为给定 RuntimeClass 运行 pod 相关的资源开销。此字段将由 RuntimeClass 准入控制器在准入时自动填充。如果启用了 RuntimeClass 准入控制器,则无法在 Pod 创建请求中设置开销。RuntimeClass 准入控制器将拒绝 Pod 创建已设置开销的请求。如果在 PodSpec 中配置并选择了 RuntimeClass,则 Overhead 将被设置为对应的 RuntimeClass 中定义的值,否则它将保留为未设置并被视为零。更多信息: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md

preemptionPolicy

字符串

preemptionPolicy 是抢占优先级较低的 pod 的策略。Never, PreemptLowerPriority 之一。如果未设置,则默认为 PreemptLowerPriority。

可能枚举值: - "Never" 表示 pod 不会抢占优先级较低的其他 pod。- "PreemptLowerPriority" 表示 pod 可以抢占优先级较低的其他 pod。

priority

整数

优先级值。各种系统组件使用此字段查找 pod 的优先级。启用 Priority Admission Controller 时,它会阻止用户设置此字段。准入控制器从 PriorityClassName 填充此字段。数值越大,优先级越高。

priorityClassName

字符串

如果指定,则表示 pod 的优先级。"system-node-critical"和"system-cluster-critical"是两个特殊关键字,表示前者最高的优先级。必须使用该名称创建 PriorityClass 对象来定义任何其他名称。如果没有指定,如果没有默认值,pod 优先级将为 default 或零。

readinessGates

数组(PodReadinessGate)

如果指定,则会针对 pod 就绪度评估所有就绪度。当它的所有容器都就绪且在就绪度授权中指定的所有条件都等于"True"更多信息时,pod 已就绪: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates

resourceClaims

数组(PodResourceClaim)

ResourceClaims 定义在允许 Pod 启动前必须分配和保留哪些 ResourceClaims。资源将提供给那些按名称消耗它们的容器。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段是不可变的。

restartPolicy

字符串

为 pod 中的所有容器重启策略。Always、OnFailure、Never 之一。在某些上下文中,仅允许这些值的子集。默认值为 Always。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

可能枚举值: - "Always" - "Never" - "OnFailure"

runtimeClassName

字符串

runtimeClassName 指的是 node.k8s.io 组中的 RuntimeClass 对象,它应该用于运行此 pod。如果没有 RuntimeClass 资源与命名类匹配,则不会运行 pod。如果未设置或为空,则使用 "legacy" RuntimeClass,它是一个带有使用默认运行时处理器的空定义的隐式类。更多信息: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class

schedulerName

字符串

如果指定,pod 将由指定的调度程序分配。如果没有指定,pod 将默认调度程序分配。

schedulingGates

数组(PodSchedulingGate)

SchedulingGates 是值(如果指定)将阻止调度 pod 的不透明列表。如果 schedulingGates 不是空的,pod 将保持在 SchedulingGated 状态,调度程序也不会尝试调度 pod。

SchedulingGates 只能在创建 pod 时设置,之后只能删除。

这是 PodSchedulingReadiness 功能门启用的 beta 功能。

securityContext

PodSecurityContext

securityContext 包含 pod 级别的安全属性和通用容器设置。可选:默认为空。有关每个字段的默认值,请参阅类型描述。

serviceAccount

字符串

deprecatedServiceAccount 是 ServiceAccountName 的前文别名。deprecated :改为使用 serviceAccountName。

serviceAccountName

字符串

serviceAccountName 是用于运行此 pod 的 ServiceAccount 的名称。更多信息: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

setHostnameAsFQDN

布尔值

如果为 true,则 pod 的主机名将配置为 pod 的 FQDN,而不是叶名称(默认值)。在 Linux 容器中,这意味着在内核的 hostname 字段中设置 FQDN ( struct utsname 的 nodename 字段)。在 Windows 容器中,这意味着将 registry 键 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters 的 registry 值设置为 FQDN。如果 pod 没有 FQDN,则无效。默认为 false。

shareProcessNamespace

布尔值

在 pod 中所有容器间共享单个进程命名空间。设置此容器后,将能够查看和信号来自同一 pod 中其他容器的进程,并且每个容器中的第一个进程不会被分配 PID 1。无法同时设置 hostPID 和 ShareProcessNamespace。可选:默认为 false。

subdomain

字符串

如果指定,完全限定的 Pod 主机名将是 "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>"。如果没有指定,pod 根本不会具有 domainname。

terminationGracePeriodSeconds

整数

pod 需要安全终止的可选持续时间(以秒为单位)。在删除请求中可能会减少。值必须是非负整数。值零表示通过 kill 信号立即停止(没有关闭的机会)。如果这个值为 nil,则使用默认的宽限期。宽限期是 pod 中运行的进程发送终止信号的持续时间(以秒为单位),以及进程通过 kill 信号强制停止的时间。设置这个值比您的进程预期的清理时间长。默认值为 30 秒。

容限(tolerations)

数组(Toleration)

如果指定,pod 的容限。

topologySpreadConstraints

array (TopologySpreadConstraint)

topologySpreadConstraints 描述如何在拓扑域中分散的 pod 组。调度程序将通过约束来调度 pod。所有 topologySpreadConstraints 都是 AND。

数组(Volume)

可由属于 pod 的容器挂载的卷列表。更多信息: https://kubernetes.io/docs/concepts/storage/volumes

4.1.98. io.k8s.api.core.v1.PodTemplateList schema

描述
PodTemplateList 是 PodTemplates 列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(PodTemplate)

pod 模板列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.99. io.k8s.api.core.v1.PodTemplateSpec schema

描述
PodTemplateSpec 描述了从模板创建 pod 时应该具有的数据
类型
对象
模式
属性类型描述

元数据

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

PodSpec

pod 所需的行为的规格。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

4.1.100. io.k8s.api.core.v1.PortworxVolumeSource schema

描述
PortworxVolumeSource 代表一个 Portworx volume 资源。
类型
对象
必填
  • volumeID
模式
属性类型描述

fsType

字符串

fstype 代表要挂载的文件系统类型,必须是主机操作系统支持的文件系统类型。EX. "ext4", "xfs"。如果未指定,则隐式推断为"ext4"。

readOnly

布尔值

只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

volumeID

字符串

VolumeId 唯一标识一个 Portworx 卷

4.1.101. io.k8s.api.core.v1.PreferredSchedulingTerm schema

描述
空首选调度术语与所有带有隐式权重 0 的对象匹配(例如,它是一个 no-op)。null 首选调度术语不匹配任何对象(例如,也是 no-op)。
类型
对象
必填
  • weight
  • preference
模式
属性类型描述

preference

NodeSelectorTerm

节点选择器术语,与对应的权重关联。

weight

整数

与对应的 nodeSelectorTerm 匹配的权重,范围为 1-100。

4.1.102. io.k8s.api.core.v1.Probe schema

描述
probe 描述了要对容器执行的健康检查,以确定它是否处于活动状态或准备好接收流量。
类型
对象
模式
属性类型描述

exec

ExecAction

exec 指定要执行的操作。

failureThreshold

整数

在成功后,探测被视为失败的连续最小失败。默认值为 3。最小值为 1。

grpc

GRPCAction

GRPC 指定涉及 GRPC 端口的操作。

httpGet

HTTPGetAction

httpGet 指定要执行的 http 请求。

initialDelaySeconds

整数

容器启动后的秒数,然后再启动存活度探测。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSeconds

整数

执行探测的频率(以秒为单位)。默认值为 10 秒。最小值为 1。

successThreshold

整数

在失败后,探测被视为成功的最低连续成功。默认为 1。对于存活度和启动,必须为 1。最小值为 1。

tcpSocket

TCPSocketAction

tcpSocket 指定涉及 TCP 端口的操作。

terminationGracePeriodSeconds

整数

可选持续时间(以秒为单位),pod 需要在探测失败时安全终止。宽限期是 pod 中运行的进程发送终止信号的持续时间(以秒为单位),以及进程通过 kill 信号强制停止的时间。设置这个值比您的进程预期的清理时间长。如果这个值为 nil,则使用 pod 的 terminationGracePeriodSeconds。否则,这个值会覆盖 pod 规格提供的值。值必须是非负整数。值零表示通过 kill 信号立即停止(没有关闭的机会)。这是一个 beta 字段,需要启用 ProbeTerminationGracePeriod 功能门。如果未设置,则使用最小值为 1. spec.terminationGracePeriodSeconds。

timeoutSeconds

整数

探测超时的秒数。默认值为 1 秒。最小值为 1。更多信息: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

4.1.103. io.k8s.api.core.v1.ProjectedVolumeSource schema

描述
代表投射卷源
类型
对象
模式
属性类型描述

defaultMode

整数

defaultMode 是默认用来对创建文件设置权限的模式位。必须是 0000 到 0777 之间的数值,也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值,JSON 需要模式位的十进制值。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项(如 fsGroup )冲突,结果可以是设置其他模式位。

sources

数组(VolumeProjection)

sources 是卷投射列表

4.1.104. io.k8s.api.core.v1.QuobyteVolumeSource schema

描述
代表 pod 的生命周期持续的 Quobyte 挂载。quobyte 卷不支持所有权管理或 SELinux 重新标记。
类型
对象
必填
  • registry
模式
属性类型描述

group

字符串

将卷访问映射到 Default 的组没有组

readOnly

布尔值

此处的只读将强制使用只读权限挂载 Quobyte 卷。默认为false。

registry

字符串

registry 代表一个或多个 Quobyte Registry 服务,作为字符串指定为 host:port 对(多个条目用逗号分隔),后者充当卷的中央 registry

tenant

字符串

在带有动态置备 Quobyte 卷的后端中拥有给定 Quobyte 卷的租户,值由插件设置

user

字符串

用户将卷访问权限映射到默认值到 serivceaccount 用户

字符串

卷是一个字符串,它根据名称引用已创建的 Quobyte 卷。

4.1.105. io.k8s.api.core.v1.RBDPersistentVolumeSource schema

描述
代表 Rados 块设备挂载,该挂载最后是 pod 的生命周期。RBD 卷支持所有权管理和 SELinux 重新标记。
类型
对象
必填
  • monitor
  • image
模式
属性类型描述

fsType

字符串

fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#rbd

image

字符串

image 是 rados 镜像名称。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

字符串

keyring 是 RBDUser 的密钥环的路径。默认为 /etc/ceph/keyring。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitor

数组(字符串)

monitor 是 Ceph 监视器的集合。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

字符串

pool 是 rados 池名称。默认为 rbd。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

SecretReference

secretRef 是 RBDUser 的身份验证 secret 的名称。如果提供,则会覆盖密钥环。默认为 nil。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

user

字符串

user 是 rados 用户名。默认为 admin。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

4.1.106. io.k8s.api.core.v1.RBDVolumeSource schema

描述
代表 Rados 块设备挂载,该挂载最后是 pod 的生命周期。RBD 卷支持所有权管理和 SELinux 重新标记。
类型
对象
必填
  • monitor
  • image
模式
属性类型描述

fsType

字符串

fstype 是您要挂载的卷的文件系统类型。提示: 确保主机操作系统支持文件系统类型。示例:"ext4", "xfs", "ntfs"。如果未指定,则隐式推断为"ext4"。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#rbd

image

字符串

image 是 rados 镜像名称。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

字符串

keyring 是 RBDUser 的密钥环的路径。默认为 /etc/ceph/keyring。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitor

数组(字符串)

monitor 是 Ceph 监视器的集合。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

字符串

pool 是 rados 池名称。默认为 rbd。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

布尔值

此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。默认为false。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

LocalObjectReference

secretRef 是 RBDUser 的身份验证 secret 的名称。如果提供,则会覆盖密钥环。默认为 nil。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

user

字符串

user 是 rados 用户名。默认为 admin。更多信息: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

4.1.107. io.k8s.api.core.v1.ReplicationControllerList schema

描述
ReplicationControllerList 是复制控制器的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ReplicationController)

复制控制器列表。更多信息: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.108. io.k8s.api.core.v1.ResourceClaim schema

描述
ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
类型
对象
必填
  • name
模式
属性类型描述

name

字符串

name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中一个条目的名称匹配。它使得资源在容器内可用。

4.1.109. io.k8s.api.core.v1.ResourceFieldSelector schema

描述
ResourceFieldSelector 代表容器资源(cpu、memory)及其输出格式
类型
对象
必填
  • resource
模式
属性类型描述

containerName

字符串

容器名称:卷所需,对于 env vars 是可选的

divisor

数量

指定公开资源的输出格式,默认为 "1"

resource

字符串

必需:要选择的资源

4.1.110. io.k8s.api.core.v1.ResourceQuotaList schema

描述
ResourceQuotaList 是 ResourceQuota 项目的列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ResourceQuota)

items 是 ResourceQuota 对象的列表。更多信息: https://kubernetes.io/docs/concepts/policy/resource-quotas/

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.111. io.k8s.api.core.v1.ResourceRequirements schema

描述
ResourceRequirements 描述计算资源要求。
类型
对象
模式
属性类型描述

声明

数组(ResourceClaim)

声明列出了此容器使用的 spec.resourceClaims 中定义的资源名称。

这是一个 alpha 字段,需要启用 DynamicResourceAllocation 功能门。

此字段是不可变的。它只能为容器设置。

limits

对象(数量)

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

对象(数量)

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

4.1.112. io.k8s.api.core.v1.ScaleIOPersistentVolumeSource schema

描述
ScaleIOPersistentVolumeSource 代表一个持久的 ScaleIO 卷
类型
对象
必填
  • gateway
  • system
  • secretRef
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs"

gateway

字符串

gateway 是 ScaleIO API 网关的主机地址。

protectionDomain

字符串

protectionDomain 是配置的存储的 ScaleIO 保护域的名称。

readOnly

布尔值

只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

SecretReference

secretRef 对 secret for ScaleIO 用户和其他敏感信息的引用。如果没有提供,则 Login 操作将失败。

sslEnabled

布尔值

sslEnabled 是启用/禁用与网关的 SSL 通信的标记,默认为 false

storageMode

字符串

storageMode 指示卷的存储应该是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。

storagePool

字符串

storagePool 是与保护域关联的 ScaleIO 存储池。

system

字符串

system 是存储系统的名称,如 ScaleIO 中配置。

volumeName

字符串

volumeName 是在与这个卷源关联的 ScaleIO 系统中创建的卷的名称。

4.1.113. io.k8s.api.core.v1.ScaleIOVolumeSource schema

描述
ScaleIOVolumeSource 代表一个持久的 ScaleIO 卷
类型
对象
必填
  • gateway
  • system
  • secretRef
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".默认为 "xfs"。

gateway

字符串

gateway 是 ScaleIO API 网关的主机地址。

protectionDomain

字符串

protectionDomain 是配置的存储的 ScaleIO 保护域的名称。

readOnly

布尔值

只读默认值为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

LocalObjectReference

secretRef 对 secret for ScaleIO 用户和其他敏感信息的引用。如果没有提供,则 Login 操作将失败。

sslEnabled

布尔值

sslEnabled Flag 启用/禁用与网关的 SSL 通信,默认为 false

storageMode

字符串

storageMode 指示卷的存储应该是 ThickProvisioned 或 ThinProvisioned。默认为 ThinProvisioned。

storagePool

字符串

storagePool 是与保护域关联的 ScaleIO 存储池。

system

字符串

system 是存储系统的名称,如 ScaleIO 中配置。

volumeName

字符串

volumeName 是在与这个卷源关联的 ScaleIO 系统中创建的卷的名称。

4.1.114. io.k8s.api.core.v1.SeccompProfile schema

描述
SeccompProfile 定义 pod/container 的 seccomp 配置集设置。只能设置一个配置文件源。
类型
对象
必填
  • type
模式
属性类型描述

localhostProfile

字符串

localhostProfile 表示使用节点上文件中定义的配置集。该配置集必须在节点上预先配置才能正常工作。必须是相对于 kubelet 配置的 seccomp 配置集位置的降序路径。只有当 type 为 "Localhost" 时,才必须设置。

type

字符串

type 表示将应用了哪些 seccomp 配置集。有效选项有:

localhost - 应该使用节点上文件中定义的配置集。RuntimeDefault - 应使用容器运行时默认配置集。unconfined - 不应应用任何配置集。

可能枚举值: - "Localhost" 表示应使用节点上文件中定义的配置集。文件相对于 <kubelet-root-dir>/seccomp. - "RuntimeDefault" 代表默认的容器运行时 seccomp 配置集。- "Unconfined" 表示没有应用 seccomp 配置集(A.K.A. unconfined)。

4.1.115. io.k8s.api.core.v1.SecretEnvSource schema

描述

SecretEnvSource 选择一个 Secret 来填充环境变量。

目标 Secret 的数据字段的内容将以环境变量的形式表示键值对。

类型
对象
模式
属性类型描述

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret

4.1.116. io.k8s.api.core.v1.SecretKeySelector schema

描述
SecretKeySelector 选择 Secret 的密钥。
类型
对象
必填
  • key
模式
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

指定是否需要定义 Secret 或其密钥

4.1.117. io.k8s.api.core.v1.SecretList schema

描述
SecretList 是一个 Secret 列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Secret)

items 是 secret 对象的列表。更多信息: https://kubernetes.io/docs/concepts/configuration/secret

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.118. io.k8s.api.core.v1.SecretProjection schema

描述

将 secret 适应到投射卷中。

目标 Secret 的数据字段的内容将作为文件出现在投射卷中,使用 Data 字段中的密钥作为文件名。请注意,这与没有默认模式的 secret 卷源相同。

类型
对象
模式
属性类型描述

items

数组(KeyToPath)

如果未指定项目,则引用 Secret 的 Data 字段中每个键值对将投射到卷中,名称为键,内容是值。如果指定,列出的键将投射到指定的路径中,且未列出的密钥将不存在。如果指定了在 Secret 中不存在的密钥,则卷设置将错误,除非标记为可选。路径必须是 relative,且不能包含 '..' 路径或以 '..' 开头。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optional

布尔值

可选字段指定是否需要定义 Secret 或其密钥

4.1.119. io.k8s.api.core.v1.SecretReference schema

描述
secretReference 代表一个 Secret Reference。它有足够的信息来检索任何命名空间中的 secret
类型
对象
模式
属性类型描述

name

字符串

名称在命名空间内是唯一的,以引用 secret 资源。

namespace

字符串

namespace 定义 secret 名称必须唯一的空间。

4.1.120. io.k8s.api.core.v1.SecretVolumeSource schema

描述

将 Secret 调整为卷。

目标 Secret 的数据字段的内容将作为文件显示在卷中,并将 Data 字段中的密钥用作文件名。Secret 卷支持所有权管理和 SELinux 重新标记。

类型
对象
模式
属性类型描述

defaultMode

整数

defaultMode 是可选:用于默认设置创建文件的权限的模式位。必须是 0000 到 0777 之间的数值,也可以是 0 到 511 之间的十进制值。YAML 接受八进制值和十进制值,JSON 需要模式位的十进制值。默认值为 0644。该路径中的目录不受此设置的影响。这可能会与影响文件模式的其他选项(如 fsGroup )冲突,结果可以是设置其他模式位。

items

数组(KeyToPath)

如果未指定项目,则引用 Secret 的 Data 字段中每个键值对将投射到卷中,名称为键,内容是值。如果指定,列出的键将投射到指定的路径中,且未列出的密钥将不存在。如果指定了在 Secret 中不存在的密钥,则卷设置将错误,除非标记为可选。路径必须是 relative,且不能包含 '..' 路径或以 '..' 开头。

optional

布尔值

可选字段指定是否需要定义 Secret 或其密钥

secretName

字符串

secretName 是要使用的 pod 命名空间中的 secret 名称。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#secret

4.1.121. io.k8s.api.core.v1.SecurityContext schema

描述
securityContext 包含将应用到容器的安全配置。SecurityContext 和 PodSecurityContext 中都存在一些字段。当同时设置这两个时,SecurityContext 中的值就会优先使用。
类型
对象
模式
属性类型描述

allowPrivilegeEscalation

布尔值

allowPrivilegeEscalation 控制进程是否可以获得比父进程更多的特权。此 bool 直接控制容器进程中是否设置了 no_new_privs 标志。当容器以 Privileged 2 运行为 Privileged 2 时,allowPrivilegeEscalation 为 true 时,当 spec.os.name 为窗口时,无法设置此字段。

功能

功能

运行容器时添加/过滤的功能。默认为容器运行时授予的默认功能集。请注意,当 spec.os.name 是窗口时,无法设置此字段。

privileged

布尔值

以特权模式运行容器。特权容器中的进程实质上相当于主机上的 root 用户。默认为false。请注意,当 spec.os.name 是窗口时,无法设置此字段。

procMount

字符串

procMount 表示用于容器的 proc 挂载类型。默认为 DefaultProcMount,它对只读路径和屏蔽的路径使用容器运行时默认值。这需要启用 ProcMountType 功能标记。请注意,当 spec.os.name 是窗口时,无法设置此字段。

可能枚举值: - "Default" 将容器运行时默认值用于 /proc 的 readonly 和 masked 路径。大多数容器运行时屏蔽 /proc 中的某些路径,以避免意外暴露特殊设备或信息。- "Unmasked" 绕过容器运行时的默认屏蔽行为,并确保新创建的 /proc 容器在没有修改的情况下保持不变。

readOnlyRootFilesystem

布尔值

此容器是否具有只读根文件系统。默认值为 false。请注意,当 spec.os.name 是窗口时,无法设置此字段。

runAsGroup

整数

运行容器进程的入口点的 GID。如果未设置,则使用运行时默认值。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。请注意,当 spec.os.name 是窗口时,无法设置此字段。

runAsNonRoot

布尔值

表示容器必须以非 root 用户身份运行。如果为 true,Kubelet 将在运行时验证镜像,以确保它不会以 UID 0 (root)运行,如果容器确实无法启动它,则无法启动它。如果未设置或 false,则不会执行这样的验证。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。

runAsUser

整数

运行容器进程的入口点的 UID。如果未指定,则默认为镜像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。请注意,当 spec.os.name 是窗口时,无法设置此字段。

seLinuxOptions

seLinuxOptions

要应用到容器的 SELinux 上下文。如果未指定,容器运行时将为每个容器分配一个随机 SELinux 上下文。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。请注意,当 spec.os.name 是窗口时,无法设置此字段。

SeccompProfile

SeccompProfile

此容器使用的 seccomp 选项。如果 pod 和容器级别都提供了 seccomp 选项,容器选项将覆盖 pod 选项。请注意,当 spec.os.name 是窗口时,无法设置此字段。

windowsOptions

WindowsSecurityContextOptions

应用到所有容器的 Windows 特定设置。如果未指定,则使用 PodSecurityContext 中的选项。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。请注意,当 spec.os.name 是 linux 时,无法设置此字段。

4.1.122. io.k8s.api.core.v1.SELinuxOptions schema

描述
seLinuxOptions 是要应用到容器的标签
类型
对象
模式
属性类型描述

level

字符串

level 是适用于容器的 SELinux 级别标签。

role

字符串

role 是适用于容器的 SELinux 角色标签。

type

字符串

type 是适用于容器的 SELinux 类型标签。

user

字符串

user 是适用于容器的 SELinux 用户标签。

4.1.123. io.k8s.api.core.v1.ServiceAccountList schema

描述
ServiceAccountList 是 ServiceAccount 对象列表
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ServiceAccount)

ServiceAccounts 列表。更多信息: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.124. io.k8s.api.core.v1.ServiceAccountTokenProjection schema

描述
ServiceAccountTokenProjection 代表投射服务帐户令牌卷。此投射可用于将服务帐户令牌插入到 pod 运行时文件系统中,以用于 API (Kubernetes API 服务器或其他)。
类型
对象
必填
  • path
模式
属性类型描述

受众

字符串

受众是令牌的预期受众。令牌的接收者必须使用令牌使用者中指定的标识符来识别自己,否则应拒绝令牌。使用者默认为 apiserver 的标识符。

expirationSeconds

整数

expirationSeconds 是服务帐户令牌的请求持续时间。随着令牌方法到期,kubelet 卷插件将主动轮转服务帐户令牌。如果令牌存在的时间超过这个值的 80%,或者令牌超过 24 小时,则 kubelet 将开始尝试轮转令牌,且必须至少为 10 分钟。

path

字符串

path 是相对于文件挂载点的路径,以将令牌项目到其中。

4.1.125. io.k8s.api.core.v1.ServiceList schema

描述
ServiceList 包含服务列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Service)

服务列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.126. io.k8s.api.core.v1.StorageOSPersistentVolumeSource schema

描述
代表 StorageOS 持久性卷资源。
类型
对象
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

readOnly

布尔值

只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

ObjectReference

secretRef 指定用于获取 StorageOS API 凭证的 secret。如果没有指定,则会尝试默认值。

volumeName

字符串

volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中是唯一的。

volumeNamespace

字符串

volumeNamespace 指定 StorageOS 中卷的范围。如果没有指定命名空间,则使用 Pod 的命名空间。这允许在 StorageOS 中镜像 Kubernetes 名称范围,以便在更紧密的集成。将 VolumeName 设置为任何名称来覆盖默认的行为。如果没有在 StorageOS 中使用命名空间,则设置为 "default"。将创建在 StorageOS 中没有预先存在的命名空间。

4.1.127. io.k8s.api.core.v1.StorageOSVolumeSource schema

描述
代表 StorageOS 持久性卷资源。
类型
对象
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

readOnly

布尔值

只读默认为 false (读/写)。此处的 readonly 将强制使用 VolumeMount 中的 ReadOnly 设置。

secretRef

LocalObjectReference

secretRef 指定用于获取 StorageOS API 凭证的 secret。如果没有指定,则会尝试默认值。

volumeName

字符串

volumeName 是 StorageOS 卷的人类可读名称。卷名称只在命名空间中是唯一的。

volumeNamespace

字符串

volumeNamespace 指定 StorageOS 中卷的范围。如果没有指定命名空间,则使用 Pod 的命名空间。这允许在 StorageOS 中镜像 Kubernetes 名称范围,以便在更紧密的集成。将 VolumeName 设置为任何名称来覆盖默认的行为。如果没有在 StorageOS 中使用命名空间,则设置为 "default"。将创建在 StorageOS 中没有预先存在的命名空间。

4.1.128. io.k8s.api.core.v1.Sysctl schema

描述
sysctl 定义要设置的内核参数
类型
对象
必填
  • name
  • value
模式
属性类型描述

name

字符串

要设置的属性的名称

value

字符串

要设置的属性值

4.1.129. io.k8s.api.core.v1.TCPSocketAction schema

描述
TCPSocketAction 描述了基于打开套接字的操作
类型
对象
必填
  • port
模式
属性类型描述

主机

字符串

可选:要连接到的主机名,默认为 pod IP。

port

IntOrString

在容器中访问的端口的数量或名称。数字必须在 1 到 65535 之间。名称必须是 IANA_SVC_NAME。

4.1.130. io.k8s.api.core.v1.Toleration schema

描述
附加到此 Toleration 的 pod,以容许任何与 triple <key,value,effect> 匹配的污点,使用匹配的 operator <operator>。
类型
对象
模式
属性类型描述

effect

字符串

effect 表示污点效果要匹配。空意味着匹配所有污点效果。指定后,允许的值为 NoSchedule、PreferNoSchedule 和 NoExecute。

可能枚举值: - "NoExecute" Evict 任何已在运行的 pod,这些 pod 不容许该污点。目前由 NodeController 实施。- "NoSchedule" 不允许新 pod 调度到该节点上,除非它们容许污点,但允许提交给 Kubelet 的所有 pod 而无需启动调度程序,并允许所有已在运行的 pod 继续运行。调度程序强制使用 - "PreferNoSchedule" Like TaintEffectNoSchedule,但调度程序会尝试不将新 pod 调度到节点上,而不是禁止新 pod 完全调度到该节点上。由调度程序实施。

key

字符串

key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空,则运算符必须是 Exists;此组合意味着匹配所有值和所有键。

operator

字符串

Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认为 Equal。exists 等同于 value 的通配符,以便 pod 可以容忍特定类别的所有污点。

可能枚举值: - "Equal" - "Exists"

tolerationSeconds

整数

TolerationSeconds 代表容限的期间(该容限必须是 NoExecute,否则将忽略此字段)容许污点。默认情况下,它没有被设置,这意味着容许永久污点(不驱除)。系统会将零值和负值视为 0 (立即撤离)。

value

字符串

值是容限匹配的污点值。如果运算符是 Exists,则该值应为空,否则只是一个常规字符串。

4.1.131. io.k8s.api.core.v1.TopologySelectorLabelRequirement schema

描述
拓扑选择器要求是与给定标签匹配的选择器。这是一个 alpha 功能,将来可能会改变。
类型
对象
必填
  • key
模式
属性类型描述

key

字符串

选择器应用到的标签键。

数组(字符串)

字符串值数组。一个值必须与要选择的标签匹配。Values 中的每个条目都是 ORed。

4.1.132. io.k8s.api.core.v1.TopologySelectorTerm schema

描述
拓扑选择器术语代表标签查询的结果。null 或空拓扑选择器术语不匹配任何对象。它们的要求是 AND。它提供功能子集作为 NodeSelectorTerm。这是一个 alpha 功能,将来可能会改变。
类型
对象
模式
属性类型描述

matchLabelExpressions

array (TopologySelectorLabelRequirement)

按标签划分的拓扑选择器要求列表。

4.1.133. io.k8s.api.core.v1.TopologySpreadConstraint schema

描述
TopologySpreadConstraint 指定如何在给定的拓扑中分散匹配的 pod。
类型
对象
必填
  • maxSkew
  • topologyKey
  • whenUnsatisfiable
模式
属性类型描述

labelSelector

LabelSelector

labelSelector 用于查找匹配的 pod。与此标签选择器匹配的 Pod 被计算,以确定其对应拓扑域中的 pod 数量。

matchLabelKeys

数组(字符串)

matchLabelKeys 是一组 pod 标签键,用于选择要计算分布的 pod。键用于从传入的 pod 标签中查找值,这些键值标签带有 labelSelector 的 ANDed 来选择要针对传入 pod 计算的现有 pod 组。禁止在 MatchLabelKeys 和 LabelSelector 中存在相同的键。当 LabelSelector 没有设置时,无法设置 matchLabelKeys。传入的 pod 标签中不存在的键将被忽略。null 或 empty 列表表示仅匹配 labelSelector。

这是一个 beta 字段,需要启用 MatchLabelKeysInPodTopologySpread 功能门(默认启用)。

maxSkew

整数

maxSkew 描述了 pod 可能不均匀分布的程度。当 whenUnsatisfiable=DoNotSchedule 时,目标拓扑中匹配 pod 数量和全局最小值之间允许的最大区别。如果有资格的域数量小于 MinDomains,则全局最小值是符合域或零的匹配 pod 的最小数量。例如,在 3 区集群中,MaxSkew 设置为 1,具有相同 labelSelector 的 pod 分布为 2/2/1 : 在这种情况下,全局最小值为 1。| zone1 | zone2 | zone3 | | P P | P P | P | P | P | P | P | - 如果 MaxSkew 为 1,则传入的 pod 只能调度到 zone3,以变为 2/2/2;将其调度到 zone1 (zone2)上的 ActualSkew (3-1)违反 MaxSkew (1)- if MaxSkew.当 whenUnsatisfiable=ScheduleAnyway 时,用来为满足它的拓扑提供更高优先级。它是必填字段。默认值为 1,不允许使用 0。

minDomains

整数

MinDomains 表示最少的合格域数。当匹配拓扑键的合格域数量小于 minDomains 时,Pod Topology Spread 会将"global minimum"视为 0,然后执行 Skew 计算。当匹配拓扑键的合格域数量等于或大于 minDomains 时,这个值对调度没有影响。因此,当有资格的域数量小于 minDomains 时,调度程序不会将这些域的 maxSkew Pod 调度到这些域。如果值为 nil,则约束的行为就像 MinDomains 等于 1。有效值为大于 0 的整数。当值不是 nil 时,WhenUnsatisfiable 必须是 DoNotSchedule。

例如,在 3 区集群中,MaxSkew 设置为 2,MinDomains 被设置为 5,而带有与 2/2/2: | zone1 | zone2 | zone2 | zone2 | zone2 | zone2 | zone3 | zone3 | zone3 | 区域数量小于 5 (MinDomains),因此"global minimum"被视为 0。在这种情况下,无法调度具有相同 labelSelector 的新 pod,因为如果新 Pod 调度到三个区,则 computed skew 将为 3 (3 - 0),它将违反 MaxSkew。

这是一个 beta 字段,需要启用 MinDomainsInPodTopologySpread 功能门(默认启用)。

nodeAffinityPolicy

字符串

NodeAffinityPolicy 表示在计算 pod 拓扑分布偏移时,我们将如何处理 Pod 的 nodeAffinity/nodeSelector。选项为:- Honor:计算中仅包含与 nodeAffinity/nodeSelector 匹配的节点。忽略 Ignore: nodeAffinity/nodeSelector。所有节点包含在计算中。

如果这个值为 nil,则行为等同于 Honor 策略。这是一个 beta 级别的功能,由 NodeInclusionPolicyInPodTopologySpread 功能标记启用。

可能枚举值: - "Honor" 表示在计算 pod 拓扑分布 skew 时使用此调度指令。- "Ignore" 表示在计算 pod 拓扑分布 skew 时忽略此调度指令。

nodeTaintsPolicy

字符串

NodeTaintsPolicy 表示在计算 pod 拓扑分布偏移时,我们将如何处理节点污点。选项为:- Honor: 没有污点的节点,以及传入 pod 具有容限的污点节点被包含。- Ignore: node taint is ignored。包括所有节点。

如果这个值为 nil,则行为等同于 Ignore 策略。这是一个 beta 级别的功能,由 NodeInclusionPolicyInPodTopologySpread 功能标记启用。

可能枚举值: - "Honor" 表示在计算 pod 拓扑分布 skew 时使用此调度指令。- "Ignore" 表示在计算 pod 拓扑分布 skew 时忽略此调度指令。

topologyKey

字符串

topologyKey 是节点标签的密钥。带有具有此键和相同值标签的节点被视为在同一拓扑中。我们将每个 <key, value> 视为"bucket",并尝试在每个存储桶中均衡的 pod 数量。我们将域定义为拓扑的特定实例。另外,我们定义了一个有资格的域,其节点满足 nodeAffinityPolicy 和 nodeTaintsPolicy 的要求。例如,如果 TopologyKey 为 "kubernetes.io/hostname",则每个节点都是该拓扑的域。如果 TopologyKey 是 "topology.kubernetes.io/zone",则每个区都是该拓扑的域。它是必填字段。

whenUnsatisfiable

字符串

whenUnsatisfiable 表示在不满足分散约束的情况下如何处理 pod。- DoNotSchedule (默认)告知调度程序不调度它。- ScheduleAnyway 告知调度程序将 pod 调度到任何位置,但为拓扑赋予更高优先级,有助于减少偏移量。只有在每个可能的节点分配在某些拓扑中违反 "MaxSkew" 时,对传入 pod 的一个约束被视为"Unsatisfiable"。例如,在 3 区集群中,MaxSkew 设置为 1,具有相同 labelSelector 的 pod 分布为 3/1/1: | zone1 | zone3 | zone3 | | P P | P | P | If WhenUnsatisfiable 被设置为 DoNotSchedule,传入的 pod 只能调度到 zone2 (zone3) 要成为 3/2/1 (3/1/2),在 zone2 (zone3)上作为 ActualSkew (2-1)满足 MaxSkew (1)。换句话说,集群仍然可以进行平衡,但调度程序不会使其更不平衡。它是必填字段。

可能枚举值: - "DoNotSchedule" 指示调度程序在不满足约束时不调度 pod。- "ScheduleAnyway" 指示调度程序调度 pod,即使没有满足限制。

4.1.134. io.k8s.api.core.v1.TypedLocalObjectReference schema

描述
TypedLocalObjectReference 包含足够信息,可让您找到同一命名空间中的 typed referenced 对象。
类型
对象
必填
  • kind
  • name
模式
属性类型描述

apiGroup

字符串

apiGroup 是被引用资源的组。如果没有指定 APIGroup,则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型,需要 APIGroup。

kind

字符串

kind 是被引用的资源类型

name

字符串

name 是被引用的资源的名称

4.1.135. io.k8s.api.core.v1.TypedObjectReference schema

描述
类型
对象
必填
  • kind
  • name
模式
属性类型描述

apiGroup

字符串

apiGroup 是被引用资源的组。如果没有指定 APIGroup,则指定的 Kind 必须位于 core API 组中。对于任何其他第三方类型,需要 APIGroup。

kind

字符串

kind 是被引用的资源类型

name

字符串

name 是被引用的资源的名称

namespace

字符串

namespace 是被引用的资源的命名空间。在指定命名空间时,引用命名空间中需要 gateway.networking.k8s.io/ReferenceGrant 对象,以允许该命名空间的所有者接受引用。详情请查看 ReferenceGrant 文档。(alpha)此字段需要启用 CrossNamespaceVolumeDataSource 功能门。

4.1.136. io.k8s.api.core.v1.Volume schema

描述
卷代表一个 pod 中的命名卷,可以被 pod 中的任何容器访问。
类型
对象
必填
  • name
模式
属性类型描述

awsElasticBlockStore

AWSElasticBlockStoreVolumeSource

awsElasticBlockStore 代表附加到 kubelet 主机机器的 AWS Disk 资源,然后公开给 pod。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

azureDisk

AzureDiskVolumeSource

azureDisk 代表主机上的 Azure Data Disk 挂载,并绑定到 pod。

azureFile

AzureFileVolumeSource

azureFile 代表主机上的 Azure File Service 挂载,并绑定到 pod。

cephfs

CephFSVolumeSource

CephFS 代表共享 pod 生命周期的主机上的 Ceph FS 挂载

cinder

CinderVolumeSource

Cinder 代表附加并挂载到 kubelet 主机上的 cinder 卷。更多信息: https://examples.k8s.io/mysql-cinder-pd/README.md

configMap

ConfigMapVolumeSource

ConfigMap 代表一个应该填充此卷的 configMap

csi

CSIVolumeSource

CSI (容器存储接口)代表由某些外部 CSI 驱动程序(Beta 功能)处理的临时存储。

downwardAPI

DownwardAPIVolumeSource

downwardAPI 代表有关应该填充此卷的 pod 的 Downward API

emptyDir

EmptyDirVolumeSource

emptyDir 代表共享 pod 生命周期的临时目录。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

ephemeral

EphemeralVolumeSource

ephemeral 代表由集群存储驱动程序处理的卷。卷的生命周期与定义它的 pod 关联 - 它将在 pod 启动前创建,并在 pod 被删除时删除。

使用这个选项时:只有在 pod 运行、b)常规卷(如从快照或容量跟踪中恢复)时,才需要使用这个卷。c)存储驱动程序通过存储类来指定,而 d)存储驱动程序支持通过 PersistentVolumeClaim 进行动态卷置备(请参阅 EphemeralVolumeSource)。

对于比单个 pod 生命周期更长的卷,使用 PersistentVolumeClaim 或特定于供应商的 API。

如果 CSI 驱动程序旨在以这种方式使用该方法,请使用 CSI 作为轻量级本地临时卷 - 如需更多信息,请参阅驱动程序文档。

pod 可以同时使用两种类型的临时卷和持久性卷。

fc

FCVolumeSource

FC 代表附加到 kubelet 主机的 Fibre Channel 资源,然后公开给 pod。

flexVolume

FlexVolumeSource

FlexVolume 代表一个通用卷资源,它使用基于 exec 的插件置备/附加。

flocker

FlockerVolumeSource

flocker 代表附加到 kubelet 主机机器的 Flocker 卷。这取决于运行 Flocker 控制服务

gcePersistentDisk

GCEPersistentDiskVolumeSource

gcePersistentDisk 代表附加到 kubelet 主机机器的 GCE Disk 资源,然后公开给 pod。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

gitRepo

GitRepoVolumeSource

gitRepo 代表特定修订版本的 git 存储库。DEPRECATED: GitRepo 已被弃用。要使用 git 仓库置备容器,请将 EmptyDir 挂载到使用 git 克隆存储库的 InitContainer 中,然后将 EmptyDir 挂载到 Pod 的容器中。

glusterfs

GlusterfsVolumeSource

GlusterFS 代表共享 pod 生命周期的主机上的 Glusterfs 挂载。更多信息: https://examples.k8s.io/volumes/glusterfs/README.md

hostPath

HostPathVolumeSource

hostpath 代表主机机器上直接公开给容器已存在的文件或目录。这通常用于系统代理或其他允许查看主机机器的特权。大多数容器都不需要此操作。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

iscsi

ISCSIVolumeSource

iSCSI 代表附加到 kubelet 主机机器的 ISCSI 磁盘资源,然后公开给 pod。更多信息: https://examples.k8s.io/volumes/iscsi/README.md

name

字符串

卷的名称。必须是 DNS_LABEL,且在 pod 中唯一。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

nfs

NFSVolumeSource

NFS 代表共享 pod 生命周期的主机上的 NFS 挂载: https://kubernetes.io/docs/concepts/storage/volumes#nfs

persistentVolumeClaim

PersistentVolumeClaimVolumeSource

persistentVolumeClaimVolumeSource 代表对同一命名空间中的 PersistentVolumeClaim 的引用。更多信息: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

photonPersistentDisk

PhotonPersistentDiskVolumeSource

photonPersistentDisk 代表在 kubelets 主机上附加并挂载的 PhotonController 持久磁盘

portworxVolume

PortworxVolumeSource

portworxVolume 代表附加并挂载到 kubelet 主机上的 portworx 卷

projected

ProjectedVolumeSource

在一个资源 secret、configmap 和 Downward API 中所有的项目

quobyte

QuobyteVolumeSource

quobyte 代表共享 pod 生命周期的主机上的 Quobyte 挂载

rbd

RBDVolumeSource

RBD 代表共享 pod 生命周期的主机上的 Rados 块设备挂载。更多信息: https://examples.k8s.io/volumes/rbd/README.md

scaleIO

ScaleIOVolumeSource

scaleIO 代表一个在 Kubernetes 节点上附加并挂载的 ScaleIO 持久性卷。

secret

SecretVolumeSource

secret 代表应填充此卷的 secret。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#secret

storageos

StorageOSVolumeSource

storageos 代表在 Kubernetes 节点上附加并挂载的 StorageOS 卷。

vsphereVolume

VsphereVirtualDiskVolumeSource

vsphereVolume 代表在 kubelets 主机上附加并挂载的 vSphere 卷

4.1.137. io.k8s.api.core.v1.VolumeDevice schema

描述
volumeDevice 描述容器中原始块设备的映射。
类型
对象
必填
  • name
  • devicePath
模式
属性类型描述

devicePath

字符串

DevicePath 是设备要映射到的容器内的路径。

name

字符串

name 必须与 pod 中的 persistentVolumeClaim 的名称匹配

4.1.138. io.k8s.api.core.v1.VolumeMount schema

描述
VolumeMount 描述了在容器中挂载卷。
类型
对象
必填
  • name
  • mountPath
模式
属性类型描述

mountPath

字符串

在容器中挂载卷的路径。不得包含 ':'。

mountPropagation

字符串

mountPropagation 决定如何将挂载从主机传播到容器,以及相关的其他方法。如果没有设置,则使用 MountPropagationNone。此字段是 1.10 中的 beta。

可能枚举值: - "Bidirectional" 表示容器中的卷将从主机或其他容器接收新挂载,并且其自身的挂载将从容器传播到主机或其他容器。请注意,这个模式会递归应用到 Linux 术语中的卷中的所有挂载。- "HostToContainer" 表示容器中的卷将从主机或其他容器中接收新挂载,但挂载到容器中的文件系统不会传播到主机或其他容器。请注意,这个模式会递归应用到卷中的所有挂载("rslave")。- "None" 表示容器中的卷不会从主机或其他容器接收新挂载,以及挂载到容器中的文件系统不会传播到主机或其他容器。请注意,这个模式与 Linux 术语中的"private"对应。

name

字符串

这必须与卷的 Name 匹配。

readOnly

布尔值

如果为 true,则以只读形式挂载(否则为 读写(false 或未指定)。默认为false。

subPath

字符串

应从中挂载容器卷的卷中的路径。默认为 "" (卷的根目录)。

subPathExpr

字符串

应从中挂载容器卷的卷中扩展路径。行为与 SubPath 相似,但环境变量引用 $(VAR_NAME)使用容器的环境进行扩展。默认为 "" (卷的根目录)。SubPathExpr 和 SubPath 是互斥的。

4.1.139. io.k8s.api.core.v1.VolumeNodeAffinity schema

描述
VolumeNodeAffinity 定义限制此卷可从中访问哪些节点。
类型
对象
模式
属性类型描述

required

NodeSelector

必需指定必须满足的硬节点限制。

4.1.140. io.k8s.api.core.v1.VolumeProjection schema

描述
可与其他支持的卷类型一起投射的预测
类型
对象
模式
属性类型描述

configMap

ConfigMapProjection

有关项目的 configMap 数据的 ConfigMap 信息

downwardAPI

DownwardAPIProjection

downwardAPI有关项目的 downwardAPI 数据的信息

secret

SecretProjection

有关项目的 secret 数据的机密信息

serviceAccountToken

ServiceAccountTokenProjection

serviceAccountToken 是项目的 serviceAccountToken 数据的信息

4.1.141. io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource schema

描述
代表 vSphere 卷资源。
类型
对象
必填
  • volumePath
模式
属性类型描述

fsType

字符串

fstype 是要挂载的文件系统类型。必须是主机操作系统支持的文件系统类型。Ex. "ext4", "xfs", "ntfs".如果未指定,则隐式推断为"ext4"。

storagePolicyID

字符串

StoragePolicyID 是与 StoragePolicyName 关联的存储 Policy Based Management (SPBM)配置集 ID。

storagePolicyName

字符串

StoragePolicyName 是存储基于策略的管理(SPBM)配置集名称。

volumePath

字符串

volumePath 是标识 vSphere 卷 vmdk 的路径

4.1.142. io.k8s.api.core.v1.WeightedPodAffinityTerm schema

描述
所有匹配的 WeightedPodAffinityTerm 字段的权重都会被添加,以查找首选节点。
类型
对象
必填
  • weight
  • podAffinityTerm
模式
属性类型描述

podAffinityTerm

PodAffinityTerm

必需。pod 关联性术语,与对应的权重关联。

weight

整数

与对应的 podAffinityTerm 匹配的权重,范围为 1-100。

4.1.143. io.k8s.api.core.v1.WindowsSecurityContextOptions schema

描述
WindowsSecurityContextOptions 包含特定于 Windows 的选项和凭证。
类型
对象
模式
属性类型描述

gmsaCredentialSpec

字符串

GMSACredentialSpec 是 GMSA 准入 Webhook (https://github.com/kubernetes-sigs/windows-gmsa)内联 GMSA 凭证规格的内容,由 GMSACredentialSpecName 字段命名。

gmsaCredentialSpecName

字符串

GMSACredentialSpecName 是要使用的 GMSA 凭证 spec 的名称。

hostProcess

布尔值

HostProcess 确定容器是否应该作为"主机进程"容器运行。此字段是 alpha-level,仅由启用 WindowsHostProcessContainers 功能标记的组件所接受。在没有功能标记的情况下设置此字段将导致验证 Pod 时出现错误。Pod 的容器必须具有相同的有效 HostProcess 值(不允许混合 HostProcess 容器和非主机Process 容器)。另外,如果 HostProcess 为 true,则 HostNetwork 还必须设置为 true。

runAsUserName

字符串

Windows 中的 UserName,以运行容器进程的入口点。如果未指定,则默认为镜像元数据中指定的用户。也可以在 PodSecurityContext 中设置。如果在 SecurityContext 和 PodSecurityContext 中设置,则优先使用 SecurityContext 指定的值。

4.1.144. io.k8s.api.discovery.v1.EndpointSliceList schema

描述
EndpointSliceList 代表端点片段列表
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(EndpointSlice)

items 是端点片段列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。

4.1.145. io.k8s.api.events.v1.EventList schema

描述
EventList 是 Event 对象列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(事件)

items 是 schema 对象列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.146. io.k8s.api.flowcontrol.v1beta3.FlowSchemaList schema

描述
FlowSchemaList 是 FlowSchema 对象列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(FlowSchema)

items 是 FlowSchemas 列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

metadata 是标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.147. io.k8s.api.flowcontrol.v1beta3.PriorityLevelConfigurationList schema

描述
PriorityLevelConfigurationList 是 PriorityLevelConfiguration 对象的列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(PriorityLevelConfiguration)

items 是 request-priorities 的列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

metadata 是标准对象的元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.148. io.k8s.api.networking.v1.IngressClassList schema

描述
IngressClassList 是 IngressClasses 的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(IngressClass)

items 是 IngressClasses 列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。

4.1.149. io.k8s.api.networking.v1.IngressList schema

描述
IngressList 是 Ingress 的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Ingress)

items 是 Ingress 列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.150. io.k8s.api.networking.v1.NetworkPolicyList schema

描述
NetworkPolicyList 是 NetworkPolicy 对象列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(NetworkPolicy)

items 是 schema 对象列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.151. io.k8s.api.node.v1.RuntimeClassList schema

描述
RuntimeClassList 是 RuntimeClass 对象列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(RuntimeClass)

items 是 schema 对象列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.152. io.k8s.api.policy.v1.PodDisruptionBudgetList schema

描述
PodDisruptionBudgetList 是 PodDisruptionBudgets 的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(PodDisruptionBudget)

items 是 PodDisruptionBudgets 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.153. io.k8s.api.rbac.v1.ClusterRoleBindingList schema

描述
ClusterRoleBindingList 是 ClusterRoleBindings 的集合
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ClusterRoleBinding)

items 是 ClusterRoleBindings 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准对象元数据。

4.1.154. io.k8s.api.rbac.v1.ClusterRoleList schema

描述
ClusterRoleList 是 ClusterRole 的集合
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(ClusterRole)

items 是 ClusterRole 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准对象元数据。

4.1.155. io.k8s.api.rbac.v1.RoleBindingList schema

描述
RoleBindingList 是 RoleBindings 的集合
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(RoleBinding)

items 是 RoleBindings 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准对象元数据。

4.1.156. io.k8s.api.rbac.v1.RoleList schema

描述
RoleList 是角色的集合
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(Role)

items 是角色列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准对象元数据。

4.1.157. io.k8s.api.scheduling.v1.PriorityClassList schema

描述
PriorityClassList 是优先级类的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(PriorityClass)

items 是 PriorityClasses 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据更多信息 :https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.158. io.k8s.api.storage.v1.CSIDriverList schema

描述
CSIDriverList 是 CSIDriver 对象的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(CSIDriver)

items 是 CSIDriver 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据更多信息 :https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.159. io.k8s.api.storage.v1.CSINodeList schema

描述
CSINodeList 是 CSINode 对象的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(CSINode)

items 是 CSINode 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据更多信息 :https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.160. io.k8s.api.storage.v1.CSIStorageCapacityList schema

描述
CSIStorageCapacityList 是 CSIStorageCapacity 对象的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(CSIStorageCapacity)

items 是 CSIStorageCapacity 对象列表。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据更多信息 :https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.161. io.k8s.api.storage.v1.StorageClassList schema

描述
StorageClassList 是存储类的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(StorageClass)

items 是 StorageClasses 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据更多信息 :https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.162. io.k8s.api.storage.v1.VolumeAttachmentList schema

描述
VolumeAttachmentList 是 VolumeAttachment 对象的集合。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(VolumeAttachment)

items 是 VolumeAttachments 列表

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据更多信息 :https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.163. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList schema

描述
CustomResourceDefinitionList 是 CustomResourceDefinition 对象列表。
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

数组(CustomResourceDefinition)

items 列出单个 CustomResourceDefinition 对象

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准对象的元数据更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.164. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation schema

描述
外部文档允许引用外部资源以获取扩展文档。
类型
对象
模式
属性类型描述

description

字符串

 

url

字符串

 

4.1.165. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSON schema

描述
JSON 代表任何有效的 JSON 值。支持这些类型: bool, int64, float64, string, []interface{}, map[string]interface{} 和 nil。
类型
``

4.1.166. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps schema

描述
JSONSchemaProps 是符合规范 4 的 JSON 架构(http://json-schema.org/)。
类型
对象
模式
属性类型描述

$ref

字符串

 

$schema

字符串

 

additionalItems

JSONSchemaPropsOrBool

 

additionalProperties

JSONSchemaPropsOrBool

 

allOf

数组(未定义)

 

anyOf

数组(未定义)

 

default

JSON

Default 是未定义对象字段的默认值。默认是 CustomResourceDefaulting 功能门下的 beta 功能。默认要求 spec.preserveUnknownFields 为 false。

定义

对象(未定义)

 

dependencies

对象(未定义)

 

description

字符串

 

Enum

数组(JSON)

 

示例

JSON

 

exclusiveMaximum

布尔值

 

exclusiveMinimum

布尔值

 

externalDocs

外部文档

 

格式

字符串

格式是 OpenAPI v3 格式字符串。未知格式将被忽略。验证以下格式:

- bsonobjectid: 一个 bson 对象 ID,即 24 个字符十六进制字符串 - uri: 一个 URI 作为 Golang net/url.ParseRequestURI 解析的 - email: 一个电子邮件地址,由 Golang net/mail.ParseAddress - hostname: 一个 Internet 主机名的有效表示,如 RFC 1034, section 3.1 [RFC1034] 所定义。 - ipv4: 一个 IPv4 IP 由 Golang net.ParseIP - ipv6: ipv6: 一个 IPv6 IP 解析,由 Golang net.ParseIP - cidr: 一个 CIDR 作为 Golang net.ParseCIDR - mac: MAC 地址解析,如 Golang net.ParseMAC - uuid: 一个 UUID,允许由 regex (?i)^[0-9a-f]{8}-?[8\}-?[a]{8\}- - uuid3: 一个 UUID3,它允许由 regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: 一个 UUID4,它允许由 regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: 一个 UUID5,它允许由 regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: 一个 ISBN10 或 ISBN13 number 字符串,如 "0321751043" 或 "978-0321751041" - isbn10: a ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string,如 "978-0321751041" - creditcard: 一个信用卡号,由 regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6 (?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3 (?[0-5]|[8-5]|[1][1][10-9]} 如果有任何非数字字符混合在 - ssn 中:一个 U.S. social security number after the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: 一个十六进制颜色代码,如 "FFFFFF: following regex ^? ([0-9a-fA-F]{3}[-F]{3}[-F]\{3\$ - rgbcolor: 一个 RGB 颜色代码,如 rgb,如 "rgb (255, 255,2559" - byte: base64 编码的二进制数据 - password: any kind of string - date - date string like "2006-01-02" like "2006-01-02" defined by RFC3339 - duration: 一个持续时间字符串,如 Golang time.ParseDuration 或与 Scala 持续时间格式兼容,如 "2014-12-15T19:30:20.000:30:20.000"

id

字符串

 

items

JSONSchemaPropsOrArray

 

maxItems

整数

 

maxLength

整数

 

maxProperties

整数

 

最大

number

 

minItems

整数

 

minLength

整数

 

minProperties

整数

 

最小值

number

 

multipleOf

number

 

not

JSONSchemaProps

 

nullable

布尔值

 

oneOf

数组(未定义)

 

pattern

字符串

 

patternProperties

对象(未定义)

 

属性

对象(未定义)

 

required

数组(字符串)

 

title

字符串

 

type

字符串

 

uniqueItems

布尔值

 

x-kubernetes-embedded-resource

布尔值

x-kubernetes-embedded-resource 定义值是嵌入式 Kubernetes runtime.Object,带有 TypeMeta 和 ObjectMeta。类型必须是 object。允许进一步限制嵌入式对象。apiVersion 和 metadata 会自动验证。x-kubernetes-preserve-unknown-fields 为 true,但如果对象被完全指定(默认为 apiVersion, metadata)不需要被验证。

x-kubernetes-int-or-string

布尔值

x-kubernetes-int-or-string 指定这个值是一个整数或字符串。如果为 true,则允许一个空类型,如果遵循以下模式之一,则允许作为 anyOf 的子类型:

1)anyOf: - type: integer - type: string 2)allOf: - anyOf: - type: integer - type: string - …​ zero or more

x-kubernetes-list-map-keys

数组(字符串)

x-kubernetes-list-map-keys 通过指定用作 映射 索引的键来注解带有 x-kubernetes-list-type 映射的数组。

此标签仅应用于将 "x-kubernetes-list-type" 扩展设置为 "map" 的列表。另外,为此属性指定的值必须是子结构的 scalar 类型字段(不支持嵌套)。

指定的属性必须是 required 或具有默认值,以确保所有列表项都存在这些属性。

x-kubernetes-list-type

字符串

x-kubernetes-list-type 注解一个数组来进一步描述其拓扑。这个扩展必须只用于列表,且可能有 3 个可能的值:

1)Atomic : 列表被视为单一实体,如 scalar。更新时,原子列表将完全被替换。此扩展可用于任何类型的列表(struct, scalar, …​)。2) set: Sets 是不能具有相同值的多个项目的列表。每个值都必须是一个 scalar,一个具有 x-kubernetes-map-type atomic 的对象或带有 x-kubernetes-list-type atomic 的数组。3) 映射 :这些列表类似于映射,其元素具有用于识别它们的非索引键。订购会在合并时保留。map 标签必须仅用于带有 type 对象的元素的列表。对于数组,默认为 atomic。

x-kubernetes-map-type

字符串

x-kubernetes-map-type 注解一个对象来进一步描述其拓扑。只有在类型为 object 且可能具有 2 个可能的值时,才使用此扩展:

1) 精细的 :这些映射是实际映射(键值对),每个字段都相互独立(它们可以相互独立操作)。这是所有映射的默认行为。2)Atomic : 列表被视为单个实体,如 scalar。更新时,原子映射将完全被替换。

x-kubernetes-preserve-unknown-fields

布尔值

x-kubernetes-preserve-unknown-fields 会停止 API 服务器解码步骤,从修剪没有在验证 schema 中指定的字段。这会以递归方式影响字段,但如果在 schema 中指定嵌套属性或附加属性,则切换回正常的修剪行为。这可以是 true 或 undefined。false 被禁止。

x-kubernetes-validations

数组(ValidationRule)

x-kubernetes-validations 描述使用 CEL 表达式语言编写的验证规则列表。此字段是一个 alpha-level。使用此字段需要启用功能门 CustomResourceValidationExpressions

4.1.167. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrArray schema

描述
JSONSchemaPropsOrArray 代表一个值,可以是 JSONSchemaProps 或 JSONSchemaProps 数组。这里主要用于序列化目的。
类型
``

4.1.168. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrBool schema

描述
JSONSchemaPropsOrBool 代表 JSONSchemaProps 或布尔值。对于布尔值属性,默认为 true。
类型
``

4.1.169. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrStringArray schema

描述
JSONSchemaPropsOrStringArray 代表 JSONSchemaProps 或字符串数组。
类型
``

4.1.170. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ValidationRule schema

描述
ValidationRule 描述了使用 CEL 表达式语言编写的验证规则。
类型
对象
必填
  • 规则
模式
属性类型描述

message

字符串

Message 代表验证失败时显示的消息。如果 Rule 包含换行符,则需要消息。消息不得包含换行符。如果未设置,则消息为 "failed rule: {Rule}"。例如"必须是一个带有主机匹配 spec.host" 的 URL。

messageExpression

字符串

MessageExpression 声明了一个 CEL 表达式,用于评估此规则失败时返回的验证失败消息。由于 messageExpression 被用作失败消息,因此它必须评估为字符串。如果规则中存在 message 和 messageExpression,则在验证失败时将使用 messageExpression。如果 messageExpression 产生运行时错误,则会记录运行时错误,并且生成验证失败消息,就像 messageExpression 字段未设置一样。如果 messageExpression 评估为一个空字符串、仅包含空格的字符串或包含换行符的字符串,则验证失败消息也会生成,就像 messageExpression 字段未设置一样,而 messageExpression 的事实会生成空字符串/字符串,且带有换行符的字符串才会被记录。messageExpression 可以访问所有与规则相同的变量;唯一的区别是返回类型。示例:"x 必须小于 max ("string (self.max) ") "

规则

字符串

规则代表 CEL 将评估的表达式。ref: https://github.com/google/cel-spec 规则的范围仅限于架构中 x-kubernetes-validations 扩展的位置。CEL 表达式中的 self 变量绑定到范围值。示例: - 规则范围到具有状态子资源的资源根: {"rule": "self.status.actual categories self.spec.maxDesired"}

如果 Rule 限定有属性的对象,则可通过 self.field 和 field presence ( self.field ) 检查对象的可访问属性。null valued 字段被视为 CEL 表达式中的 absent 字段。如果 Rule 的范围仅限于带有额外属性(如映射)的对象,则映射的值可以通过 self[mapKey] 访问,则可以通过 map containment 在 self 中通过 mapKey 进行检查,并且映射的所有条目都可通过 CEL 宏和函数(如 self.all (…​) )访问。如果 Rule 限定在一个数组中,则数组的元素可以通过 self[i] 访问,也可由宏和函数访问。如果 Rule 限定于一个 scalar,则 self 绑定到 scalar 值。示例:- Rule 范围到对象映射: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a integers: {"rule": "self.values.all (value, value >= 0 && value < 100) "} - Rule scoped to a string value: {"rule": "self.startsWith ('kube') "}

apiVersion,kind,metadata.namemetadata.generateName 始终可从对象的根目录和任何 x-kubernetes-embedded-resource 注解的对象访问。没有可以访问其他元数据属性。

CEL 表达式中无法通过 x-kubernetes-preserve-unknown-fields 在自定义资源中保留未知数据。这包括 - Unknown 字段值,由带有 x-kubernetes-preserve-unknown-fields. - 对象属性 schema 为 "unknown type" 的对象模式保留。"未知类型"被递归定义为: - 无类型和 x-kubernetes-preserve-unknown-fields 的模式设置为 true - items 模式是"未知类型"的数组 - additionalProperties 模式是"unknown type"的对象

仅可以访问 [a-zA-Z_.-/][a-zA-Z0-9_.-/]* 的属性名称。在表达式中访问时可访问的属性名称会被转义: - '' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property name is exactly match a CEL RESERVEDVED_{_key} - '/' escapes to '__underscores__' - '.' escapes to '__dot___关键字为:"true", "false", "null", "in", "in", "as", "break", "const", "continue", "else", "for", "if", "import", "let", "loop", "package", "namespace", "namespace", "return"。示例: - 访问名为 "namespace": {"rule": self.__namespace__ 0} 的属性 - 规则访问名为 "x-prop": {"rule": self.x__dash__prop 0} 的属性 - 规则访问名为 "redactd": {"rule": self.redact_underscores__d 0}

在带有 x-kubernetes-list-type 为 'set' 或 'map' ignores 元素顺序的数组中相等,例如 [1, 2] == [2, 1]。带有 x-kubernetes-list-type 的数组上的串联使用列表类型的语义: - 'set': X + Y 会执行一个组合,其中 X 中所有元素的数组位置会被保留,而 Y 中的非中间元素被附加,保留其部分顺序。- 'map': X + Y 执行一个合并,其中 X 中所有键的数组位置都会被保留,当 XY intersect 键集合时,值会被 Y 中的值覆盖。带有非中断密钥的 Y 中的元素会被附加,保留其部分顺序。

4.1.171. io.k8s.apimachinery.pkg.api.resource.Quantity schema

描述

quantity 是数字的固定点表示。除了 String ()和 AsInt64 ()访问器外,它还在 JSON 和 YAML 中提供方便的 marshaling/unmarshaling。

序列化格式为:

<quantity> ::= <signedNumber><suffix>

(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>

无论使用了三种经验,任何数量都不能代表大于 2^63-1 的数字,或者可能有超过 3 个十进制位置。更大或更精确的数字将被上限或舍入。(例如: 0.1m 将向上舍入为 1m.) 如果我们需要更大或较小的数量,则这可能会在以后进行扩展。

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

在序列化之前,数量将置于"规范形式"。这意味着,Exponent/suffix 将调整或缩减(在 Mantissa 中相应的增加或减少),以便:

  • Norecision is lost - 不会发出分数数 - exponent (或后缀)会尽可能大。

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

示例:

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

请注意,数量将在内部表示,由浮点数表示。这是整个练习。

非规范值仍会解析,只要它们被编写,但会以规范形式重新提供。(因此始终使用规范形式,或者不 diff。)

这个格式的目的是在不编写一些特殊处理代码的情况下,很难使用这些数字,而希望这样会使实施器也使用固定点实现。

类型
字符串

4.1.172. io.k8s.apimachinery.pkg.apis.meta.v1.Condition schema

描述
condition 包含此 API 资源当前状态的一个方面的详情。
类型
对象
必填
  • type
  • status
  • lastTransitionTime
  • reason
  • message
模式
属性类型描述

lastTransitionTime

时间

lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知,则使用 API 字段更改的时间是可以接受的。

message

字符串

Message 是人类可读的消息,指示有关转换的详细信息。这可以是空字符串。

observedGeneration

整数

observedGeneration 代表 .metadata.generation,这是条件设置所基于的条件。例如,如果 .metadata.generation 目前为 12,但 .status.conditions[x].observedGeneration 是 9,则代表条件与实例的当前状态已不匹配。

reason

字符串

reason 包含程序标识符,指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义,以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段不能为空。

status

字符串

条件的状态,True, False, Unknown 之一。

type

字符串

CamelCase 或 foo.example.com/CamelCase 中的条件类型。

4.1.173. io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions schema

描述
删除 API 对象时,可以提供 DeleteOptions。
类型
对象
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

dryRun

数组(字符串)

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值为 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

orphanDependents

布尔值

deprecated :请使用 PropagationPolicy,此字段将在 1.7 中弃用。依赖的对象应该被孤立。如果为 true/false,则"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置这两个字段。

preconditions

preconditions

在执行删除前必须完成。如果不可能,则返回 409 Conflict 状态。

propagationPolicy

字符串

是否以及如何执行垃圾回收。可以设置此字段或 OrphanDependents,但不能同时设置这两个字段。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受值为:'Orphan' - 孤立依赖项; 'Background' - 允许垃圾收集器删除后台依赖的依赖项;'Foreground' - 一个级联策略,会删除前台所有依赖的级联策略。

4.1.174. io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1 schema

描述

FieldsV1 以 JSON 格式在诸如 Trie 的数据结构中存储一组字段。

每个键可以是代表字段本身的 '.',始终映射到一个空集,也可以是代表子字段或项的字符串。字符串将遵循以下四种格式之一:'f:<name>',其中 <name> 是 struct 中的字段名称,或映射 'v:<value>' 中的键,其中 <value> 是列表项 'i:<index>' 的确切 json 格式值,其中 <index> 是列表 'k:<keys>' 中的项位置,其中 <value> 是列表项 'i:<index>' 的确切 json 格式值。 其中 <keys> 是列表项的键字段到其唯一值的映射,如果键映射到空字段值,则键代表的字段是集合的一部分。

确切的格式在 iwl.k8s.io/structured-merge-diff 中定义

类型
对象

4.1.175. io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector schema

描述
标签选择器,即一组资源的标签查询。matchLabels 和 matchExpressions 的逻辑关系是 AND。空标签选择器匹配所有对象。null 标签选择器不匹配任何对象。
类型
对象
模式
属性类型描述

matchExpressions

数组(LabelSelectorRequirement)

matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。

matchLabels

对象(字符串)

matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素,其 key 字段是 "key",运算符是 "In",值数组仅包含 "value"。要求的逻辑关系是 AND。

4.1.176. io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement schema

描述
标签选择器要求是一个选择器,其中包含值、键和与键和值关联的操作器。
类型
对象
必填
  • key
  • operator
模式
属性类型描述

key

字符串

key 是选择器应用到的标签键。

operator

字符串

运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。

数组(字符串)

值是字符串值的数组。如果运算符是 In 或 NotIn,则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist,则值数组必须为空。这个数组会在策略性合并补丁中被替换。

4.1.177. io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta schema

描述
ListMeta 描述了复合资源必须具有的元数据,包括列表和各种状态对象。资源可能只有一个 {ObjectMeta, ListMeta} 之一。
类型
对象
模式
属性类型描述

继续

字符串

如果用户对返回的项目数量设置了限制,则可以设置继续,并且表示服务器有更多可用的数据。该值不透明,可用于向提供此列表的端点发出另一个请求,以检索下一个可用对象集合。如果服务器配置已更改或几分钟以上,则无法继续一致的列表。使用此 continue 值时返回的 resourceVersion 字段将与第一个响应中的值相同,除非您从错误消息收到此令牌。

remainingItemCount

整数

remainingItemCount 是列表中未包含在此列表响应中的后续项目数量。如果列表请求包含标签或字段选择器,则其余项目的数量为未知,且该字段将保留为未设置,并在序列化过程中省略。如果列表完成(因为不是块或因为这是最后一个块),则没有更多剩余项,且此字段将被取消设置,并在序列化过程中省略并省略。早于 v1.15 的服务器不会设置此字段。remainingItemCount 的预期 使用估计 集合的大小。客户端不应依赖 remainingItemCount 设置或准确。

resourceVersion

字符串

标识此对象的内部版本的字符串,供客户端用来确定对象何时更改。值必须被客户端视为不透明,并将未修改传递回服务器。由系统填充。只读。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

字符串

deprecated: selfLink 是一个旧的只读字段,它不再由系统填充。

4.1.178. io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry schema

描述
ManagedFieldsEntry 是一个 workflow-id、FieldSet 和 fieldset 应用到的资源的组版本。
类型
对象
模式
属性类型描述

apiVersion

字符串

apiVersion 定义此字段应用到的此资源版本。类似于顶级 APIVersion 字段的格式为 "group/version"。需要跟踪字段集的版本,因为它无法自动转换。

fieldsType

字符串

FieldsType 是不同字段格式和版本的差异。当前只有一个可能的值:"FieldsV1"

fieldsV1

FieldsV1

FieldsV1 包含第一个 JSON 版本格式,如 "FieldsV1" 类型中所述。

Manager

字符串

Manager 是管理这些字段的工作流的标识符。

operation

字符串

操作是导致创建此 ManagedFieldsEntry 的操作类型。此字段的唯一有效值为 'Apply' 和 'Update'。

子资源

字符串

subresource 是用来更新该对象的子资源的名称,如果对象通过主资源更新,则为空字符串。此字段的值用于区分管理器,即使它们共享相同的名称。例如,状态更新将与使用相同的管理器名称的常规更新不同。请注意,APIVersion 字段与 Subresource 字段无关,它始终与主资源的版本对应。

time

时间

Time 是添加 ManagedFields 条目的时间戳。添加了字段时也会更新时间戳,管理器会更改任何拥有的字段值或删除字段。当从条目中删除字段时,时间戳不会更新,因为另一个管理器接管了它。

4.1.179. io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime schema

描述
MicroTime 是微秒级精度的时间版本。
类型
字符串

4.1.180. io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta schema

描述
ObjectMeta 是所有持久的资源必须具有的元数据,其中包括用户必须创建的所有对象。
类型
对象
模式
属性类型描述

annotations

对象(字符串)

annotations 是一个无结构的键值映射,它存储了一个资源,可通过外部工具设置它来存储和检索任意元数据。它们不可查询,在修改对象时应保留。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

creationTimestamp

时间

creationTimestamp 是一个时间戳,代表创建此对象时的服务器时间。无法保证在单独的操作之间按顺序设置。客户端可能不会设置这个值。它以 RFC3339 格式表示,并以 UTC 为单位。

由系统填充。只读。null 表示列表。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds

整数

在将这个对象从系统中删除前,允许此对象安全终止的秒数。仅在同时设置 deletionTimestamp 时设置。只能缩短。只读。

deletionTimestamp

时间

deletionTimestamp 是 RFC 3339 日期和时间,将删除此资源。当用户请求安全删除时,服务器会设置此字段,且客户端不会直接设置。当 finalizers 列表为空后,资源应该会被删除(不再在资源列表中可见且名称无法从名称访问)。只要终结器列表包含项目,删除就被阻止。设置 deletionTimestamp 后,这个值可能不会取消设置,或者在以后在以后设置,但它可能会被缩短,或者资源可在此时间删除。例如,用户可以请求在 30 秒内删除 pod。Kubelet 将通过向 pod 中的容器发送安全终止信号来响应。30 秒后,Kubelet 将向容器发送一个硬终止信号(SIGKILL),并在清理后从 API 中删除 pod。在存在网络分区时,此对象可能仍然存在于此时间戳后,直到管理员或自动进程可以确定资源完全被终止为止。如果没有设置,则不请求删除对象。

当请求安全删除时,系统填充。只读。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers

数组(字符串)

必须在从 registry 中删除对象前为空。每个条目都是负责的组件的标识符,该组件将从列表中删除该条目。如果对象的 deletionTimestamp 不是非nil,则此列表中的条目只能被删除。结束程序可能会以任何顺序处理和删除。顺序不会被强制,因为它引入了卡住终结器的风险。finalizers 是一个共享字段,任何具有权限的操作都可能会重新排序它。如果按顺序处理了终结器列表,则这可能会导致在列表后面负责第一个终结器(字段值、外部系统或其他)生成的信号(字段值、外部系统或其他)导致问题。如果没有强制排序终结器,可以自由地订购自己,且不会受到列表中排序更改的影响。

generateName

字符串

generateName 是一个可选前缀,供服务器用来生成唯一的名称仅 IF,没有提供 Name 字段。如果使用此字段,返回到客户端的名称将与传递的名称不同。这个值也会与唯一的后缀合并。提供的值具有与 Name 字段相同的验证规则,可通过在服务器中使值唯一的后缀长度截断。

如果指定了此字段且生成的名称存在,服务器将返回 409。

仅在未指定 Name 时才应用。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation

整数

代表所需状态的特定生成状态的序列号。由系统填充。只读。

labels

对象(字符串)

字符串键和值映射,可用于组织和分类(范围并选择)对象。可以与复制控制器和服务的选择器匹配。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

managedFields

数组(ManagedFieldsEntry)

managedFields 将 workflow-id 和 version 映射到由该工作流管理的字段集合。这主要用于内部内务,用户通常不需要设置或了解此字段。工作流可以是用户名、控制器的名称,也可以是特定应用路径的名称,如 "ci-cd"。字段集始终位于修改对象时使用的工作流的版本。

name

字符串

名称在命名空间内必须是唯一的。在创建资源时,需要一些资源,但有些资源可能允许客户端自动请求生成适当名称。名称主要用于创建 idempotence 和 配置定义。无法更新。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

namespace

字符串

namespace 定义每个名称必须唯一的空间。空命名空间等同于 "default" 命名空间,但 "default" 是规范表示。并非所有对象都需要限定到命名空间 - 这些对象的此字段的值将为空。

必须是 DNS_LABEL。无法更新。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

ownerReferences

数组(OwnerReference)

依赖于此对象的对象列表。如果删除了列表中的所有对象,则此对象将被垃圾回收。如果此对象由控制器管理,则此列表中的条目将指向此控制器,controller 被设置为 true。不能有多个管理控制器。

resourceVersion

字符串

代表此对象的内部版本的 opaque 值,供客户端用来确定对象何时更改。可用来对资源或一组资源进行最佳并发、更改检测和监视操作。客户端必须将这些值视为不透明,并将未修改的回服务器传递。它们可能仅对特定资源或一组资源有效。

由系统填充。只读。值必须被客户端 和 被视为不透明。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

字符串

deprecated: selfLink 是一个旧的只读字段,它不再由系统填充。

uid

字符串

UID 是此对象的时间和空间值的唯一值。它通常由服务器成功创建资源时生成,不允许更改 PUT 操作。

由系统填充。只读。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

4.1.181. io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference schema

描述
OwnerReference 包含足够信息,供您识别自己的对象。您自己的对象必须与依赖或集群范围位于同一个命名空间中,因此没有 namespace 字段。
类型
对象
必填
  • apiVersion
  • kind
  • name
  • uid
模式
属性类型描述

apiVersion

字符串

引用的 API 版本。

blockOwnerDeletion

布尔值

如果为 true,如果所有者具有 "foregroundDeletion" finalizer,则无法从 key-value 存储中删除所有者,直到此引用被删除为止。有关垃圾收集器如何与此字段交互并强制实施前台删除,请参阅 https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion。默认为false。要设置此字段,用户需要"删除"所有者权限,否则将返回 422 (Unprocessable Entity)。

controller

布尔值

如果为 true,则此引用指向管理控制器。

kind

字符串

引用的类型。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

uid

字符串

引用的 UID。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

4.1.182. io.k8s.apimachinery.pkg.apis.meta.v1.Patch schema

描述
提供了补丁来为 Kubernetes PATCH 请求正文提供具体的名称和类型。
类型
对象

4.1.183. io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions schema

描述
在执行操作(更新、删除等)之前,必须满足 preconditions。
类型
对象
模式
属性类型描述

resourceVersion

字符串

指定目标 ResourceVersion

uid

字符串

指定目标 UID。

4.1.184. io.k8s.apimachinery.pkg.apis.meta.v1.Status schema

描述
status 是不返回其他对象的调用的返回值。
类型
对象
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

code

整数

此状态的建议 HTTP 返回码 0 (如果未设置)。

详情

StatusDetails

扩展与原因相关的数据。每个原因都可以定义自己的扩展详情。此字段是可选的,且返回的数据无法保证符合任何模式,除非 reason 类型定义。

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

message

字符串

此操作状态的人类可读描述。

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

reason

字符串

此操作处于"Failure"状态的机器可读描述。如果这个值为空,则没有可用的信息。Reason 阐明 HTTP 状态代码,但不会覆盖它。

status

字符串

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

4.1.185. io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause schema

描述
类型
对象
模式
属性类型描述

field

字符串

可选。

message

字符串

reason

字符串

4.1.186. io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails schema

描述
类型
对象
模式
属性类型描述

group

字符串

kind

字符串

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name

字符串

retryAfterSeconds

整数

uid

字符串

4.1.187. io.k8s.apimachinery.pkg.apis.meta.v1.Time schema

描述
类型
字符串

4.1.188. io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent schema

描述
类型
对象
必填
  • type
  • 对象
模式
属性类型描述

对象

RawExtension

type

字符串

 

4.1.189. io.k8s.apimachinery.pkg.runtime.RawExtension schema

描述

type MyAPIObject struct {
	runtime.TypeMeta `json:",inline"`
	MyPlugin runtime.Object `json:"myPlugin"`
}
type PluginA struct {
	AOption string `json:"aOption"`
}
type MyAPIObject struct {
	runtime.TypeMeta `json:",inline"`
	MyPlugin runtime.RawExtension `json:"myPlugin"`
}
type PluginA struct {
	AOption string `json:"aOption"`
}
{
	"kind":"MyAPIObject",
	"apiVersion":"v1",
	"myPlugin": {
		"kind":"PluginA",
		"aOption":"foo",
	},
}

类型
对象

4.1.190. io.k8s.apimachinery.pkg.util.intstr.IntOrString schema

描述
类型
字符串

4.1.191. io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

4.1.192. io.k8s.migration.v1alpha1.StorageVersionMigrationList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

array (StorageVersionMigration)

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.193. io.k8s.storage.snapshot.v1.VolumeSnapshotClassList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.194. io.k8s.storage.snapshot.v1.VolumeSnapshotContentList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

array (VolumeSnapshotContent)

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.195. io.k8s.storage.snapshot.v1.VolumeSnapshotList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.196. io.openshift.internal.security.v1.RangeAllocationList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.197. io.openshift.route.v1.RouteList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.198. io.openshift.security.v1.SecurityContextConstraintsList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

4.1.199. io.topolvm.v1.LogicalVolumeList schema

描述
类型
对象
必填
  • items
模式
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

items

更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

元数据

ListMeta

标准列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.