Infrastructure [config.openshift.io/v1] - Config APIs | API reference

Specification
API endpoints

Description

Infrastructure holds cluster-wide information about Infrastructure. The canonical name is cluster

Type

object

Required

spec

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta_v2 meta/v1`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	spec holds user settable values for configuration
`status`	`object`	status holds observed values from the cluster. They may not be overridden.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2 meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec holds user settable values for configuration

status

object

status holds observed values from the cluster. They may not be overridden.

.spec

Description: spec holds user settable values for configuration
Type: object

Property Type Description

Property	Type	Description
`cloudConfig`	`object`	cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config. cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace with the kube cloud config is stored in `cloud.conf` key. All the clients are expected to use the generated ConfigMap only.
`platformSpec`	`object`	platformSpec holds desired information specific to the underlying infrastructure provider.

cloudConfig

object

cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config. cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap kube-cloud-config in openshift-config-managed namespace with the kube cloud config is stored in cloud.conf key. All the clients are expected to use the generated ConfigMap only.

platformSpec

object

platformSpec holds desired information specific to the underlying infrastructure provider.

.spec.cloudConfig

Description: cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config. cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap kube-cloud-config in openshift-config-managed namespace with the kube cloud config is stored in cloud.conf key. All the clients are expected to use the generated ConfigMap only.
Type: object

Property Type Description

Property	Type	Description
`key`	`string`	Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.
`name`	`string`

key

string

Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.

name

string

.spec.platformSpec

Description: platformSpec holds desired information specific to the underlying infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`aws`	`object`	AWS contains settings specific to the Amazon Web services infrastructure provider.
`azure`	`object`	Azure contains settings specific to the Azure infrastructure provider.
`baremetal`	`object`	BareMetal contains settings specific to the BareMetal platform.
`equinixMetal`	`object`	EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
`gcp`	`object`	GCP contains settings specific to the Google Cloud Platform infrastructure provider.
`ibmcloud`	`object`	IBMCloud contains settings specific to the IBMCloud infrastructure provider.
`kubevirt`	`object`	Kubevirt contains settings specific to the kubevirt infrastructure provider.
`openstack`	`object`	OpenStack contains settings specific to the OpenStack infrastructure provider.
`ovirt`	`object`	Ovirt contains settings specific to the oVirt infrastructure provider.
`type`	`string`	type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.
`vsphere`	`object`	VSphere contains settings specific to the VSphere infrastructure provider.

aws

object

AWS contains settings specific to the Amazon Web services infrastructure provider.

azure

object

Azure contains settings specific to the Azure infrastructure provider.

baremetal

object

BareMetal contains settings specific to the BareMetal platform.

equinixMetal

object

EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.

gcp

object

GCP contains settings specific to the Google Cloud Platform infrastructure provider.

ibmcloud

object

IBMCloud contains settings specific to the IBMCloud infrastructure provider.

kubevirt

object

Kubevirt contains settings specific to the kubevirt infrastructure provider.

openstack

object

OpenStack contains settings specific to the OpenStack infrastructure provider.

ovirt

object

Ovirt contains settings specific to the oVirt infrastructure provider.

type

string

type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.

vsphere

object

VSphere contains settings specific to the VSphere infrastructure provider.

.spec.platformSpec.aws

Description: AWS contains settings specific to the Amazon Web services infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`serviceEndpoints`	`array`	serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS services. There must be only one serviceEndpoint for a service.
`serviceEndpoints[]`	`object`	AWSserviceEndpoint store the configuration of a custom url to override existing defaults of AWS services.

serviceEndpoints

array

serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS services. There must be only one serviceEndpoint for a service.

serviceEndpoints[]

object

AWSserviceEndpoint store the configuration of a custom url to override existing defaults of AWS services.

.spec.platformSpec.aws.serviceEndpoints

Description: serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS services. There must be only one serviceEndpoint for a service.
Type: array

.spec.platformSpec.aws.serviceEndpoints[]

Description: AWSserviceEndpoint store the configuration of a custom url to override existing defaults of AWS services.
Type: object

Property Type Description

Property	Type	Description
`name`	`string`	name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.
`url`	`string`	url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.

name

string

name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.

url

string

url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.

.spec.platformSpec.azure

Description: Azure contains settings specific to the Azure infrastructure provider.
Type: object

.spec.platformSpec.baremetal

Description: BareMetal contains settings specific to the BareMetal platform.
Type: object

.spec.platformSpec.equinixMetal

Description: EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
Type: object

.spec.platformSpec.gcp

Description: GCP contains settings specific to the Google Cloud Platform infrastructure provider.
Type: object

.spec.platformSpec.ibmcloud

Description: IBMCloud contains settings specific to the IBMCloud infrastructure provider.
Type: object

.spec.platformSpec.kubevirt

Description: Kubevirt contains settings specific to the kubevirt infrastructure provider.
Type: object

.spec.platformSpec.openstack

Description: OpenStack contains settings specific to the OpenStack infrastructure provider.
Type: object

.spec.platformSpec.ovirt

Description: Ovirt contains settings specific to the oVirt infrastructure provider.
Type: object

.spec.platformSpec.vsphere

Description: VSphere contains settings specific to the VSphere infrastructure provider.
Type: object

.status

Description: status holds observed values from the cluster. They may not be overridden.
Type: object

Property Type Description

Property	Type	Description
`apiServerInternalURI`	`string`	apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking.
`apiServerURL`	`string`	apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API.
`controlPlaneTopology`	`string`	controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a "normal" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation
`etcdDiscoveryDomain`	`string`	etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release.
`infrastructureName`	`string`	infrastructureName uniquely identifies a cluster with a human friendly name. Once set it should not be changed. Must be of max length 27 and must have only alphanumeric or hyphen characters.
`infrastructureTopology`	`string`	infrastructureTopology expresses the expectations for infrastructure services that do not run on control plane nodes, usually indicated by a node selector for a `role` value other than `master`. The default is 'HighlyAvailable', which represents the behavior operators have in a "normal" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation
`platform`	`string`	platform is the underlying infrastructure provider for the cluster. Deprecated: Use platformStatus.type instead.
`platformStatus`	`object`	platformStatus holds status information specific to the underlying infrastructure provider.

apiServerInternalURI

string

apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking.

apiServerURL

string

apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API.

controlPlaneTopology

string

controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a "normal" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation

etcdDiscoveryDomain

string

etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release.

infrastructureName

string

infrastructureName uniquely identifies a cluster with a human friendly name. Once set it should not be changed. Must be of max length 27 and must have only alphanumeric or hyphen characters.

infrastructureTopology

string

infrastructureTopology expresses the expectations for infrastructure services that do not run on control plane nodes, usually indicated by a node selector for a role value other than master. The default is 'HighlyAvailable', which represents the behavior operators have in a "normal" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation

platform

string

platform is the underlying infrastructure provider for the cluster. Deprecated: Use platformStatus.type instead.

platformStatus

object

platformStatus holds status information specific to the underlying infrastructure provider.

.status.platformStatus

Description: platformStatus holds status information specific to the underlying infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`aws`	`object`	AWS contains settings specific to the Amazon Web services infrastructure provider.
`azure`	`object`	Azure contains settings specific to the Azure infrastructure provider.
`baremetal`	`object`	BareMetal contains settings specific to the BareMetal platform.
`equinixMetal`	`object`	EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
`gcp`	`object`	GCP contains settings specific to the Google Cloud Platform infrastructure provider.
`ibmcloud`	`object`	IBMCloud contains settings specific to the IBMCloud infrastructure provider.
`kubevirt`	`object`	Kubevirt contains settings specific to the kubevirt infrastructure provider.
`openstack`	`object`	OpenStack contains settings specific to the OpenStack infrastructure provider.
`ovirt`	`object`	Ovirt contains settings specific to the oVirt infrastructure provider.
`type`	`string`	type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "EquinixMetal", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. This value will be synced with to the `status.platform` and `status.platformStatus.type`. Currently this value cannot be changed once set.
`vsphere`	`object`	VSphere contains settings specific to the VSphere infrastructure provider.

aws

object

AWS contains settings specific to the Amazon Web services infrastructure provider.

azure

object

Azure contains settings specific to the Azure infrastructure provider.

baremetal

object

BareMetal contains settings specific to the BareMetal platform.

equinixMetal

object

EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.

gcp

object

GCP contains settings specific to the Google Cloud Platform infrastructure provider.

ibmcloud

object

IBMCloud contains settings specific to the IBMCloud infrastructure provider.

kubevirt

object

Kubevirt contains settings specific to the kubevirt infrastructure provider.

openstack

object

OpenStack contains settings specific to the OpenStack infrastructure provider.

ovirt

object

Ovirt contains settings specific to the oVirt infrastructure provider.

type

string

type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "EquinixMetal", and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. This value will be synced with to the status.platform and status.platformStatus.type. Currently this value cannot be changed once set.

vsphere

object

VSphere contains settings specific to the VSphere infrastructure provider.

.status.platformStatus.aws

Description: AWS contains settings specific to the Amazon Web services infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`region`	`string`	region holds the default AWS region for new AWS resources created by the cluster.
`resourceTags`	`array`	resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.
`resourceTags[]`	`object`	AWSResourceTag is a tag to apply to AWS resources created for the cluster.
`serviceEndpoints`	`array`	serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS services. There must be only one serviceEndpoint for a service.
`serviceEndpoints[]`	`object`	AWSserviceEndpoint store the configuration of a custom url to override existing defaults of AWS services.

region

string

region holds the default AWS region for new AWS resources created by the cluster.

resourceTags

array

resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.

resourceTags[]

object

AWSResourceTag is a tag to apply to AWS resources created for the cluster.

serviceEndpoints

array

serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS services. There must be only one serviceEndpoint for a service.

serviceEndpoints[]

object

AWSserviceEndpoint store the configuration of a custom url to override existing defaults of AWS services.

.status.platformStatus.aws.resourceTags

Description: resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.
Type: array

.status.platformStatus.aws.resourceTags[]

Description

AWSResourceTag is a tag to apply to AWS resources created for the cluster.

Type

object

Required

key
value

Property Type Description

Property	Type	Description
`key`	`string`	key is the key of the tag
`value`	`string`	value is the value of the tag. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services.

key

string

key is the key of the tag

value

string

value is the value of the tag. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services.

.status.platformStatus.aws.serviceEndpoints

Description: serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS services. There must be only one serviceEndpoint for a service.
Type: array

.status.platformStatus.aws.serviceEndpoints[]

Description: AWSserviceEndpoint store the configuration of a custom url to override existing defaults of AWS services.
Type: object

Property Type Description

Property	Type	Description
`name`	`string`	name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.
`url`	`string`	url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.

name

string

url

string

url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.

.status.platformStatus.azure

Description: Azure contains settings specific to the Azure infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`cloudName`	`string`	cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK with the appropriate Azure API endpoints. If empty, the value is equal to `AzurePublicCloud`.
`networkResourceGroupName`	`string`	networkResourceGroupName is the Resource Group for network resources like the Virtual Network and Subnets used by the cluster. If empty, the value is same as ResourceGroupName.
`resourceGroupName`	`string`	resourceGroupName is the Resource Group for new Azure resources created for the cluster.

cloudName

string

cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK with the appropriate Azure API endpoints. If empty, the value is equal to AzurePublicCloud.

networkResourceGroupName

string

networkResourceGroupName is the Resource Group for network resources like the Virtual Network and Subnets used by the cluster. If empty, the value is same as ResourceGroupName.

resourceGroupName

string

resourceGroupName is the Resource Group for new Azure resources created for the cluster.

.status.platformStatus.baremetal

Description: BareMetal contains settings specific to the BareMetal platform.
Type: object

Property Type Description

Property	Type	Description
`apiServerInternalIP`	`string`	apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
`ingressIP`	`string`	ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.
`nodeDNSIP`	`string`	nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for BareMetal deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.

apiServerInternalIP

string

apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.

ingressIP

string

ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

nodeDNSIP

string

nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, NodeDNSIP provides name resolution for the nodes themselves. There is no DNS-as-a-service for BareMetal deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.

.status.platformStatus.equinixMetal

Description: EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`apiServerInternalIP`	`string`	apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
`ingressIP`	`string`	ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

apiServerInternalIP

string

ingressIP

string

ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

.status.platformStatus.gcp

Description: GCP contains settings specific to the Google Cloud Platform infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`projectID`	`string`	resourceGroupName is the Project ID for new GCP resources created for the cluster.
`region`	`string`	region holds the region for new GCP resources created for the cluster.

projectID

string

resourceGroupName is the Project ID for new GCP resources created for the cluster.

region

string

region holds the region for new GCP resources created for the cluster.

.status.platformStatus.ibmcloud

Description: IBMCloud contains settings specific to the IBMCloud infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`location`	`string`	Location is where the cluster has been deployed
`providerType`	`string`	ProviderType indicates the type of cluster that was created
`resourceGroupName`	`string`	ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.

location

string

Location is where the cluster has been deployed

providerType

string

ProviderType indicates the type of cluster that was created

resourceGroupName

string

ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.

.status.platformStatus.kubevirt

Description: Kubevirt contains settings specific to the kubevirt infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`apiServerInternalIP`	`string`	apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
`ingressIP`	`string`	ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

apiServerInternalIP

string

ingressIP

string

ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

.status.platformStatus.openstack

Description: OpenStack contains settings specific to the OpenStack infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`apiServerInternalIP`	`string`	apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
`cloudName`	`string`	cloudName is the name of the desired OpenStack cloud in the client configuration file (`clouds.yaml`).
`ingressIP`	`string`	ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.
`nodeDNSIP`	`string`	nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for OpenStack deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.

apiServerInternalIP

string

cloudName

string

cloudName is the name of the desired OpenStack cloud in the client configuration file (clouds.yaml).

ingressIP

string

ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

nodeDNSIP

string

nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, NodeDNSIP provides name resolution for the nodes themselves. There is no DNS-as-a-service for OpenStack deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.

.status.platformStatus.ovirt

Description: Ovirt contains settings specific to the oVirt infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`apiServerInternalIP`	`string`	apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
`ingressIP`	`string`	ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.
`nodeDNSIP`	`string`	deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release.

apiServerInternalIP

string

ingressIP

string

ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

nodeDNSIP

string

deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release.

.status.platformStatus.vsphere

Description: VSphere contains settings specific to the VSphere infrastructure provider.
Type: object

Property Type Description

Property	Type	Description
`apiServerInternalIP`	`string`	apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
`ingressIP`	`string`	ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.
`nodeDNSIP`	`string`	nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for vSphere deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.

apiServerInternalIP

string

ingressIP

string

ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.

nodeDNSIP

string

nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, NodeDNSIP provides name resolution for the nodes themselves. There is no DNS-as-a-service for vSphere deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.

API endpoints

The following API endpoints are available:

/apis/config.openshift.io/v1/infrastructures
- DELETE: delete collection of Infrastructure
- GET: list objects of kind Infrastructure
- POST: create an Infrastructure
/apis/config.openshift.io/v1/infrastructures/{name}
- DELETE: delete an Infrastructure
- GET: read the specified Infrastructure
- PATCH: partially update the specified Infrastructure
- PUT: replace the specified Infrastructure
/apis/config.openshift.io/v1/infrastructures/{name}/status
- GET: read status of the specified Infrastructure
- PATCH: partially update status of the specified Infrastructure
- PUT: replace status of the specified Infrastructure

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

Table 1. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete collection of Infrastructure

Table 2. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch`	`string`	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Status_v2 meta/v1`

HTTP method: GET
Description: list objects of kind Infrastructure

Table 4. Query parameters
Parameter	Type	Description
`allowWatchBookmarks`	`boolean`	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`resourceVersionMatch`	`string`	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`InfrastructureList config.openshift.io/v1`

HTTP method: POST
Description: create an Infrastructure

Table 6. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 7. Body parameters
Parameter	Type	Description
`body`	`Infrastructure config.openshift.io/v1`

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Infrastructure config.openshift.io/v1`

