8.13. Infrastructure [config.openshift.io/v1]


描述
基础架构包含有关基础架构的集群范围信息。规范名称是 集群兼容性级别 1:在主发行版本中至少有 12 个月或 3 个次版本(以更长的时间为准)。
类型
对象
必填
  • spec

8.13.1. 规格

Expand
属性类型描述

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

metadata

ObjectMeta_v2

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

spec

对象

spec 包含用户配置可设置值

status

对象

status 包含从集群中观察到的值。它们可能无法覆盖。

8.13.1.1. .spec

描述
spec 包含用户配置可设置值
类型
对象
Expand
属性类型描述

cloudConfig

对象

cloudconfig 是对包含云供应商配置文件的 ConfigMap 的引用。此配置文件用于在使用内置云供应商集成或外部云控制器管理器时配置 Kubernetes 云供应商集成。此配置映射的命名空间是 openshift-config. cloudConfig 应该只由 kube_cloud_config 控制器使用。控制器负责为各种平台使用 spec 中的用户配置,并将其与此字段中提供的 ConfigMap 合并,以创建停止的 kube 云配置。控制器在 openshift-config-managed 命名空间中生成一个 ConfigMap kube-cloud-config,并将 kube 云配置存储在 cloud.conf 密钥中。所有客户端都应该只使用生成的 ConfigMap。

platformSpec

对象

platformSpec 包含特定于底层基础架构供应商所需的信息。

8.13.1.2. .spec.cloudConfig

描述
cloudconfig 是对包含云供应商配置文件的 ConfigMap 的引用。此配置文件用于在使用内置云供应商集成或外部云控制器管理器时配置 Kubernetes 云供应商集成。此配置映射的命名空间是 openshift-config. cloudConfig 应该只由 kube_cloud_config 控制器使用。控制器负责为各种平台使用 spec 中的用户配置,并将其与此字段中提供的 ConfigMap 合并,以创建停止的 kube 云配置。控制器在 openshift-config-managed 命名空间中生成一个 ConfigMap kube-cloud-config,并将 kube 云配置存储在 cloud.conf 密钥中。所有客户端都应该只使用生成的 ConfigMap。
类型
对象
Expand
属性类型描述

key

字符串

键允许指向 configmap 中的特定键/值。这对于逻辑文件引用非常有用。

name

字符串

 

8.13.1.3. .spec.platformSpec

描述
platformSpec 包含特定于底层基础架构供应商所需的信息。
类型
对象
Expand
属性类型描述

alibabaCloud

对象

alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。

aws

对象

AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。

azure

对象

Azure 包含特定于 Azure 基础架构供应商的设置。

baremetal

对象

baremetal 包含特定于 BareMetal 平台的设置。

equinixMetal

对象

equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。

gcp

对象

GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。

ibmcloud

对象

ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。

kubevirt

对象

kubevirt 包含特定于 kubevirt 基础架构供应商的设置。

openstack

对象

OpenStack 包含特定于 OpenStack 基础架构供应商的设置。

ovirt

对象

oVirt 包含特定于 oVirt 基础架构供应商的设置。

powervs

对象

powervs 包含特定于 IBM Power 系统虚拟服务器基础架构供应商的设置。

type

字符串

type 是集群的底层基础架构供应商。这个值控制基础架构自动化,如服务负载均衡器、动态卷置备、机器创建和删除和其他集成。如果 None,则不会启用基础架构自动化。允许的值有 "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", "PowerVS", "AlibabaCloud" 和 "None"。独立组件可能不支持所有平台,如果不支持该平台,则必须将未识别的平台处理为 None。

vsphere

对象

vSphere 包含特定于 VSphere 基础架构供应商的设置。

8.13.1.4. .spec.platformSpec.alibabaCloud

描述
alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。
类型
对象

8.13.1.5. .spec.platformSpec.aws

描述
AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

serviceEndpoints

