Infrastructure [config.openshift.io/v1]

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

alibabaCloud

object

AlibabaCloud contains settings specific to the Alibaba Cloud 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.

external

object

ExternalPlatformType represents generic infrastructure provider. Platform-specific components should be supplemented separately.

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.

nutanix

object

Nutanix contains settings specific to the Nutanix infrastructure provider.

openstack

object

OpenStack contains settings specific to the OpenStack infrastructure provider.

ovirt

object

Ovirt contains settings specific to the oVirt infrastructure provider.

powervs

object

PowerVS contains settings specific to the IBM Power Systems Virtual Servers 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", "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

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.

platformName

string

PlatformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. This field is solely for informational and reporting purposes and is not expected to be used for decision-making.

failureDomains

array

failureDomains configures failure domains information for the Nutanix platform. When set, the failure domains defined here may be used to spread Machines across prism element clusters to improve fault tolerance of the cluster.

failureDomains[]

object

NutanixFailureDomain configures failure domain information for the Nutanix platform.

prismCentral

object

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

array

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.

prismElements[]

object

NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster)

cluster

object

cluster is to identify the cluster (the Prism Element under management of the Prism Central), in which the Machine’s VM will be created. The cluster identifier (uuid or name) can be obtained from the Prism Central console or using the prism_central API.

name

string

name defines the unique name of a failure domain. Name is required and must be at most 64 characters in length. It must consist of only lower case alphanumeric characters and hyphens (-). It must start and end with an alphanumeric character. This value is arbitrary and is used to identify the failure domain within the platform.

subnets

array

subnets holds a list of identifiers (one or more) of the cluster’s network subnets for the Machine’s VM to connect to. The subnet identifiers (uuid or name) can be obtained from the Prism Central console or using the prism_central API.

subnets[]

object

NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.)

name

string

name is the resource name in the PC. It cannot be empty if the type is Name.

type

string

type is the identifier type to use for this resource.

uuid

string

uuid is the UUID of the resource in the PC. It cannot be empty if the type is UUID.

name

string

name is the resource name in the PC. It cannot be empty if the type is Name.

type

string

type is the identifier type to use for this resource.

uuid

string

uuid is the UUID of the resource in the PC. It cannot be empty if the type is UUID.

address

string

address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster)

port

integer

port is the port number to access the Nutanix Prism Central or Element (cluster)

endpoint

object

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

string

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).

address

string

address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster)

port

integer

port is the port number to access the Nutanix Prism Central or Element (cluster)

serviceEndpoints

array

serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.

serviceEndpoints[]

object

PowervsserviceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS services.

name

string

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

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.

failureDomains

array

failureDomains contains the definition of region, zone and the vCenter topology. If this is omitted failure domains (regions and zones) will not be used.

failureDomains[]

object

VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain.

nodeNetworking

object

nodeNetworking contains the definition of internal and external network constraints for assigning the node’s networking. If this field is omitted, networking defaults to the legacy address selection behavior which is to only support a single address and return the first one found.

vcenters

array

vcenters holds the connection details for services to communicate with vCenter. Currently, only a single vCenter is supported. ---

vcenters[]

object

VSpherePlatformVCenterSpec stores the vCenter connection fields. This is used by the vSphere CCM.

name

string

name defines the arbitrary but unique name of a failure domain.

region

string

region defines the name of a region tag that will be attached to a vCenter datacenter. The tag category in vCenter must be named openshift-region.

server

string

server is the fully-qualified domain name or the IP address of the vCenter server. ---

topology

object

Topology describes a given failure domain using vSphere constructs

zone

string

zone defines the name of a zone tag that will be attached to a vCenter cluster. The tag category in vCenter must be named openshift-zone.

computeCluster

string

computeCluster the absolute path of the vCenter cluster in which virtual machine will be located. The absolute path is of the form /<datacenter>/host/<cluster>. The maximum length of the path is 2048 characters.

datacenter

string

datacenter is the name of vCenter datacenter in which virtual machines will be located. The maximum length of the datacenter name is 80 characters.

datastore

string

datastore is the absolute path of the datastore in which the virtual machine is located. The absolute path is of the form /<datacenter>/datastore/<datastore> The maximum length of the path is 2048 characters.

folder

string

folder is the absolute path of the folder where virtual machines are located. The absolute path is of the form /<datacenter>/vm/<folder>. The maximum length of the path is 2048 characters.

networks

array (string)

