Infrastructure [config.openshift.io/v1]

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.

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.

key

string

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

name

string

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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.