Red Hat Summit Red Hat SummitSupportKonsoleEntwicklerDemo startenKontakt

Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.

Chapter 6. Installation configuration parameters for Nutanix

Before you deploy an OpenShift Container Platform cluster on Nutanix, 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.

6.1. Available installation configuration parameters for Nutanix
Link kopieren

The following tables specify the required, optional, and Nutanix-specific installation configuration parameters that you can set as part of the installation process.

Important

After installation, you cannot change these parameters in the 

install-config.yaml
file.

6.1.1. Required configuration parameters
Link kopieren

Required installation configuration parameters are described in the following table:

Expand
Table 6.1. Required parameters
ParameterDescriptionValues
apiVersion:

The API version for the 

install-config.yaml
content. The current version is 
v1
. The installation program might also support older API versions.

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 

baseDomain
and 
metadata.name
parameter values that uses the 
<metadata.name>.<baseDomain>
format.

A fully-qualified domain or subdomain name, such as 

example.com
. 

metadata:

Kubernetes resource 

ObjectMeta
, from which only the 
name
parameter is consumed.

Object 

metadata:
  name:

The name of the cluster. DNS records for the cluster are all subdomains of 

{{.metadata.name}}.{{.baseDomain}}
.

String of lowercase letters and hyphens (

-
), such as 
dev
. 

platform:

The configuration for the specific platform upon which to perform the installation: 

alibabacloud
, 
aws
, 
baremetal
, 
azure
, 
gcp
, 
ibmcloud
, 
nutanix
, 
openstack
, 
powervs
, 
vsphere
, or 
{}
. For additional information about 
platform.<platform>
parameters, consult the table for your specific platform that follows.

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. 

{
   "auths":{
      "cloud.openshift.com":{
         "auth":"b3Blb=",
         "email":"you@example.com"
      },
      "quay.io":{
         "auth":"b3Blb=",
         "email":"you@example.com"
      }
   }
}

6.1.2. Network configuration parameters
Link kopieren

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 configure different IP address blocks than the defaults.

Only IPv4 addresses are supported.

Note

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.

Expand
Table 6.2. Network parameters
ParameterDescriptionValues
networking:

The configuration for the cluster network.

Object

Note

You cannot change parameters specified by the 

networking
object after installation. 

networking:
  networkType:

The Red Hat OpenShift Networking network plugin to install.

Either 

OpenShiftSDN
or 
OVNKubernetes
. 
OpenShiftSDN
is a CNI plugin for all-Linux networks. 
OVNKubernetes
is a CNI plugin for Linux networks and hybrid networks that contain both Linux and Windows servers. The default value is 
OVNKubernetes
. 

networking:
  clusterNetwork:

The IP address blocks for pods.

The default value is 

10.128.0.0/14
with a host prefix of 
/23
.

If you specify multiple IP address blocks, the blocks must not overlap.

An array of objects. For example: 

networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23
 
networking:
  clusterNetwork:
    cidr:

Required if you use 

networking.clusterNetwork
. An IP address block.

An IPv4 network.

An IP address block in Classless Inter-Domain Routing (CIDR) notation. The prefix length for an IPv4 block is between 

0
and 
32
. 

networking:
  clusterNetwork:
    hostPrefix:

The subnet prefix length to assign to each individual node. For example, if 

hostPrefix
is set to 
23
then each node is assigned a 
/23
subnet out of the given 
cidr
. A 
hostPrefix
value of 
23
provides 510 (2^(32 - 23) - 2) pod IP addresses.

A subnet prefix.

The default value is 

23
. 

networking:
  serviceNetwork:

The IP address block for services. The default value is 

172.30.0.0/16
.

The OpenShift SDN and OVN-Kubernetes network plugins support only a single IP address block for the service network.

An array with an IP address block in CIDR format. For example: 

networking:
  serviceNetwork:
   - 172.30.0.0/16
 
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: 10.0.0.0/16
 
networking:
  machineNetwork:
    cidr:

Required if you use 

networking.machineNetwork
. An IP address block. The default value is 
10.0.0.0/16
for all platforms other than libvirt and IBM Power® Virtual Server. For libvirt, the default value is 
192.168.126.0/24
. For IBM Power® Virtual Server, the default value is 
192.168.0.0/24
.

An IP network block in CIDR notation.

For example, 

10.0.0.0/16
.

Note

Set the 

networking.machineNetwork
to match the CIDR that the preferred NIC resides in.

6.1.3. Optional configuration parameters
Link kopieren

Optional installation configuration parameters are described in the following table:

Expand
Table 6.3. Optional parameters
ParameterDescriptionValues
additionalTrustBundle:

A PEM-encoded X.509 certificate bundle that is added to the nodes' trusted certificate store. This trust bundle might also be used when a proxy is 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 

None
, 
v4.11
, 
v4.12
and 
vCurrent
. The default value is 
vCurrent
.

String 

capabilities:
  additionalEnabledCapabilities:

Extends the set of optional capabilities beyond what you specify in 

baselineCapabilitySet
. You can specify multiple capabilities in this parameter.

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. You can only enable workload partitioning during installation. You cannot disable it 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. 