array

serviceEndpoints 列表包含自定义端点,该端点将覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。

serviceEndpoints[]

对象

AWSServiceEndpoint 存储自定义 url 的配置,以覆盖 AWS 服务的现有默认值。

8.13.1.6. .spec.platformSpec.aws.serviceEndpoints

描述
serviceEndpoints 列表包含自定义端点,该端点将覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。
类型
array

8.13.1.7. .spec.platformSpec.aws.serviceEndpoints[]

描述
AWSServiceEndpoint 存储自定义 url 的配置,以覆盖 AWS 服务的现有默认值。
类型
对象
Expand
属性类型描述

name

字符串

name 是 AWS 服务的名称。所有服务名称的列表都可在 https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html 中找到,必须提供它,且不能为空。

url

字符串

URL 是带有方案 https 的完全限定 URI,可覆盖客户端生成的默认端点。必须提供此功能,且不能为空。

8.13.1.8. .spec.platformSpec.azure

描述
Azure 包含特定于 Azure 基础架构供应商的设置。
类型
对象

8.13.1.9. .spec.platformSpec.baremetal

描述
baremetal 包含特定于 BareMetal 平台的设置。
类型
对象

8.13.1.10. .spec.platformSpec.equinixMetal

描述
equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。
类型
对象

8.13.1.11. .spec.platformSpec.gcp

描述
GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。
类型
对象

8.13.1.12. .spec.platformSpec.ibmcloud

描述
ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。
类型
对象

8.13.1.13. .spec.platformSpec.kubevirt

描述
kubevirt 包含特定于 kubevirt 基础架构供应商的设置。
类型
对象

8.13.1.14. .spec.platformSpec.openstack

描述
OpenStack 包含特定于 OpenStack 基础架构供应商的设置。
类型
对象

8.13.1.15. .spec.platformSpec.ovirt

描述
oVirt 包含特定于 oVirt 基础架构供应商的设置。
类型
对象

8.13.1.16. .spec.platformSpec.powervs

描述
powervs 包含特定于 IBM Power 系统虚拟服务器基础架构供应商的设置。
类型
对象

8.13.1.17. .spec.platformSpec.vsphere

描述
vSphere 包含特定于 VSphere 基础架构供应商的设置。
类型
对象

8.13.1.18. .status

描述
status 包含从集群中观察到的值。它们可能无法覆盖。
类型
对象
Expand
属性类型描述

apiServerInternalURI

字符串

apiServerInternalURL 是一个有效的 URI,它带有方案 'https'、地址和可选端口(默认为 443)。apiServerInternalURL 可被 kubelet 等组件使用,使用基础架构供应商而不是 Kubernetes 网络联系 Kubernetes API 服务器。

apiServerURL

字符串

apiServerURL 是一个有效的 URI,它带有方案 'https'、地址和可选端口(默认为 443)。apiServerURL 可被 Web 控制台等组件使用,告知用户在哪里查找 Kubernetes API。

controlPlaneTopology

字符串

controlPlaneTopology 代表通常在控制节点上运行的操作对象的预期。默认值为 'HighlyAvailable',它代表运算符在 "normal" 集群中具有的行为。'SingleReplica' 模式将在单节点部署中使用,Operator 不应该为高可用性操作配置操作对象。"External" 模式表示 control plane 在集群外部托管,且其组件在集群中不可见。

etcdDiscoveryDomain

字符串

etcdDiscoveryDomain 是用于获取用于发现 etcd 服务器和客户端的 SRV 记录的域。如需更多信息: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery 弃用:从 4.7 开始,不再设置或遵守此字段。它将在以后的发行版本中被删除。

infrastructureName

字符串

infrastructureName 使用用户友好的名称唯一标识集群。设置后不应更改它。必须是最大长度 27,且必须具有字母数字字符或连字符。

infrastructureTopology

字符串

