Infrastructure [config.openshift.io/v1]
- Description
-
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).
- Type
`object`- Required
-
Specification
| Property |
Type |
Description |
apiVersion |
string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kind |
string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata |
ObjectMeta |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
spec |
object |
spec holds user settable values for configuration |
status |
object |
status holds observed values from the cluster. They may not be overridden. |
.spec
- Description
- spec holds user settable values for configuration
- Type
`object`
| Property |
Type |
Description |
cloudConfig |
object |
cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap kube-cloud-config in openshift-config-managed namespace with the kube cloud config is stored in cloud.conf key. All the clients are expected to use the generated ConfigMap only. |
platformSpec |
object |
platformSpec holds desired information specific to the underlying infrastructure provider. |
.spec.cloudConfig
- Description
-
cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap kube-cloud-config in openshift-config-managed namespace with the kube cloud config is stored in cloud.conf key. All the clients are expected to use the generated ConfigMap only.
- Type
`object`
| Property |
Type |
Description |
key |
string |
key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. |
name |
string |
|
- Description
- platformSpec holds desired information specific to the underlying infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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", "IBMCloud", "KubeVirt", "EquinixMetal", "PowerVS", "AlibabaCloud", "Nutanix", "External", 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. |
- Description
- alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
- Type
`object`
- Description
- aws contains settings specific to the Amazon Web Services infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
serviceEndpoints |
array |
serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. |
serviceEndpoints[] |
object |
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |
- Description
- serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
- Type
`array`
- Description
- AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
- Type
`object`
| Property |
Type |
Description |
name |
string |
name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty. |
url |
string |
url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |
- Description
- azure contains settings specific to the Azure infrastructure provider.
- Type
`object`
- Description
- baremetal contains settings specific to the BareMetal platform.
- Type
`object`
| Property |
Type |
Description |
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 IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can). |
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 IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can). |
machineNetworks |
array (string) |
machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example "10.0.0.0/8" or "fd00::/8". |
- Description
- equinixMetal contains settings specific to the Equinix Metal infrastructure provider.
- Type
`object`
- Description
- ExternalPlatformType represents generic infrastructure provider. Platform-specific components should be supplemented separately.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- gcp contains settings specific to the Google Cloud Platform infrastructure provider.
- Type
`object`
- Description
- ibmcloud contains settings specific to the IBMCloud infrastructure provider.
- Type
`object`
- Description
- kubevirt contains settings specific to the kubevirt infrastructure provider.
- Type
`object`
- Description
- nutanix contains settings specific to the Nutanix infrastructure provider.
- Type
`object`- Required
-
prismCentralprismElements
| Property |
Type |
Description |
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) |
.spec.platformSpec.nutanix.failureDomains
- Description
- 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.
- Type
`array`
.spec.platformSpec.nutanix.failureDomains[]
- Description
- NutanixFailureDomain configures failure domain information for the Nutanix platform.
- Type
`object`- Required
-
| Property |
Type |
Description |
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 If the feature gate NutanixMultiSubnets is enabled, up to 32 subnets may be configured. 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.) |
.spec.platformSpec.nutanix.failureDomains[].cluster
- Description
- 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.
- Type
`object`- Required
-
| Property |
Type |
Description |
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. |
.spec.platformSpec.nutanix.failureDomains[].subnets
- Description
- subnets holds a list of identifiers (one or more) of the cluster’s network subnets If the feature gate NutanixMultiSubnets is enabled, up to 32 subnets may be configured. 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.
- Type
`array`
.spec.platformSpec.nutanix.failureDomains[].subnets[]
- Description
- NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.)
- Type
`object`- Required
-
| Property |
Type |
Description |
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. |
- 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.
- Type
`object`- Required
-
| Property |
Type |
Description |
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) |
- Description
- 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.
- Type
`array`
- Description
- NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster)
- Type
`object`- Required
-
| Property |
Type |
Description |
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). |
- 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.
- Type
`object`- Required
-
| Property |
Type |
Description |
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) |
- Description
- openstack contains settings specific to the OpenStack infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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 IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can). |
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 IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can). |
machineNetworks |
array (string) |
machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example "10.0.0.0/8" or "fd00::/8". |
- Description
- ovirt contains settings specific to the oVirt infrastructure provider.
- Type
`object`
- Description
- powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.
- Type
`array`
- Description
- PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.
- Type
`object`- Required
-
| Property |
Type |
Description |
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. |
- Description
- vsphere contains settings specific to the VSphere infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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 IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can). |
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. |
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 IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can). |
machineNetworks |
array (string) |
machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example "10.0.0.0/8" or "fd00::/8". |
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, but in tech preview 3 vCenters are supported. Once the cluster has been installed, you are unable to change the current number of defined vCenters except in the case where the cluster has been upgraded from a version of OpenShift where the vsphere platform spec was not present. You may make modifications to the existing vCenters that are defined in the vcenters list in order to match with any added or modified failure domains. |
vcenters[] |
object |
VSpherePlatformVCenterSpec stores the vCenter connection fields. This is used by the vSphere CCM. |
.spec.platformSpec.vsphere.failureDomains
- Description
- failureDomains contains the definition of region, zone and the vCenter topology. If this is omitted failure domains (regions and zones) will not be used.
- Type
`array`
.spec.platformSpec.vsphere.failureDomains[]
- Description
- VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain.
- Type
`object`- Required
-
nameregionservertopologyzone
| Property |
Type |
Description |
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. |
regionAffinity |
object |
regionAffinity holds the type of region, Datacenter or ComputeCluster. When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology. When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology. |
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. |
zoneAffinity |
object |
zoneAffinity holds the type of the zone and the hostGroup which vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter. |
.spec.platformSpec.vsphere.failureDomains[].regionAffinity
- Description
- regionAffinity holds the type of region, Datacenter or ComputeCluster. When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology. When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology.
- Type
`object`- Required
-
| Property |
Type |
Description |
type |
string |
type determines the vSphere object type for a region within this failure domain. Available types are Datacenter and ComputeCluster. When set to Datacenter, this means the vCenter Datacenter defined is the region. When set to ComputeCluster, this means the vCenter cluster defined is the region. |
.spec.platformSpec.vsphere.failureDomains[].topology
- Description
- topology describes a given failure domain using vSphere constructs
- Type
`object`- Required
-
computeClusterdatacenterdatastorenetworks
| Property |
Type |
Description |
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. If feature gate VSphereMultiNetworks is enabled, up to 10 network adapters may be defined. 10 is the maximum number of virtual network devices which may be attached to a VM as defined by: https://configmax.esp.vmware.com/guest?vmwareproduct=vSphere&release=vSphere%208.0&categories=1-0 The available networks (port groups) can be listed using govc ls 'network/*' Networks should be in the form of an absolute path: /<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. |
template |
string |
template is the full inventory path of the virtual machine or template that will be cloned when creating new machines in this failure domain. The maximum length of the path is 2048 characters.
When omitted, the template will be calculated by the control plane machineset operator based on the region and zone defined in VSpherePlatformFailureDomainSpec. For example, for zone=zonea, region=region1, and infrastructure name=test, the template path would be calculated as /<datacenter>/vm/test-rhcos-region1-zonea. |
.spec.platformSpec.vsphere.failureDomains[].zoneAffinity
- Description
- zoneAffinity holds the type of the zone and the hostGroup which vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.
- Type
`object`- Required
-
| Property |
Type |
Description |
hostGroup |
object |
hostGroup holds the vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter. |
type |
string |
type determines the vSphere object type for a zone within this failure domain. Available types are ComputeCluster and HostGroup. When set to ComputeCluster, this means the vCenter cluster defined is the zone. When set to HostGroup, hostGroup must be configured with hostGroup, vmGroup and vmHostRule and this means the zone is defined by the grouping of those fields. |
.spec.platformSpec.vsphere.failureDomains[].zoneAffinity.hostGroup
- Description
- hostGroup holds the vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.
- Type
`object`- Required
-
hostGroupvmGroupvmHostRule
| Property |
Type |
Description |
hostGroup |
string |
hostGroup is the name of the vm-host group of type host within vCenter for this failure domain. hostGroup is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup |
vmGroup |
string |
vmGroup is the name of the vm-host group of type virtual machine within vCenter for this failure domain. vmGroup is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup |
vmHostRule |
string |
vmHostRule is the name of the affinity vm-host rule within vCenter for this failure domain. vmHostRule is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup |
- Description
- 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.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- external represents the network configuration of the node that is externally routable.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- internal represents the network configuration of the node that is routable only within the cluster.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- vcenters holds the connection details for services to communicate with vCenter. Currently, only a single vCenter is supported, but in tech preview 3 vCenters are supported. Once the cluster has been installed, you are unable to change the current number of defined vCenters except in the case where the cluster has been upgraded from a version of OpenShift where the vsphere platform spec was not present. You may make modifications to the existing vCenters that are defined in the vcenters list in order to match with any added or modified failure domains.
- Type
`array`
- Description
- VSpherePlatformVCenterSpec stores the vCenter connection fields. This is used by the vSphere CCM.
- Type
`object`- Required
-
| Property |
Type |
Description |
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. |
.status
- Description
- status holds observed values from the cluster. They may not be overridden.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalURI |
string |
apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking. |
apiServerURL |
string |
apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API. |
controlPlaneTopology |
string |
controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a "normal" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster. The 'HighlyAvailableArbiter' mode indicates that the control plane will consist of 2 control-plane nodes that run conventional services and 1 smaller sized arbiter node that runs a bare minimum of services to maintain quorum. |
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. |
- Description
- platformStatus holds status information specific to the underlying infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
- Type
`object`- Required
-
| Property |
Type |
Description |
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. |
- Description
- resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster.
- Type
`array`
- Description
- AlibabaCloudResourceTag is the set of tags to add to apply to resources.
- Type
`object`- Required
-
| Property |
Type |
Description |
key |
string |
key is the key of the tag. |
value |
string |
value is the value of the tag. |
- Description
- aws contains settings specific to the Amazon Web Services infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
region |
string |
region holds the default AWS region for new AWS resources created by the cluster. |
resourceTags |
array |
resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user. |
resourceTags[] |
object |
AWSResourceTag is a tag to apply to AWS resources created for the cluster. |
serviceEndpoints |
array |
serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. |
serviceEndpoints[] |
object |
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |
- Description
- resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.
- Type
`array`
- Description
- AWSResourceTag is a tag to apply to AWS resources created for the cluster.
- Type
`object`- Required
-
| Property |
Type |
Description |
key |
string |
key sets the key of the AWS resource tag key-value pair. Key is required when defining an AWS resource tag. Key should consist of between 1 and 128 characters, and may contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'. |
value |
string |
value sets the value of the AWS resource tag key-value pair. Value is required when defining an AWS resource tag. Value should consist of between 1 and 256 characters, and may contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'. 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. |
- Description
- serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
- Type
`array`
- Description
- AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
- Type
`object`
| Property |
Type |
Description |
name |
string |
name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty. |
url |
string |
url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |
- Description
- azure contains settings specific to the Azure infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
armEndpoint |
string |
armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack. |
cloudLoadBalancerConfig |
object |
cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer. |
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. |
- Description
- cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer.
- Type
`object`
| Property |
Type |
Description |
clusterHosted |
object |
clusterHosted holds the IP addresses of API, API-Int and Ingress Load Balancers on Cloud Platforms. The DNS solution hosted within the cluster use these IP addresses to provide resolution for API, API-Int and Ingress services. |
dnsType |
string |
dnsType indicates the type of DNS solution in use within the cluster. Its default value of PlatformDefault indicates that the cluster’s DNS is the default provided by the cloud platform. It can be set to ClusterHosted to bypass the configuration of the cloud default DNS. In this mode, the cluster needs to provide a self-hosted DNS solution for the cluster’s installation to succeed. The cluster’s use of the cloud’s Load Balancers is unaffected by this setting. The value is immutable after it has been set at install time. Currently, there is no way for the customer to add additional DNS entries into the cluster hosted DNS. Enabling this functionality allows the user to start their own DNS solution outside the cluster after installation is complete. The customer would be responsible for configuring this custom DNS solution, and it can be run in addition to the in-cluster DNS solution. |
- Description
- clusterHosted holds the IP addresses of API, API-Int and Ingress Load Balancers on Cloud Platforms. The DNS solution hosted within the cluster use these IP addresses to provide resolution for API, API-Int and Ingress services.
- Type
`object`
| Property |
Type |
Description |
apiIntLoadBalancerIPs |
array (string) |
apiIntLoadBalancerIPs holds Load Balancer IPs for the internal API service. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Entries in the apiIntLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted. |
apiLoadBalancerIPs |
array (string) |
apiLoadBalancerIPs holds Load Balancer IPs for the API service. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Could be empty for private clusters. Entries in the apiLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted. |
ingressLoadBalancerIPs |
array (string) |
ingressLoadBalancerIPs holds IPs for Ingress Load Balancers. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Entries in the ingressLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted. |
- Description
- 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.
- Type
`array`
- Description
- AzureResourceTag is a tag to apply to Azure resources created for the cluster.
- Type
`object`- Required
-
| Property |
Type |
Description |
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 _ + , - . / : ; < = > ? @. |
- Description
- baremetal contains settings specific to the BareMetal platform.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalIP |
string |
apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
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. |
loadBalancer |
object |
loadBalancer defines how the load balancer used by the cluster is configured. |
machineNetworks |
array (string) |
machineNetworks are IP networks used to connect all the OpenShift cluster nodes. |
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. |
- Description
- loadBalancer defines how the load balancer used by the cluster is configured.
- Type
`object`
| Property |
Type |
Description |
type |
string |
type defines the type of load balancer used by the cluster on BareMetal 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. |
- Description
- equinixMetal contains settings specific to the Equinix Metal infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalIP |
string |
apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers. |
ingressIP |
string |
ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names. |
- Description
- external contains settings specific to the generic External infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- 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.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- gcp contains settings specific to the Google Cloud Platform infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
cloudLoadBalancerConfig |
`` |
cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer. |
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. |
resourceLabels |
array |
resourceLabels is a list of additional labels to apply to GCP resources created for the cluster. See https://cloud.google.com/compute/docs/labeling-resources for information on labeling GCP resources. GCP supports a maximum of 64 labels per resource. OpenShift reserves 32 labels for internal use, allowing 32 labels for user configuration. |
resourceLabels[] |
object |
GCPResourceLabel is a label to apply to GCP resources created for the cluster. |
resourceTags |
array |
resourceTags is a list of additional tags to apply to GCP resources created for the cluster. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for information on tagging GCP resources. GCP supports a maximum of 50 tags per resource. |
resourceTags[] |
object |
GCPResourceTag is a tag to apply to GCP resources created for the cluster. |
- Description
- resourceLabels is a list of additional labels to apply to GCP resources created for the cluster. See https://cloud.google.com/compute/docs/labeling-resources for information on labeling GCP resources. GCP supports a maximum of 64 labels per resource. OpenShift reserves 32 labels for internal use, allowing 32 labels for user configuration.
- Type
`array`
- Description
- GCPResourceLabel is a label to apply to GCP resources created for the cluster.
- Type
`object`- Required
-
| Property |
Type |
Description |
key |
string |
key is the key part of the label. A label key can have a maximum of 63 characters and cannot be empty. Label key must begin with a lowercase letter, and must contain only lowercase letters, numeric characters, and the following special characters _-. Label key must not have the reserved prefixes kubernetes-io and openshift-io. |
value |
string |
value is the value part of the label. A label value can have a maximum of 63 characters and cannot be empty. Value must contain only lowercase letters, numeric characters, and the following special characters _-. |
- Description
- resourceTags is a list of additional tags to apply to GCP resources created for the cluster. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for information on tagging GCP resources. GCP supports a maximum of 50 tags per resource.
- Type
`array`
- Description
- GCPResourceTag is a tag to apply to GCP resources created for the cluster.
- Type
`object`- Required
-
| Property |
Type |
Description |
key |
string |
key is the key part of the tag. A tag key can have a maximum of 63 characters and cannot be empty. Tag key must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters ._-. |
parentID |
string |
parentID is the ID of the hierarchical resource where the tags are defined, e.g. at the Organization or the Project level. To find the Organization or Project ID refer to the following pages: https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id, https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects. An OrganizationID must consist of decimal numbers, and cannot have leading zeroes. A ProjectID must be 6 to 30 characters in length, can only contain lowercase letters, numbers, and hyphens, and must start with a letter, and cannot end with a hyphen. |
value |
string |
value is the value part of the tag. A tag value can have a maximum of 63 characters and cannot be empty. Tag value must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters _-.@%=+:,*#&(){}[] and spaces. |
- Description
- ibmcloud contains settings specific to the IBMCloud infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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 service. These endpoints are used by components within the cluster when trying to reach the IBM Cloud Services that have been overridden. The CCCMO reads in the IBMCloudPlatformSpec and validates each endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus are updated to reflect the same custom endpoints. |
serviceEndpoints[] |
object |
IBMCloudServiceEndpoint stores the configuration of a custom url to override existing defaults of IBM Cloud Services. |
- Description
- serviceEndpoints is a list of custom endpoints which will override the default service endpoints of an IBM service. These endpoints are used by components within the cluster when trying to reach the IBM Cloud Services that have been overridden. The CCCMO reads in the IBMCloudPlatformSpec and validates each endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus are updated to reflect the same custom endpoints.
- Type
`array`
- Description
- IBMCloudServiceEndpoint stores the configuration of a custom url to override existing defaults of IBM Cloud Services.
- Type
`object`- Required
-
| Property |
Type |
Description |
name |
string |
name is the name of the IBM Cloud service. Possible values are: CIS, COS, COSConfig, DNSServices, GlobalCatalog, 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. The path must follow the pattern /v[0,9]+ or /api/v[0,9]+ |
- Description
- kubevirt contains settings specific to the kubevirt infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalIP |
string |
apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers. |
ingressIP |
string |
ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names. |
- Description
- nutanix contains settings specific to the Nutanix infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalIP |
string |
apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
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. |
loadBalancer |
object |
loadBalancer defines how the load balancer used by the cluster is configured. |
- Description
- loadBalancer defines how the load balancer used by the cluster is configured.
- Type
`object`
| Property |
Type |
Description |
type |
string |
type defines the type of load balancer used by the cluster on Nutanix 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. |
- Description
- openstack contains settings specific to the OpenStack infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalIP |
string |
apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
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. |
machineNetworks |
array (string) |
machineNetworks are IP networks used to connect all the OpenShift cluster nodes. |
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. |
- Description
- loadBalancer defines how the load balancer used by the cluster is configured.
- Type
`object`
| Property |
Type |
Description |
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. |
- Description
- ovirt contains settings specific to the oVirt infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalIP |
string |
apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
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. |
loadBalancer |
object |
loadBalancer defines how the load balancer used by the cluster is configured. |
nodeDNSIP |
string |
deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release. |
- Description
- loadBalancer defines how the load balancer used by the cluster is configured.
- Type
`object`
| Property |
Type |
Description |
type |
string |
type defines the type of load balancer used by the cluster on Ovirt 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. |
- Description
- powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
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 |
- Description
- serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.
- Type
`array`
- Description
- PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.
- Type
`object`- Required
-
| Property |
Type |
Description |
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. |
- Description
- vsphere contains settings specific to the VSphere infrastructure provider.
- Type
`object`
| Property |
Type |
Description |
apiServerInternalIP |
string |
apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.
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. |
loadBalancer |
object |
loadBalancer defines how the load balancer used by the cluster is configured. |
machineNetworks |
array (string) |
machineNetworks are IP networks used to connect all the OpenShift cluster nodes. |
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. |
- Description
- loadBalancer defines how the load balancer used by the cluster is configured.
- Type
`object`
| Property |
Type |
Description |
type |
string |
type defines the type of load balancer used by the cluster on VSphere 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. |
API endpoints
The following API endpoints are available:
-
/apis/config.openshift.io/v1/infrastructures
DELETE: delete collection of InfrastructureGET: list objects of kind InfrastructurePOST: create an Infrastructure
-
/apis/config.openshift.io/v1/infrastructures/{name}
DELETE: delete an InfrastructureGET: read the specified InfrastructurePATCH: partially update the specified InfrastructurePUT: replace the specified Infrastructure
-
/apis/config.openshift.io/v1/infrastructures/{name}/status
GET: read status of the specified InfrastructurePATCH: partially update status of the specified InfrastructurePUT: replace status of the specified Infrastructure
/apis/config.openshift.io/v1/infrastructures
- HTTP method
`DELETE`- Description
delete collection of Infrastructure
HTTP responses
| HTTP code |
Reponse body |
| 200 - OK |
Status schema |
| 401 - Unauthorized |
Empty |
- HTTP method
`GET`- Description
list objects of kind Infrastructure
HTTP responses
- HTTP method
`POST`- Description
create an Infrastructure
Query parameters
| Parameter |
Type |
Description |
dryRun |
string |
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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 parameters
HTTP responses
/apis/config.openshift.io/v1/infrastructures/{name}
Global path parameters
| Parameter |
Type |
Description |
name |
string |
name of the Infrastructure |
- HTTP method
`DELETE`- Description
delete an Infrastructure
Query parameters
| Parameter |
Type |
Description |
dryRun |
string |
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
HTTP responses
| HTTP code |
Reponse body |
| 200 - OK |
Status schema |
| 202 - Accepted |
Status schema |
| 401 - Unauthorized |
Empty |
- HTTP method
`GET`- Description
read the specified Infrastructure
HTTP responses
| HTTP code |
Reponse body |
| 200 - OK |
Infrastructure schema |
| 401 - Unauthorized |
Empty |
- HTTP method
`PATCH`- Description
partially update the specified Infrastructure
Query parameters
| Parameter |
Type |
Description |
dryRun |
string |
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
HTTP responses
| HTTP code |
Reponse body |
| 200 - OK |
Infrastructure schema |
| 401 - Unauthorized |
Empty |
- HTTP method
`PUT`- Description
replace the specified Infrastructure
Query parameters
| Parameter |
Type |
Description |
dryRun |
string |
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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 parameters
HTTP responses
/apis/config.openshift.io/v1/infrastructures/{name}/status
Global path parameters
| Parameter |
Type |
Description |
name |
string |
name of the Infrastructure |
- HTTP method
`GET`- Description
read status of the specified Infrastructure
HTTP responses
| HTTP code |
Reponse body |
| 200 - OK |
Infrastructure schema |
| 401 - Unauthorized |
Empty |
- HTTP method
`PATCH`- Description
partially update status of the specified Infrastructure
Query parameters
| Parameter |
Type |
Description |
dryRun |
string |
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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. |
HTTP responses
| HTTP code |
Reponse body |
| 200 - OK |
Infrastructure schema |
| 401 - Unauthorized |
Empty |
- HTTP method
`PUT`- Description
replace status of the specified Infrastructure
Query parameters
| Parameter |
Type |
Description |
dryRun |
string |
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
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 parameters
HTTP responses