None
or 
AllNodes
. 
None
is the default value. 

compute:

The configuration for the machines that comprise the compute nodes.

Array of 

MachinePool
objects. 

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 

amd64
(the default).

String 

compute:
  hyperthreading:

Whether to enable or disable simultaneous multithreading, or 

hyperthreading
, on compute machines. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores.

Important

If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. 

Enabled
or 
Disabled
 

compute:
  name:

Required if you use 

compute
. The name of the machine pool. 

worker
 

compute:
  platform:

Required if you use 

compute
. Use this parameter to specify the cloud provider to host the worker machines. This parameter value must match the 
controlPlane.platform
parameter value. 

alibabacloud
, 
aws
, 
azure
, 
gcp
, 
ibmcloud
, 
nutanix
, 
openstack
, 
powervs
, 
vsphere
, or 
{}
 

compute:
  replicas:

The number of compute machines, which are also known as worker machines, to provision.

A positive integer greater than or equal to 

2
. The default value is 
3
. 

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 

TechPreviewNoUpgrade
. 

controlPlane:

The configuration for the machines that form the control plane.

Array of 

MachinePool
objects. 

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 

amd64
(the default).

String 

controlPlane:
  hyperthreading:

Whether to enable or disable simultaneous multithreading, or 

hyperthreading
, on control plane machines. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores.

Important

If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. 

Enabled
or 
Disabled
 

controlPlane:
  name:

Required if you use 

controlPlane
. The name of the machine pool. 

master
 

controlPlane:
  platform:

Required if you use 

controlPlane
. Use this parameter to specify the cloud provider that hosts the control plane machines. This parameter value must match the 
compute.platform
parameter value. 

alibabacloud
, 
aws
, 
azure
, 
gcp
, 
ibmcloud
, 
nutanix
, 
openstack
, 
powervs
, 
vsphere
, or 
{}
 

controlPlane:
  replicas:

The number of control plane machines to provision.

Supported values are 

3
, or 
1
when deploying single-node OpenShift. 

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. 

Mint
, 
Passthrough
, 
Manual
or an empty string (
""
). [1] 

fips:

Enable or disable FIPS mode. The default is 

false
(disabled). If you enable FIPS mode, the Red Hat Enterprise Linux CoreOS (RHCOS) machines that OpenShift Container Platform runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that RHCOS provides instead.

Important

To enable FIPS mode for your cluster, you must run the installation program from a Red Hat Enterprise Linux (RHEL) computer configured to operate in FIPS mode. For more information about configuring FIPS mode on RHEL, see Switching RHEL to FIPS mode.

When running Red Hat Enterprise Linux (RHEL) or Red Hat Enterprise Linux CoreOS (RHCOS) booted in FIPS mode, OpenShift Container Platform core components use the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64, ppc64le, and s390x architectures.

If you are using Azure File storage, you cannot enable FIPS mode. 

false
or 
true
 

imageContentSources:

Sources and repositories for the release-image content.

Array of objects. Includes a 

source
and, optionally, 
mirrors
, as described in the following rows of this table. 

imageContentSources:
  source:

Required if you use 

imageContentSources
. Specify the repository that users refer to, for example, in image pull specifications.

String 

imageContentSources:
  mirrors:

Specify one or more repositories that might 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. 

Internal
or 
External
. The default value is 
External
.

Setting this field to 

Internal
is not supported on non-cloud platforms.

Important

If the value of the field is set to 

Internal
, the cluster becomes non-functional. For more information, refer to BZ#1953035. 

sshKey:

The SSH key to authenticate access to your cluster machines.

Note

For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your 

ssh-agent
process uses.

For example, 

sshKey: ssh-ed25519 AAAA..
.

  1. Not all CCO modes are supported for all cloud providers. For more information about CCO modes, see the "Managing cloud provider credentials" entry in the Authentication and authorization content.

6.1.4. Additional Nutanix configuration parameters
Link kopieren

Additional Nutanix configuration parameters are described in the following table:

Expand
Table 6.4. Additional Nutanix cluster parameters
ParameterDescriptionValues
compute:
  platform:
    nutanix:
      categories:
        key:

The name of a prism category key to apply to compute VMs. This parameter must be accompanied by the 

value
parameter, and both 
key
and 
value
parameters must exist in Prism Central. For more information on categories, see Category management.

String 

compute:
  platform:
    nutanix:
      categories:
        value:

The value of a prism category key-value pair to apply to compute VMs. This parameter must be accompanied by the 

key
parameter, and both 
key
and 
value
parameters must exist in Prism Central.

String 

compute:
  platform:
    nutanix:
      project:
        type:

The type of identifier you use to select a project for compute VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see Projects Overview. 

name
or 
uuid
 

compute:
  platform:
    nutanix:
      project:
        name: or uuid:

The name or UUID of a project with which compute VMs are associated. This parameter must be accompanied by the 

type
parameter.

String 

compute:
  platform:
    nutanix:
      bootType:

The boot type that the compute machines use. You must use the 

Legacy
boot type in OpenShift Container Platform 4.14. For more information on boot types, see Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment. 