infrastructureTopology 代表不在 control plane 节点上运行的基础架构服务的预期,通常由节点选择器表示,用于 master 以外的 角色 值。默认值为 'HighlyAvailable',它代表运算符在 "normal" 集群中具有的行为。'SingleReplica' 模式将在单节点部署中使用,Operator 不应该为 high-available 操作配置操作对象:外部拓扑模式不适用于此字段。

platform

字符串

平台是集群的底层基础架构供应商。弃用:改为使用 platformStatus.type。

platformStatus

对象

platformStatus 包含特定于底层基础架构供应商的状态信息。

8.13.1.19. .status.platformStatus

描述
platformStatus 包含特定于底层基础架构供应商的状态信息。
类型
对象
Expand
属性类型描述

alibabaCloud

对象

alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。

aws

对象

AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。

azure

对象

Azure 包含特定于 Azure 基础架构供应商的设置。

baremetal

对象

baremetal 包含特定于 BareMetal 平台的设置。

equinixMetal

对象

equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。

gcp

对象

GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。

ibmcloud

对象

ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。

kubevirt

对象

kubevirt 包含特定于 kubevirt 基础架构供应商的设置。

openstack

对象

OpenStack 包含特定于 OpenStack 基础架构供应商的设置。

ovirt

对象

oVirt 包含特定于 oVirt 基础架构供应商的设置。

powervs

对象

powervs 包含特定于 Power Systems Virtual Servers 基础架构供应商的设置。

type

字符串

type 是集群的底层基础架构供应商。这个值控制基础架构自动化,如服务负载均衡器、动态卷置备、机器创建和删除和其他集成。如果 None,则不会启用基础架构自动化。允许的值有 "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "EquinixMetal", "PowerVS", "AlibabaCloud" 和 "None"。独立组件可能不支持所有平台,如果不支持该平台,则必须将未识别的平台处理为 None。这个值将与 status.platformstatus.platformStatus.type 同步。目前,这个值在设置后无法更改。

vsphere

对象

vSphere 包含特定于 VSphere 基础架构供应商的设置。

8.13.1.20. .status.platformStatus.alibabaCloud

描述
alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。
类型
对象
必填
  • region
  • resourceGroupID
Expand
属性类型描述

region

字符串

region 指定为集群创建的 Alibaba 云资源的区域。

resourceGroupID

字符串

resourceGroupID 是集群的资源组的 ID。

resourceTags

array

resourceTags 是应用于为集群创建的 Alibaba Cloud 资源的额外标签列表。

resourceTags[]

对象

AlibabaCloudResourceTag 是要添加的一组标签以应用到资源。

8.13.1.21. .status.platformStatus.alibabaCloud.resourceTags

描述
resourceTags 是应用于为集群创建的 Alibaba Cloud 资源的额外标签列表。
类型
array
描述
AlibabaCloudResourceTag 是要添加的一组标签以应用到资源。
类型
对象
必填
  • key
  • value
Expand
属性类型描述

key

字符串

key 是标签的密钥。

value

字符串

value 是标签值。

8.13.1.23. .status.platformStatus.aws

描述
AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

region

字符串

区域包含集群创建的新 AWS 资源的默认 AWS 区域。

resourceTags

array

resourceTags 是应用于为集群创建的 AWS 资源的额外标签列表。有关标记 AWS 资源的信息,请参阅 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html。AWS 支持每个资源最多 50 个标签。OpenShift 保留 25 个标签供用户使用,保留 25 个标签供用户使用。

resourceTags[]

对象

AWSResourceTag 是一个标签,可应用到集群的 AWS 资源。

serviceEndpoints

array

serviceEndpoints 列表包含自定义端点,该端点将覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。

serviceEndpoints[]

对象

AWSServiceEndpoint 存储自定义 url 的配置,以覆盖 AWS 服务的现有默认值。

8.13.1.24. .status.platformStatus.aws.resourceTags