networks is the list of port group network names within this failure domain. Currently, we only support a single interface per RHCOS virtual machine. The available networks (port groups) can be listed using govc ls 'network/*' The single interface should be the absolute path of the form /<datacenter>/network/<portgroup>.

resourcePool

string

resourcePool is the absolute path of the resource pool where virtual machines will be created. The absolute path is of the form /<datacenter>/host/<cluster>/Resources/<resourcepool>. The maximum length of the path is 2048 characters.

external

object

external represents the network configuration of the node that is externally routable.

internal

object

internal represents the network configuration of the node that is routable only within the cluster.

excludeNetworkSubnetCidr

array (string)

excludeNetworkSubnetCidr IP addresses in subnet ranges will be excluded when selecting the IP address from the VirtualMachine’s VM for use in the status.addresses fields. ---

network

string

network VirtualMachine’s VM Network names that will be used to when searching for status.addresses fields. Note that if internal.networkSubnetCIDR and external.networkSubnetCIDR are not set, then the vNIC associated to this network must only have a single IP address assigned to it. The available networks (port groups) can be listed using govc ls 'network/*'

networkSubnetCidr

array (string)

networkSubnetCidr IP address on VirtualMachine’s network interfaces included in the fields' CIDRs that will be used in respective status.addresses fields. ---

excludeNetworkSubnetCidr

array (string)

excludeNetworkSubnetCidr IP addresses in subnet ranges will be excluded when selecting the IP address from the VirtualMachine’s VM for use in the status.addresses fields. ---

network

string

network VirtualMachine’s VM Network names that will be used to when searching for status.addresses fields. Note that if internal.networkSubnetCIDR and external.networkSubnetCIDR are not set, then the vNIC associated to this network must only have a single IP address assigned to it. The available networks (port groups) can be listed using govc ls 'network/*'

networkSubnetCidr

array (string)

networkSubnetCidr IP address on VirtualMachine’s network interfaces included in the fields' CIDRs that will be used in respective status.addresses fields. ---

datacenters

array (string)

The vCenter Datacenters in which the RHCOS vm guests are located. This field will be used by the Cloud Controller Manager. Each datacenter listed here should be used within a topology.

port

integer

port is the TCP port that will be used to communicate to the vCenter endpoint. When omitted, this means the user has no opinion and it is up to the platform to choose a sensible default, which is subject to change over time.

server

string

server is the fully-qualified domain name or the IP address of the vCenter server. ---

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 The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster.

cpuPartitioning

string

cpuPartitioning expresses if CPU partitioning is a currently enabled feature in the cluster. CPU Partitioning means that this cluster can support partitioning workloads to specific CPU Sets. Valid values are "None" and "AllNodes". When omitted, the default value is "None". The default value of "None" indicates that no nodes will be setup with CPU partitioning. The "AllNodes" value indicates that all nodes have been setup with CPU partitioning, and can then be further configured via the PerformanceProfile API.

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 NOTE: External topology mode is not applicable for this field.

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.

alibabaCloud

object

AlibabaCloud contains settings specific to the Alibaba Cloud 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.

external

object

External contains settings specific to the generic External 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.

nutanix

object

Nutanix contains settings specific to the Nutanix infrastructure provider.

openstack

object

OpenStack contains settings specific to the OpenStack infrastructure provider.

ovirt

object

Ovirt contains settings specific to the oVirt infrastructure provider.

powervs

object

PowerVS contains settings specific to the Power Systems Virtual Servers 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", "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 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 specifies the region for Alibaba Cloud resources created for the cluster.

resourceGroupID

string

resourceGroupID is the ID of the resource group for the cluster.

resourceTags

array

resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster.

resourceTags[]

object

AlibabaCloudResourceTag is the set of tags to add to apply to resources.

key

string

key is the key of the tag.

value

string

value is the value of the tag.

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.

armEndpoint

string

armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack.

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.

resourceTags

array

resourceTags is a list of additional tags to apply to Azure resources created for the cluster. See https://docs.microsoft.com/en-us/rest/api/resources/tags for information on tagging Azure resources. Due to limitations on Automation, Content Delivery Network, DNS Azure resources, a maximum of 15 tags may be applied. OpenShift reserves 5 tags for internal use, allowing 10 tags for user configuration.

resourceTags[]

object

AzureResourceTag is a tag to apply to Azure resources created for the cluster.

key

string

key is the key part of the tag. A tag key can have a maximum of 128 characters and cannot be empty. Key must begin with a letter, end with a letter, number or underscore, and must contain only alphanumeric characters and the following special characters _ . -.

