Installation configuration parameters for Azure Stack Hub

Before you deploy an OKD cluster on Azure Stack Hub, you provide a customized install-config.yaml installation configuration file that describes the details for your environment.

Available installation configuration parameters for Azure Stack Hub

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

After installation, you cannot modify these parameters in the install-config.yaml file.

Required configuration parameters

Required installation configuration parameters are described in the following table:

Table 1. Required parameters
ParameterDescriptionValues
  1. apiVersion:

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

String

  1. 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 baseDomain and metadata.name parameter values that uses the <metadata.name>.<baseDomain> format.

A fully-qualified domain or subdomain name, such as example.com.

  1. metadata:

Kubernetes resource ObjectMeta, from which only the name parameter is consumed.

Object

  1. metadata:
  2.   name:

The name of the cluster. DNS records for the cluster are all subdomains of {{.metadata.name}}.{{.baseDomain}}.

String of lowercase letters, hyphens (-), and periods (.), such as dev.

  1. 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

Network configuration parameters

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.

Table 2. Network parameters
ParameterDescriptionValues
  1. networking:

The configuration for the cluster network.

Object

You cannot modify parameters specified by the networking object after installation.

  1. networking:
  2.   networkType:

The Red Hat OpenShift Networking network plugin to install.

Either OpenShiftSDN or OVNKubernetes. The default value is OVNKubernetes.

  1. networking:
  2.   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:

  1. networking:
  2.   clusterNetwork:
  3.   - cidr: 10.128.0.0/14
  4.     hostPrefix: 23
  1. networking:
  2.   clusterNetwork:
  3.     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.

  1. networking:
  2.   clusterNetwork:
  3.     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.

  1. networking:
  2.   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:

  1. networking:
  2.   serviceNetwork:
  3.    - 172.30.0.0/16
  1. networking:
  2.   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:

  1. networking:
  2.   machineNetwork:
  3.   - cidr: 10.0.0.0/16
  1. networking:
  2.   machineNetwork:
  3.     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.

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

Optional configuration parameters

Optional installation configuration parameters are described in the following table:

Table 3. Optional parameters
ParameterDescriptionValues
  1. 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

  1. 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

  1. capabilities:
  2.   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

  1. capabilities:
  2.   additionalEnabledCapabilities:

Extends the set of optional capabilities beyond what you specify in baselineCapabilitySet. You may specify multiple capabilities in this parameter.

String array

  1. 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.

None or AllNodes. None is the default value.

  1. compute:

The configuration for the machines that comprise the compute nodes.

Array of MachinePool objects.

  1. compute:
  2.   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

  1. compute:
  2.   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.

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

Enabled or Disabled

  1. compute:
  2.   name:

Required if you use compute. The name of the machine pool.

worker

  1. compute:
  2.   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 {}

  1. compute:
  2.   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.

  1. 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 TechPreviewNoUpgrade.

  1. controlPlane:

The configuration for the machines that comprise the control plane.

Array of MachinePool objects.

  1. controlPlane:
  2.   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.

String

  1. controlPlane:
  2.   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.

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

Enabled or Disabled

  1. controlPlane:
  2.   name:

Required if you use controlPlane. The name of the machine pool.

master

  1. controlPlane:
  2.   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 {}

  1. controlPlane:
  2.   replicas:

The number of control plane machines to provision.

Supported values are 3, or 1 when deploying single-node OpenShift.

  1. 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]

  1. 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.

  1. imageContentSources:
  2.   source:

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

String

  1. imageContentSources:
  2.   mirrors:

Specify one or more repositories that may also contain the same images.

Array of strings

  1. 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.

If the value of the field is set to Internal, the cluster will become non-functional. For more information, refer to BZ#1953035.

  1. sshKey:

The SSH key to authenticate access to your cluster machines.

For production OKD 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.

Additional Azure Stack Hub configuration parameters

Additional Azure configuration parameters are described in the following table:

Table 4. Additional Azure Stack Hub parameters
ParameterDescriptionValues
  1. compute:
  2.   platform:
  3.     azure:
  4.       osDisk:
  5.         diskSizeGB:

The Azure disk size for the VM.

Integer that represents the size of the disk in GB. The default is 128.

  1. compute:
  2.   platform:
  3.     azure:
  4.       osDisk:
  5.         diskType:

Defines the type of disk.

standard_LRS or premium_LRS. The default is premium_LRS.

  1. compute:
  2.   platform:
  3.     azure:
  4.       type:

Defines the azure instance type for compute machines.

String

  1. controlPlane:
  2.   platform:
  3.     azure:
  4.       osDisk:
  5.         diskSizeGB:

The Azure disk size for the VM.

Integer that represents the size of the disk in GB. The default is 1024.

  1. controlPlane:
  2.   platform:
  3.     azure:
  4.       osDisk:
  5.         diskType:

Defines the type of disk.

premium_LRS.

  1. controlPlane:
  2.   platform:
  3.     azure:
  4.       type:

Defines the azure instance type for control plane machines.

String

  1. platform:
  2.   azure:
  3.     defaultMachinePlatform:
  4.       osDisk:
  5.         diskSizeGB:

The Azure disk size for the VM.

Integer that represents the size of the disk in GB. The default is 128.

  1. platform:
  2.   azure:
  3.     defaultMachinePlatform:
  4.       osDisk:
  5.         diskType:

Defines the type of disk.

standard_LRS or premium_LRS. The default is premium_LRS.

  1. platform:
  2.   azure:
  3.     defaultMachinePlatform:
  4.       type:

The Azure instance type for control plane and compute machines.

The Azure instance type.

  1. platform:
  2.   azure:
  3.     armEndpoint:

The URL of the Azure Resource Manager endpoint that your Azure Stack Hub operator provides.

String

  1. platform:
  2.   azure:
  3.     baseDomainResourceGroupName:

The name of the resource group that contains the DNS zone for your base domain.

String, for example production_cluster.

  1. platform:
  2.   azure:
  3.     region:

The name of your Azure Stack Hub local region.

String

  1. platform:
  2.   azure:
  3.     resourceGroupName:

The name of an already existing resource group to install your cluster to. This resource group must be empty and only used for this specific cluster; the cluster components assume ownership of all resources in the resource group. If you limit the service principal scope of the installation program to this resource group, you must ensure all other resources used by the installation program in your environment have the necessary permissions, such as the public DNS zone and virtual network. Destroying the cluster by using the installation program deletes this resource group.

String, for example existing_resource_group.

  1. platform:
  2.   azure:
  3.     outboundType:

The outbound routing strategy used to connect your cluster to the internet. If you are using user-defined routing, you must have pre-existing networking available where the outbound routing has already been configured prior to installing a cluster. The installation program is not responsible for configuring user-defined routing.

LoadBalancer or UserDefinedRouting. The default is LoadBalancer.

  1. platform:
  2.   azure:
  3.     cloudName:

The name of the Azure cloud environment that is used to configure the Azure SDK with the appropriate Azure API endpoints.

AzureStackCloud

  1. clusterOSImage:

The URL of a storage blob in the Azure Stack environment that contains an FCOS VHD.