描述
resourceTags 是应用于为集群创建的 AWS 资源的额外标签列表。有关标记 AWS 资源的信息,请参阅 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html。AWS 支持每个资源最多 50 个标签。OpenShift 保留 25 个标签供用户使用,保留 25 个标签供用户使用。
类型
array

8.13.1.25. .status.platformStatus.aws.resourceTags[]

描述
AWSResourceTag 是一个标签,可应用到集群的 AWS 资源。
类型
对象
必填
  • key
  • value
Expand
属性类型描述

key

字符串

key 是标签的密钥

value

字符串

value 是标签值。有些 AWS 服务不支持空值。由于标签添加到许多服务中的资源,标签值的长度必须满足所有服务的要求。

8.13.1.26. .status.platformStatus.aws.serviceEndpoints

描述
serviceEndpoints 列表包含自定义端点,该端点将覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。
类型
array

8.13.1.27. .status.platformStatus.aws.serviceEndpoints[]

描述
AWSServiceEndpoint 存储自定义 url 的配置,以覆盖 AWS 服务的现有默认值。
类型
对象
Expand
属性类型描述

name

字符串

name 是 AWS 服务的名称。所有服务名称的列表都可在 https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html 中找到,必须提供它,且不能为空。

url

字符串

URL 是带有方案 https 的完全限定 URI,可覆盖客户端生成的默认端点。必须提供此功能,且不能为空。

8.13.1.28. .status.platformStatus.azure

描述
Azure 包含特定于 Azure 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

armEndpoint

字符串

armEndpoint 指定用于在非外云(如 Azure Stack)中进行资源管理的 URL。

cloudName

字符串

cloudName 是 Azure 云环境的名称,可用于使用适当的 Azure API 端点配置 Azure SDK。如果为空,则该值等于 AzurePublicCloud

networkResourceGroupName

字符串

networkResourceGroupName 是网络资源的资源组,如集群使用的虚拟网络和子网。如果为空,则值与 ResourceGroupName 相同。

resourceGroupName

字符串

resourceGroupName 是为集群创建的新 Azure 资源的 Resource Group。

8.13.1.29. .status.platformStatus.baremetal

描述
baremetal 包含特定于 BareMetal 平台的设置。
类型
对象
Expand
属性类型描述

apiServerInternalIP

字符串

apiServerInternalIP 是一个 IP 地址,用于联系集群中的组件可以使用的 Kubernetes API 服务器,如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的自托管负载均衡器的 IP。

ingressIP

字符串

ingressIP 是一个外部 IP,路由到默认入口控制器。IP 是通配符 DNS 记录的合适的目标,用于解析默认路由主机名。

nodeDNSIP

字符串

nodeDNSIP 是节点使用的内部 DNS 的 IP 地址。与 DNS 操作器管理不同,NodeDNSIP 为节点本身提供名称解析。BareMetal 部署没有 DNS-as-a-service。为尽量减少对数据中心 DNS 所需的更改,DNS 服务作为静态 pod 托管,以将这些主机名提供给集群中的节点。

8.13.1.30. .status.platformStatus.equinixMetal

描述
equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

apiServerInternalIP

字符串

apiServerInternalIP 是一个 IP 地址,用于联系集群中的组件可以使用的 Kubernetes API 服务器,如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的自托管负载均衡器的 IP。

ingressIP

字符串

ingressIP 是一个外部 IP,路由到默认入口控制器。IP 是通配符 DNS 记录的合适的目标,用于解析默认路由主机名。

8.13.1.31. .status.platformStatus.gcp

描述
GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

projectID

字符串

resourceGroupName 是为集群创建的新 GCP 资源的项目 ID。

region

字符串

区域包含为集群创建的新 GCP 资源的区域。

8.13.1.32. .status.platformStatus.ibmcloud

描述
ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

cisInstanceCRN

字符串

