String
Before you deploy an OKD cluster, you provide a customized install-config.yaml
installation configuration file that describes the details for your environment.
The following tables specify the required, optional, and bare metal-specific installation configuration parameters that you can set as part of the installation process.
After installation, you cannot modify these parameters in the |
Required installation configuration parameters are described in the following table:
Parameter | Description | Values |
---|---|---|
apiVersion: |
The API version for the |
String |
baseDomain: |
The base domain of your cloud provider. The base domain is used to create routes to your OKD cluster components. The full DNS name for your cluster is a combination of the |
A fully-qualified domain or subdomain name, such as |
metadata: |
Kubernetes resource |
Object |
metadata: name: |
The name of the cluster. DNS records for the cluster are all subdomains of |
String of lowercase letters and hyphens ( |
platform: |
The configuration for the specific platform upon which to perform the installation: |
Object |
You can customize your installation configuration based on the requirements of your existing network infrastructure. For example, you can expand the IP address block for the cluster network or provide different IP address blocks than the defaults.
Consider the following information before you configure network parameters for your cluster:
If you use the Red Hat OpenShift Networking OVN-Kubernetes network plugin, both IPv4 and IPv6 address families are supported.
If you deployed nodes in an OKD cluster with a network that supports both IPv4 and non-link-local IPv6 addresses, configure your cluster to use a dual-stack network.
For clusters configured for dual-stack networking, both IPv4 and IPv6 traffic must use the same network interface as the default gateway. This ensures that in a multiple network interface controller (NIC) environment, a cluster can detect what NIC to use based on the available network interface. For more information, see "OVN-Kubernetes IPv6 and dual-stack limitations" in About the OVN-Kubernetes network plugin.
To prevent network connectivity issues, do not install a single-stack IPv4 cluster on a host that supports dual-stack networking.
If you configure your cluster to use both IP address families, review the following requirements:
Both IP families must use the same network interface for the default gateway.
Both IP families must have the default gateway.
You must specify IPv4 and IPv6 addresses in the same order for all network configuration parameters. For example, in the following configuration IPv4 addresses are listed before IPv6 addresses.
networking:
clusterNetwork:
- cidr: 10.128.0.0/14
hostPrefix: 23
- cidr: fd00:10:128::/56
hostPrefix: 64
serviceNetwork:
- 172.30.0.0/16
- fd00:172:16::/112
Globalnet is not supported with Red Hat OpenShift Data Foundation disaster recovery solutions. For regional disaster recovery scenarios, ensure that you use a nonoverlapping range of private IP addresses for the cluster and service networks in each cluster. |
Parameter | Description | Values | ||
---|---|---|---|---|
networking: |
The configuration for the cluster network. |
Object
|
||
networking: networkType: |
The Red Hat OpenShift Networking network plugin to install. |
|
||
networking: clusterNetwork: |
The IP address blocks for pods. The default value is If you specify multiple IP address blocks, the blocks must not overlap. |
An array of objects. For example:
|
||
networking: clusterNetwork: cidr: |
Required if you use If you use the OVN-Kubernetes network plugin, you can specify IPv4 and IPv6 networks. |
An IP address block in Classless Inter-Domain Routing (CIDR) notation.
The prefix length for an IPv4 block is between |
||
networking: clusterNetwork: hostPrefix: |
The subnet prefix length to assign to each individual node. For example, if |
A subnet prefix. For an IPv4 network the default value is |
||
networking: serviceNetwork: |
The IP address block for services. The default value is The OVN-Kubernetes network plugins supports only a single IP address block for the service network. If you use the OVN-Kubernetes network plugin, you can specify an IP address block for both of the IPv4 and IPv6 address families. |
An array with an IP address block in CIDR format. For example:
|
||
networking: machineNetwork: |
The IP address blocks for machines. If you specify multiple IP address blocks, the blocks must not overlap. |
An array of objects. For example:
|
||
networking: machineNetwork: cidr: |
Required if you use |
An IP network block in CIDR notation. For example,
|
Optional installation configuration parameters are described in the following table:
Parameter | Description | Values | ||
---|---|---|---|---|
additionalTrustBundle: |
A PEM-encoded X.509 certificate bundle that is added to the nodes' trusted certificate store. This trust bundle may also be used when a proxy has been configured. |
String |
||
capabilities: |
Controls the installation of optional core cluster components. You can reduce the footprint of your OKD cluster by disabling optional components. For more information, see the "Cluster capabilities" page in Installing. |
String array |
||
capabilities: baselineCapabilitySet: |
Selects an initial set of optional capabilities to enable. Valid values are |
String |
||
capabilities: additionalEnabledCapabilities: |
Extends the set of optional capabilities beyond what you specify in |
String array |
||
cpuPartitioningMode: |
Enables workload partitioning, which isolates OKD services, cluster management workloads, and infrastructure pods to run on a reserved set of CPUs. Workload partitioning can only be enabled during installation and cannot be disabled after installation. While this field enables workload partitioning, it does not configure workloads to use specific CPUs. For more information, see the Workload partitioning page in the Scalability and Performance section. |
|
||
compute: |
The configuration for the machines that comprise the compute nodes. |
Array of |
||
compute: architecture: |
Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are |
String |
||
compute: hyperthreading: |
Whether to enable or disable simultaneous multithreading, or
|
|
||
compute: name: |
Required if you use |
|
||
compute: platform: |
Required if you use |
|
||
compute: replicas: |
The number of compute machines, which are also known as worker machines, to provision. |
A positive integer greater than or equal to |
||
featureSet: |
Enables the cluster for a feature set. A feature set is a collection of OKD features that are not enabled by default. For more information about enabling a feature set during installation, see "Enabling features using feature gates". |
String. The name of the feature set to enable, such as |
||
controlPlane: |
The configuration for the machines that comprise the control plane. |
Array of |
||
controlPlane: architecture: |
Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are |
String |
||
controlPlane: hyperthreading: |
Whether to enable or disable simultaneous multithreading, or
|
|
||
controlPlane: name: |
Required if you use |
|
||
controlPlane: platform: |
Required if you use |
|
||
controlPlane: replicas: |
The number of control plane machines to provision. |
Supported values are |
||
credentialsMode: |
The Cloud Credential Operator (CCO) mode. If no mode is specified, the CCO dynamically tries to determine the capabilities of the provided credentials, with a preference for mint mode on the platforms where multiple modes are supported.
|
|
||
imageContentSources: |
Sources and repositories for the release-image content. |
Array of objects. Includes a |
||
imageContentSources: source: |
Required if you use |
String |
||
imageContentSources: mirrors: |
Specify one or more repositories that may also contain the same images. |
Array of strings |
||
publish: |
How to publish or expose the user-facing endpoints of your cluster, such as the Kubernetes API, OpenShift routes. |
Setting this field to
|
||
sshKey: |
The SSH key to authenticate access to your cluster machines.
|
For example, |