Legacy
, 
SecureBoot
or 
UEFI
. The default is 
Legacy
. 

controlPlane:
  platform:
    nutanix:
      categories:
        key:

The name of a prism category key to apply to control plane VMs. This parameter must be accompanied by the 

value
parameter, and both 
key
and 
value
parameters must exist in Prism Central. For more information on categories, see Category management.

String 

controlPlane:
  platform:
    nutanix:
      categories:
        value:

The value of a prism category key-value pair to apply to control plane VMs. This parameter must be accompanied by the 

key
parameter, and both 
key
and 
value
parameters must exist in Prism Central.

String 

controlPlane:
  platform:
    nutanix:
      project:
        type:

The type of identifier you use to select a project for control plane VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see Projects Overview. 

name
or 
uuid
 

controlPlane:
  platform:
    nutanix:
      project:
        name: or uuid:

The name or UUID of a project with which control plane VMs are associated. This parameter must be accompanied by the 

type
parameter.

String 

platform:
  nutanix:
    defaultMachinePlatform:
      categories:
        key:

The name of a prism category key to apply to all VMs. This parameter must be accompanied by the 

value
parameter, and both 
key
and 
value
parameters must exist in Prism Central. For more information on categories, see Category management.

String 

platform:
  nutanix:
    defaultMachinePlatform:
      categories:
        value:

The value of a prism category key-value pair to apply to all VMs. This parameter must be accompanied by the 

key
parameter, and both 
key
and 
value
parameters must exist in Prism Central.

String 

platform:
  nutanix:
    defaultMachinePlatform:
      project:
        type:

The type of identifier you use to select a project for all VMs. Projects define logical groups of user roles for managing permissions, networks, and other parameters. For more information on projects, see Projects Overview. 

name
or 
uuid
. 

platform:
  nutanix:
    defaultMachinePlatform:
      project:
        name: or uuid:

The name or UUID of a project with which all VMs are associated. This parameter must be accompanied by the 

type
parameter.

String 

platform:
  nutanix:
    defaultMachinePlatform:
      bootType:

The boot type for all machines. You must use the 

Legacy
boot type in OpenShift Container Platform 4.14. For more information on boot types, see Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment. 

Legacy
, 
SecureBoot
or 
UEFI
. The default is 
Legacy
. 

platform:
  nutanix:
    apiVIP:

The virtual IP (VIP) address that you configured for control plane API access.

IP address 

platform:
  nutanix:
    ingressVIP:

The virtual IP (VIP) address that you configured for cluster ingress.

IP address 

platform:
  nutanix:
    prismCentral:
      endpoint:
        address:

The Prism Central domain name or IP address.

String 

platform:
  nutanix:
    prismCentral:
      endpoint:
        port:

The port that is used to log into Prism Central.

String 

platform:
  nutanix:
    prismCentral:
      password:

The password for the Prism Central user name.

String 

platform:
  nutanix:
    prismCentral:
      username:

The user name that is used to log into Prism Central.

String 

platform:
  nutanix:
    prismElements:
      endpoint:
        address:

The Prism Element domain name or IP address. [1]

String 

platform:
  nutanix:
    prismElements:
      endpoint:
        port:

The port that is used to log into Prism Element.

String 

platform:
  nutanix:
    prismElements:
      uuid:

The universally unique identifier (UUID) for Prism Element.

String 

platform:
  nutanix:
    subnetUUIDs:

The UUID of the Prism Element network that contains the virtual IP addresses and DNS records that you configured. [2]

String 

platform:
  nutanix:
    clusterOSImage:

Optional: By default, the installation program downloads and installs the Red Hat Enterprise Linux CoreOS (RHCOS) image. If Prism Central does not have internet access, you can override the default behavior by hosting the RHCOS image on any HTTP server and pointing the installation program to the image.

An HTTP or HTTPS URL, optionally with a SHA-256 checksum. For example, http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2

  1. The 
    prismElements
    section holds a list of Prism Elements (clusters). A Prism Element encompasses all of the Nutanix resources, for example virtual machines and subnets, that are used to host the OpenShift Container Platform cluster. Only a single Prism Element is supported.
  2. Only one subnet per OpenShift Container Platform cluster is supported.
Red Hat logoGithubredditYoutubeTwitter

Lernen

Testen, kaufen und verkaufen

Communitys

Über Red Hat Dokumentation

Wir helfen Red Hat Benutzern, mit unseren Produkten und Diensten innovativ zu sein und ihre Ziele zu erreichen – mit Inhalten, denen sie vertrauen können. Entdecken Sie unsere neuesten Updates.

Mehr Inklusion in Open Source

Red Hat hat sich verpflichtet, problematische Sprache in unserem Code, unserer Dokumentation und unseren Web-Eigenschaften zu ersetzen. Weitere Einzelheiten finden Sie in Red Hat Blog.

Über Red Hat

Wir liefern gehärtete Lösungen, die es Unternehmen leichter machen, plattform- und umgebungsübergreifend zu arbeiten, vom zentralen Rechenzentrum bis zum Netzwerkrand.

Theme

© 2026 Red HatNach oben