CISInstanceCRN 是 Cloud Internet Services 实例的 CRN,管理集群基域的 DNS 区域

位置

字符串

位置是部署集群的位置

providerType

字符串

ProviderType 表示所创建的集群类型

resourceGroupName

字符串

resourceGroupName 是为集群创建的新 IBMCloud 资源的资源组。

8.13.1.33. .status.platformStatus.kubevirt

描述
kubevirt 包含特定于 kubevirt 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

apiServerInternalIP

字符串

apiServerInternalIP 是一个 IP 地址,用于联系集群中的组件可以使用的 Kubernetes API 服务器,如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的自托管负载均衡器的 IP。

ingressIP

字符串

ingressIP 是一个外部 IP,路由到默认入口控制器。IP 是通配符 DNS 记录的合适的目标,用于解析默认路由主机名。

8.13.1.34. .status.platformStatus.openstack

描述
OpenStack 包含特定于 OpenStack 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

apiServerInternalIP

字符串

apiServerInternalIP 是一个 IP 地址,用于联系集群中的组件可以使用的 Kubernetes API 服务器,如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的自托管负载均衡器的 IP。

cloudName

字符串

cloudName 是客户端配置文件(clouds.yaml)中所需的 OpenStack 云的名称。

ingressIP

字符串

ingressIP 是一个外部 IP,路由到默认入口控制器。IP 是通配符 DNS 记录的合适的目标,用于解析默认路由主机名。

nodeDNSIP

字符串

nodeDNSIP 是节点使用的内部 DNS 的 IP 地址。与 DNS 操作器管理不同,NodeDNSIP 为节点本身提供名称解析。OpenStack 部署没有 DNS-as-a-service。为尽量减少对数据中心 DNS 所需的更改,DNS 服务作为静态 pod 托管,以将这些主机名提供给集群中的节点。

8.13.1.35. .status.platformStatus.ovirt

描述
oVirt 包含特定于 oVirt 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

apiServerInternalIP

字符串

apiServerInternalIP 是一个 IP 地址,用于联系集群中的组件可以使用的 Kubernetes API 服务器,如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的自托管负载均衡器的 IP。

ingressIP

字符串

ingressIP 是一个外部 IP,路由到默认入口控制器。IP 是通配符 DNS 记录的合适的目标,用于解析默认路由主机名。

nodeDNSIP

字符串

弃用:从 4.6 开始,不再设置或遵守此字段。它将在以后的发行版本中被删除。

8.13.1.36. .status.platformStatus.powervs

描述
powervs 包含特定于 Power Systems Virtual Servers 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

cisInstanceCRN

字符串

CISInstanceCRN 是 Cloud Internet Services 实例的 CRN,管理集群基域的 DNS 区域

region

字符串

区域包含集群创建的新 Power VS 资源的默认 Power VS 区域。

serviceEndpoints

array

serviceEndpoints 是自定义端点的列表,将覆盖 Power VS 服务的默认服务端点。

serviceEndpoints[]

对象

PowervsServiceEndpoint 存储自定义 url 的配置,以覆盖现有 PowerVS Services 默认值。

zone

字符串

zone 包含集群创建的新 Power VS 资源的默认区域。注: 目前只支持单区 OCP 集群

8.13.1.37. .status.platformStatus.powervs.serviceEndpoints

描述
serviceEndpoints 是自定义端点的列表,将覆盖 Power VS 服务的默认服务端点。
类型
array
描述
PowervsServiceEndpoint 存储自定义 url 的配置,以覆盖现有 PowerVS Services 默认值。
类型
对象
必填
  • name
  • url
Expand
属性类型描述

name

字符串

name 是 Power VS 服务的名称。

url

字符串

URL 是带有方案 https 的完全限定 URI,可覆盖客户端生成的默认端点。必须提供此功能,且不能为空。

8.13.1.39. .status.platformStatus.vsphere