value

string

value is the value part of the tag. A tag value can have a maximum of 256 characters and cannot be empty. Value must contain only alphanumeric characters and the following special characters _ + , - . / : ; < = > ? @.

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. Deprecated: Use APIServerInternalIPs instead.

apiServerInternalIPs

array (string)

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

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. Deprecated: Use IngressIPs instead.

ingressIPs

array (string)

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

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.

cloudControllerManager

object

cloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI). When omitted, new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.

state

string

state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager Valid values are "External", "None" and omitted. When set to "External", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to "None", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.

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.

cisInstanceCRN

string

CISInstanceCRN is the CRN of the Cloud Internet services instance managing the DNS zone for the cluster’s base domain

dnsInstanceCRN

string

DNSInstanceCRN is the CRN of the DNS services instance managing the DNS zone for the cluster’s base domain

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.

serviceEndpoints

array

serviceEndpoints is a list of custom endpoints which will override the default service endpoints of an IBM Cloud service. These endpoints are consumed by components within the cluster to reach the respective IBM Cloud services.

serviceEndpoints[]

object

IBMCloudserviceEndpoint stores the configuration of a custom url to override existing defaults of IBM Cloud services.

name

string

name is the name of the IBM Cloud service. Possible values are: CIS, COS, DNSservices, GlobalSearch, GlobalTagging, HyperProtect, IAM, KeyProtect, ResourceController, ResourceManager, or VPC. For example, the IBM Cloud Private IAM service could be configured with the service name of IAM and url of https://private.iam.cloud.ibm.com Whereas the IBM Cloud Private VPC service for US South (Dallas) could be configured with the service name of VPC and url of https://us.south.private.iaas.cloud.ibm.com

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.

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. Deprecated: Use APIServerInternalIPs instead.

apiServerInternalIPs

array (string)

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

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. Deprecated: Use IngressIPs instead.

ingressIPs

array (string)

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.

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. Deprecated: Use APIServerInternalIPs instead.

apiServerInternalIPs

array (string)

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

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. Deprecated: Use IngressIPs instead.

ingressIPs

array (string)

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.

loadBalancer

object

loadBalancer defines how the load balancer used by the cluster is configured.

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.

type

string

type defines the type of load balancer used by the cluster on OpenStack platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.

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. Deprecated: Use APIServerInternalIPs instead.

apiServerInternalIPs

array (string)

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

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. Deprecated: Use IngressIPs instead.

ingressIPs

array (string)

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

string

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

cisInstanceCRN

string

CISInstanceCRN is the CRN of the Cloud Internet services instance managing the DNS zone for the cluster’s base domain

dnsInstanceCRN

string

DNSInstanceCRN is the CRN of the DNS services instance managing the DNS zone for the cluster’s base domain

region

string

region holds the default Power VS region for new Power VS resources created by the cluster.

resourceGroup

string

resourceGroup is the resource group name for new IBMCloud resources created for a cluster. The resource group specified here will be used by cluster-image-registry-operator to set up a COS Instance in IBMCloud for the cluster registry. More about resource groups can be found here: https://cloud.ibm.com/docs/account?topic=account-rgs. When omitted, the image registry operator won’t be able to configure storage, which results in the image registry cluster operator not being in an available state.

serviceEndpoints

array

serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.

serviceEndpoints[]

object

PowervsserviceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS services.

zone

string

zone holds the default zone for the new Power VS resources created by the cluster. Note: Currently only single-zone OCP clusters are supported

name

string

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

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.

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. Deprecated: Use APIServerInternalIPs instead.

apiServerInternalIPs

array (string)

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

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. Deprecated: Use IngressIPs instead.

ingressIPs

array (string)

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

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.

200 - OK

Status schema

401 - Unauthorized

Empty

200 - OK

InfrastructureList schema

401 - Unauthorized

Empty

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

Infrastructure schema

200 - OK

Infrastructure schema

201 - Created

Infrastructure schema

202 - Accepted

Infrastructure schema

401 - Unauthorized

Empty

name

string

name of the Infrastructure

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

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

200 - OK

Infrastructure schema

401 - Unauthorized

Empty

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

Infrastructure schema

401 - Unauthorized

Empty

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

Infrastructure schema

200 - OK

Infrastructure schema

201 - Created

Infrastructure schema

401 - Unauthorized

Empty

name

string

name of the Infrastructure

200 - OK

Infrastructure schema

401 - Unauthorized

Empty