/apis/config.openshift.io/v1/infrastructures/{name}

Table 9. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Infrastructure

Table 10. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete an Infrastructure

Table 11. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 12. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions_v2 meta/v1`

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`Status_v2 meta/v1`

HTTP method: GET
Description: read the specified Infrastructure

Table 14. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`Infrastructure config.openshift.io/v1`

HTTP method: PATCH
Description: partially update the specified Infrastructure

Table 16. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 17. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`Infrastructure config.openshift.io/v1`

HTTP method: PUT
Description: replace the specified Infrastructure

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 20. Body parameters
Parameter	Type	Description
`body`	`Infrastructure config.openshift.io/v1`

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`Infrastructure config.openshift.io/v1`

/apis/config.openshift.io/v1/infrastructures/{name}/status

Table 22. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Infrastructure

Table 23. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read status of the specified Infrastructure

Table 24. Query parameters
Parameter	Type	Description
`resourceVersion`	`string`	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset

Table 25. HTTP responses
HTTP code	Reponse body
200 - OK	`Infrastructure config.openshift.io/v1`

HTTP method: PATCH
Description: partially update status of the specified Infrastructure

Table 26. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 27. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 28. HTTP responses
HTTP code	Reponse body
200 - OK	`Infrastructure config.openshift.io/v1`

HTTP method: PUT
Description: replace status of the specified Infrastructure

Table 29. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldManager`	`string`	fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 30. Body parameters
Parameter	Type	Description
`body`	`Infrastructure config.openshift.io/v1`

Table 31. HTTP responses
HTTP code	Reponse body
200 - OK	`Infrastructure config.openshift.io/v1`