描述
vSphere 包含特定于 VSphere 基础架构供应商的设置。
类型
对象
Expand
属性类型描述

apiServerInternalIP

字符串

apiServerInternalIP 是一个 IP 地址,用于联系集群中的组件可以使用的 Kubernetes API 服务器,如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的自托管负载均衡器的 IP。

ingressIP

字符串

ingressIP 是一个外部 IP,路由到默认入口控制器。IP 是通配符 DNS 记录的合适的目标,用于解析默认路由主机名。

nodeDNSIP

字符串

nodeDNSIP 是节点使用的内部 DNS 的 IP 地址。与 DNS 操作器管理不同,NodeDNSIP 为节点本身提供名称解析。vSphere 部署没有 DNS-as-a-service。为尽量减少对数据中心 DNS 所需的更改,DNS 服务作为静态 pod 托管,以将这些主机名提供给集群中的节点。

8.13.2. API 端点

可用的 API 端点如下:

  • /apis/config.openshift.io/v1/infrastructures

    • DELETE :删除基础架构的集合
    • GET: 列出基础架构类型的对象
    • POST :创建基础架构
  • /apis/config.openshift.io/v1/infrastructures/{name}

    • DELETE :删除基础架构
    • GET :读取指定的基础架构
    • PATCH :部分更新指定的基础架构
    • PUT :替换指定的基础架构
  • /apis/config.openshift.io/v1/infrastructures/{name}/status

    • GET: 指定基础架构的读取状态
    • PATCH :部分更新指定基础架构的状态
    • PUT: 替换指定基础架构的状态

8.13.2.1. /apis/config.openshift.io/v1/infrastructures

Expand
表 8.342. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除基础架构集合
Expand
表 8.343. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 8.344. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出基础架构的对象
Expand
表 8.345. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 8.346. HTTP 响应
HTTP 代码响应正文

200 - OK

InfrastructureList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建基础架构
Expand
表 8.347. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.348. 主体参数
参数类型描述

正文(body)

Infrastructure 模式

 
Expand
表 8.349. HTTP 响应
HTTP 代码响应正文

200 - OK

Infrastructure 模式

201 - Created

Infrastructure 模式

202 - Accepted

Infrastructure 模式

401 - Unauthorized

Expand
表 8.350. 全局路径参数
参数类型描述

name

字符串

基础架构的名称

Expand
表 8.351. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除基础架构
Expand
表 8.352. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 8.353. 主体参数
参数类型描述

正文(body)

DeleteOptions_v2 schema

 
Expand
表 8.354. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的基础架构
Expand
表 8.355. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 8.356. HTTP 响应
HTTP 代码响应正文

200 - OK

Infrastructure 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的基础架构
Expand
表 8.357. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.358. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 8.359. HTTP 响应
HTTP 代码响应正文

200 - OK

Infrastructure 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的基础架构
Expand
表 8.360. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.361. 主体参数
参数类型描述

正文(body)

Infrastructure 模式

 
Expand
表 8.362. HTTP 响应
HTTP 代码响应正文

200 - OK

Infrastructure 模式

201 - Created

Infrastructure 模式

401 - Unauthorized

Expand
表 8.363. 全局路径参数
参数类型描述

name

字符串

基础架构的名称

Expand
表 8.364. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
GET
描述
指定基础架构的读取状态
Expand
表 8.365. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 8.366. HTTP 响应
HTTP 代码响应正文

200 - OK

Infrastructure 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定基础架构的部分更新状态
Expand
表 8.367. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.368. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 8.369. HTTP 响应
HTTP 代码响应正文

200 - OK

Infrastructure 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定基础架构的状态
Expand
表 8.370. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.371. 主体参数
参数类型描述

正文(body)

Infrastructure 模式

 
Expand
表 8.372. HTTP 响应
HTTP 代码响应正文

200 - OK

Infrastructure 模式

201 - Created

Infrastructure 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat