String
Before you deploy an OpenShift Container Platform on IBM Power® Virtual Server, you provide parameters to customize your cluster and the platform that hosts it. When you create the install-config.yaml
file, you provide values for the required parameters through the command line. You can then modify the install-config.yaml
file to customize your cluster further.
The following tables specify the required, optional, and IBM Power Virtual Server-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 OpenShift Container Platform 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, hyphens ( |
platform: |
The configuration for the specific platform upon which to perform the installation: |
Object |
pullSecret: |
Get a pull secret from Red Hat OpenShift Cluster Manager to authenticate downloading container images for OpenShift Container Platform components from services such as Quay.io. |
|
platform: powervs: userID: |
The UserID is the login for the user’s IBM Cloud® account. |
String. For example, |
platform: powervs: powervsResourceGroup: |
The PowerVSResourceGroup is the resource group in which IBM Power® Virtual Server resources are created. If using an existing VPC, the existing VPC and subnets should be in this resource group. |
String. For example, |
platform: powervs: region: |
Specifies the IBM Cloud® colo region where the cluster will be created. |
String. For example, |
platform: powervs: zone: |
Specifies the IBM Cloud® colo region where the cluster will be created. |
String. For example, |
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.
Only IPv4 addresses are supported.
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. |
The default value is |
||
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 An IPv4 network. |
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. 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. |
An array with an IP address block in CIDR format. For example:
|
||
networking: machineNetwork: |
The IP address blocks for machines. |
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 OpenShift Container Platform 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 OpenShift Container Platform 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, heteregeneous clusters are not supported, so all pools must specify the same architecture. Valid values are |
String |
||
compute: hyperthreading: |
Whether to enable or disable simultaneous multithreading, or
|
|
||
compute: smtLevel: |
The SMTLevel specifies the level of SMT to set to the control plane and compute machines. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, |
String |
||
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 OpenShift Container Platform 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, heterogeneous clusters are not supported, so 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, |
||
platform: powervs: vpcRegion: |
Specifies the IBM Cloud® region in which to create VPC resources. |
String. For example, |
||
platform: powervs: vpcSubnets: |
Specifies existing subnets (by name) where cluster resources will be created. |
String. For example, |
||
platform: powervs: vpcName: |
Specifies the IBM Cloud® name. |
String. For example, |
||
platform: powervs: serviceInstanceGUID: |
The ServiceInstanceGUID is the ID of the Power IAAS instance created from the IBM Cloud® Catalog. |
String. For example, |
||
platform: powervs: clusterOSImage: |
The ClusterOSImage is a pre-created IBM Power® Virtual Server boot image that overrides the default image for cluster nodes. |
String. For example, |
||
platform: powervs: defaultMachinePlatform: |
The DefaultMachinePlatform is the default configuration used when installing on IBM Power® Virtual Server for machine pools that do not define their own platform configuration. |
String. For example, |
||
platform: powervs: memoryGiB: |
The size of a virtual machine’s memory, in GB. |
The valid integer must be an integer number of GB that is at least 2 and no more than 64, depending on the machine type. |
||
platform: powervs: procType: |
The ProcType defines the processor sharing model for the instance. |
The valid values are Capped, Dedicated, and Shared. |
||
platform: powervs: processors: |
The Processors defines the processing units for the instance. |
The number of processors must be from .5 to 32 cores. The processors must be in increments of .25. |
||
platform: powervs: sysType: |
The SysType defines the system type for the instance. |
The system type must be either |