Infrastructure holds cluster-wide information about Infrastructure. The canonical name is cluster
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Infrastructure holds cluster-wide information about Infrastructure. The canonical name is cluster
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
object
spec
Property | Type | Description |
---|---|---|
|
|
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 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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
spec holds user settable values for configuration |
|
|
status holds observed values from the cluster. They may not be overridden. |
spec holds user settable values for configuration
object
Property | Type | 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 |
|
|
platformSpec holds desired information specific to the underlying infrastructure provider. |
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.
object
Property | Type | Description |
---|---|---|
|
|
Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. |
|
|
platformSpec holds desired information specific to the underlying infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. |
|
|
AWS contains settings specific to the Amazon Web Services infrastructure provider. |
|
|
Azure contains settings specific to the Azure infrastructure provider. |
|
|
BareMetal contains settings specific to the BareMetal platform. |
|
|
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider. |
|
|
GCP contains settings specific to the Google Cloud Platform infrastructure provider. |
|
|
IBMCloud contains settings specific to the IBMCloud infrastructure provider. |
|
|
Kubevirt contains settings specific to the kubevirt infrastructure provider. |
|
|
Nutanix contains settings specific to the Nutanix infrastructure provider. |
|
|
OpenStack contains settings specific to the OpenStack infrastructure provider. |
|
|
Ovirt contains settings specific to the oVirt infrastructure provider. |
|
|
PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. |
|
|
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", "PowerVS", "AlibabaCloud", "Nutanix" and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. |
|
|
VSphere contains settings specific to the VSphere infrastructure provider. |
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
object
AWS contains settings specific to the Amazon Web Services infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. |
|
|
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |
serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
array
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
object
Property | Type | Description |
---|---|---|
|
|
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 is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |
Azure contains settings specific to the Azure infrastructure provider.
object
BareMetal contains settings specific to the BareMetal platform.
object
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
object
GCP contains settings specific to the Google Cloud Platform infrastructure provider.
object
IBMCloud contains settings specific to the IBMCloud infrastructure provider.
object
Kubevirt contains settings specific to the kubevirt infrastructure provider.
object
Nutanix contains settings specific to the Nutanix infrastructure provider.
object
prismCentral
prismElements
Property | Type | Description |
---|---|---|
|
|
prismCentral holds the endpoint address and port to access the Nutanix Prism Central. When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list. |
|
|
prismElements holds one or more endpoint address and port data to access the Nutanix Prism Elements (clusters) of the Nutanix Prism Central. Currently we only support one Prism Element (cluster) for an OpenShift cluster, where all the Nutanix resources (VMs, subnets, volumes, etc.) used in the OpenShift cluster are located. In the future, we may support Nutanix resources (VMs, etc.) spread over multiple Prism Elements (clusters) of the Prism Central. |
|
|
NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster) |
prismCentral holds the endpoint address and port to access the Nutanix Prism Central. When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.
object
address
port
Property | Type | Description |
---|---|---|
|
|
address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster) |
|
|
port is the port number to access the Nutanix Prism Central or Element (cluster) |
prismElements holds one or more endpoint address and port data to access the Nutanix Prism Elements (clusters) of the Nutanix Prism Central. Currently we only support one Prism Element (cluster) for an OpenShift cluster, where all the Nutanix resources (VMs, subnets, volumes, etc.) used in the OpenShift cluster are located. In the future, we may support Nutanix resources (VMs, etc.) spread over multiple Prism Elements (clusters) of the Prism Central.
array
NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster)
object
endpoint
name
Property | Type | Description |
---|---|---|
|
|
endpoint holds the endpoint address and port data of the Prism Element (cluster). When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list. |
|
|
name is the name of the Prism Element (cluster). This value will correspond with the cluster field configured on other resources (eg Machines, PVCs, etc). |
endpoint holds the endpoint address and port data of the Prism Element (cluster). When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.
object
address
port
Property | Type | Description |
---|---|---|
|
|
address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster) |
|
|
port is the port number to access the Nutanix Prism Central or Element (cluster) |
OpenStack contains settings specific to the OpenStack infrastructure provider.
object
Ovirt contains settings specific to the oVirt infrastructure provider.
object
PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service. |
|
|
PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services. |
serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.
array
PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.
object
name
url
Property | Type | Description |
---|---|---|
|
|
name is the name of the Power VS service. Few of the services are IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud |
|
|
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. |
VSphere contains settings specific to the VSphere infrastructure provider.
object
status holds observed values from the cluster. They may not be overridden.
object
Property | Type | Description |
---|---|---|
|
|
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 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 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 The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster. |
|
|
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 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 expresses the expectations for infrastructure services that do not run on control plane nodes, usually indicated by a node selector for a |
|
|
platform is the underlying infrastructure provider for the cluster. Deprecated: Use platformStatus.type instead. |
|
|
platformStatus holds status information specific to the underlying infrastructure provider. |
platformStatus holds status information specific to the underlying infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. |
|
|
AWS contains settings specific to the Amazon Web Services infrastructure provider. |
|
|
Azure contains settings specific to the Azure infrastructure provider. |
|
|
BareMetal contains settings specific to the BareMetal platform. |
|
|
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider. |
|
|
GCP contains settings specific to the Google Cloud Platform infrastructure provider. |
|
|
IBMCloud contains settings specific to the IBMCloud infrastructure provider. |
|
|
Kubevirt contains settings specific to the kubevirt infrastructure provider. |
|
|
Nutanix contains settings specific to the Nutanix infrastructure provider. |
|
|
OpenStack contains settings specific to the OpenStack infrastructure provider. |
|
|
Ovirt contains settings specific to the oVirt infrastructure provider. |
|
|
PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider. |
|
|
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", "PowerVS", "AlibabaCloud", "Nutanix" 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 |
|
|
VSphere contains settings specific to the VSphere infrastructure provider. |
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
object
region
Property | Type | Description |
---|---|---|
|
|
region specifies the region for Alibaba Cloud resources created for the cluster. |
|
|
resourceGroupID is the ID of the resource group for the cluster. |
|
|
resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster. |
|
|
AlibabaCloudResourceTag is the set of tags to add to apply to resources. |
resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster.
array
AlibabaCloudResourceTag is the set of tags to add to apply to resources.
object
key
value
Property | Type | Description |
---|---|---|
|
|
key is the key of the tag. |
|
|
value is the value of the tag. |
AWS contains settings specific to the Amazon Web Services infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
region holds the default AWS region for new AWS resources created by the cluster. |
|
|
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. |
|
|
AWSResourceTag is a tag to apply to AWS resources created for the cluster. |
|
|
ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. |
|
|
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |
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.
array
AWSResourceTag is a tag to apply to AWS resources created for the cluster.
object
key
value
Property | Type | Description |
---|---|---|
|
|
key is the key of the tag |
|
|
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. |
ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
array
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
object
Property | Type | Description |
---|---|---|
|
|
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 is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |
Azure contains settings specific to the Azure infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack. |
|
|
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 |
|
|
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 is the Resource Group for new Azure resources created for the cluster. |
BareMetal contains settings specific to the BareMetal platform.
object
Property | Type | Description |
---|---|---|
|
|
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. Deprecated: Use APIServerInternalIPs instead. |
|
|
apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
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. Deprecated: Use IngressIPs instead. |
|
|
ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, |
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
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 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. |
GCP contains settings specific to the Google Cloud Platform infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
resourceGroupName is the Project ID for new GCP resources created for the cluster. |
|
|
region holds the region for new GCP resources created for the cluster. |
IBMCloud contains settings specific to the IBMCloud infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster’s base domain |
|
|
DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster’s base domain |
|
|
Location is where the cluster has been deployed |
|
|
ProviderType indicates the type of cluster that was created |
|
|
ResourceGroupName is the Resource Group for new IBMCloud resources created for the cluster. |
Kubevirt contains settings specific to the kubevirt infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
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 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. |
Nutanix contains settings specific to the Nutanix infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
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. Deprecated: Use APIServerInternalIPs instead. |
|
|
apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
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. Deprecated: Use IngressIPs instead. |
|
|
ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one. |
OpenStack contains settings specific to the OpenStack infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
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. Deprecated: Use APIServerInternalIPs instead. |
|
|
apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
cloudName is the name of the desired OpenStack cloud in the client configuration file ( |
|
|
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. Deprecated: Use IngressIPs instead. |
|
|
ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, |
Ovirt contains settings specific to the oVirt infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
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. Deprecated: Use APIServerInternalIPs instead. |
|
|
apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
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. Deprecated: Use IngressIPs instead. |
|
|
ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release. |
PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
CISInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster’s base domain |
|
|
DNSInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster’s base domain |
|
|
region holds the default Power VS region for new Power VS resources created by the cluster. |
|
|
serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service. |
|
|
PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services. |
|
|
zone holds the default zone for the new Power VS resources created by the cluster. Note: Currently only single-zone OCP clusters are supported |
serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.
array
PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.
object
name
url
Property | Type | Description |
---|---|---|
|
|
name is the name of the Power VS service. Few of the services are IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud |
|
|
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. |
VSphere contains settings specific to the VSphere infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
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. Deprecated: Use APIServerInternalIPs instead. |
|
|
apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
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. Deprecated: Use IngressIPs instead. |
|
|
ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one. |
|
|
nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, |
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
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete collection of Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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. |
|
|
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. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 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 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 |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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. |
|
|
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. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the 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 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 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 |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create an Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the Infrastructure |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete an Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 |
|
|
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. |
|
|
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. |
|
|
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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
GET
read the specified Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the Infrastructure |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
GET
read status of the specified Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update status of the specified Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace status of the specified Infrastructure
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |