Infrastructure holds cluster-wide information about Infrastructure. The canonical name is cluster
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Infrastructure holds cluster-wide information about Infrastructure. The canonical name is cluster
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
object
spec
Property | Type | Description |
---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
spec holds user settable values for configuration |
|
|
status holds observed values from the cluster. They may not be overridden. |
spec holds user settable values for configuration
object
Property | Type | Description |
---|---|---|
|
|
cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap |
|
|
platformSpec holds desired information specific to the underlying infrastructure provider. |
cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.
cloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap kube-cloud-config
in openshift-config-managed
namespace with the kube cloud config is stored in cloud.conf
key. All the clients are expected to use the generated ConfigMap only.
object
Property | Type | Description |
---|---|---|
|
|
Key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references. |
|
|
platformSpec holds desired information specific to the underlying infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. |
|
|
AWS contains settings specific to the Amazon Web Services infrastructure provider. |
|
|
Azure contains settings specific to the Azure infrastructure provider. |
|
|
BareMetal contains settings specific to the BareMetal platform. |
|
|
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider. |
|
|
GCP contains settings specific to the Google Cloud Platform infrastructure provider. |
|
|
IBMCloud contains settings specific to the IBMCloud infrastructure provider. |
|
|
Kubevirt contains settings specific to the kubevirt infrastructure provider. |
|
|
OpenStack contains settings specific to the OpenStack infrastructure provider. |
|
|
Ovirt contains settings specific to the oVirt infrastructure provider. |
|
|
PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider. |
|
|
type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", "PowerVS", "AlibabaCloud" and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform. |
|
|
VSphere contains settings specific to the VSphere infrastructure provider. |
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
object
AWS contains settings specific to the Amazon Web Services infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. |
|
|
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |
serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
array
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
object
Property | Type | Description |
---|---|---|
|
|
name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty. |
|
|
url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |
Azure contains settings specific to the Azure infrastructure provider.
object
BareMetal contains settings specific to the BareMetal platform.
object
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider.
object
GCP contains settings specific to the Google Cloud Platform infrastructure provider.
object
IBMCloud contains settings specific to the IBMCloud infrastructure provider.
object
Kubevirt contains settings specific to the kubevirt infrastructure provider.
object
OpenStack contains settings specific to the OpenStack infrastructure provider.
object
Ovirt contains settings specific to the oVirt infrastructure provider.
object
PowerVS contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.
object
VSphere contains settings specific to the VSphere infrastructure provider.
object
status holds observed values from the cluster. They may not be overridden.
object
Property | Type | Description |
---|---|---|
|
|
apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking. |
|
|
apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API. |
|
|
controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a "normal" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster. |
|
|
etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release. |
|
|
infrastructureName uniquely identifies a cluster with a human friendly name. Once set it should not be changed. Must be of max length 27 and must have only alphanumeric or hyphen characters. |
|
|
infrastructureTopology expresses the expectations for infrastructure services that do not run on control plane nodes, usually indicated by a node selector for a |
|
|
platform is the underlying infrastructure provider for the cluster. Deprecated: Use platformStatus.type instead. |
|
|
platformStatus holds status information specific to the underlying infrastructure provider. |
platformStatus holds status information specific to the underlying infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider. |
|
|
AWS contains settings specific to the Amazon Web Services infrastructure provider. |
|
|
Azure contains settings specific to the Azure infrastructure provider. |
|
|
BareMetal contains settings specific to the BareMetal platform. |
|
|
EquinixMetal contains settings specific to the Equinix Metal infrastructure provider. |
|
|
GCP contains settings specific to the Google Cloud Platform infrastructure provider. |
|
|
IBMCloud contains settings specific to the IBMCloud infrastructure provider. |
|
|
Kubevirt contains settings specific to the kubevirt infrastructure provider. |
|
|
OpenStack contains settings specific to the OpenStack infrastructure provider. |
|
|
Ovirt contains settings specific to the oVirt infrastructure provider. |
|
|
PowerVS contains settings specific to the Power Systems Virtual Servers infrastructure provider. |
|
|
type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "EquinixMetal", "PowerVS", "AlibabaCloud" and "None". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.
This value will be synced with to the |
|
|
VSphere contains settings specific to the VSphere infrastructure provider. |
AlibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.
object
region
resourceGroupID
Property | Type | Description |
---|---|---|
|
|
region specifies the region for Alibaba Cloud resources created for the cluster. |
|
|
resourceGroupID is the ID of the resource group for the cluster. |
|
|
resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster. |
|
|
AlibabaCloudResourceTag is the set of tags to add to apply to resources. |
resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster.
array
AlibabaCloudResourceTag is the set of tags to add to apply to resources.
object
key
value
Property | Type | Description |
---|---|---|
|
|
key is the key of the tag. |
|
|
value is the value of the tag. |
AWS contains settings specific to the Amazon Web Services infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
region holds the default AWS region for new AWS resources created by the cluster. |
|
|
resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user. |
|
|
AWSResourceTag is a tag to apply to AWS resources created for the cluster. |
|
|
ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service. |
|
|
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services. |
resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.
array
AWSResourceTag is a tag to apply to AWS resources created for the cluster.
object
key
value
Property | Type | Description |
---|---|---|
|
|
key is the key of the tag |
|
|
value is the value of the tag. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services. |
ServiceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.
array
AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.
object
Property | Type | Description |
---|---|---|
|
|
name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty. |
|
|
url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. |
Azure contains settings specific to the Azure infrastructure provider.
object
Property | Type | Description |
---|---|---|
|
|
armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack. |
|
|
cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK with the appropriate Azure API endpoints. If empty, the value is equal to |
|
|