mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-15460: CQA install vSphere config parameters
This commit is contained in:
“Shauna Diaz”
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
200fbe693d
commit
a7ba4fe085
@@ -7,6 +7,6 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
Before you deploy an {product-title} cluster on vSphere, 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.
|
||||
Before you deploy an {product-title} cluster on vSphere, you can configure parameters to customize your cluster and the platform that hosts it. The installation program uses the information in the `install-config.yaml` file to provision required infrastructure and deploy cluster components. When you create the `install-config.yaml` file, you can configure the values for your required parameters through the command line. Edit the `install-config.yaml` file to customize your cluster further before installation begins.
|
||||
|
||||
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
|
||||
|
||||
@@ -56,27 +56,29 @@ endif::[]
|
||||
|
||||
// You can issue a command such as `openshift-install explain installconfig.platform.vsphere.failureDomains` to see information about a parameter. You must store the `openshift-install` binary in your bin directory. Also, consider viewing the installer/pkg/types/vsphere/platform.go for information about supported parameters.
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
:_mod-docs-content-type: REFERENCE
|
||||
[id="installation-configuration-parameters_{context}"]
|
||||
ifndef::agent[]
|
||||
= Available installation configuration parameters for {platform}
|
||||
|
||||
The following tables specify the required, optional, and {platform}-specific installation configuration parameters that you can set as part of the installation process.
|
||||
|
||||
[NOTE]
|
||||
[IMPORTANT]
|
||||
====
|
||||
After installation, you cannot modify these parameters in the `install-config.yaml` file.
|
||||
After installation, you cannot change these parameters in the `install-config.yaml` file.
|
||||
====
|
||||
endif::agent[]
|
||||
|
||||
ifdef::agent[]
|
||||
= Available installation configuration parameters
|
||||
|
||||
The following tables specify the required and optional installation configuration parameters that you can set as part of the Agent-based installation process.
|
||||
|
||||
These values are specified in the `install-config.yaml` file.
|
||||
|
||||
[NOTE]
|
||||
[IMPORTANT]
|
||||
====
|
||||
These settings are used for installation only, and cannot be modified after installation.
|
||||
These settings are used for installation only, and cannot be changed after installation.
|
||||
====
|
||||
|
||||
endif::agent[]
|
||||
@@ -92,7 +94,7 @@ Required installation configuration parameters are described in the following ta
|
||||
|Parameter|Description|Values
|
||||
|
||||
|apiVersion:
|
||||
|The API version for the `install-config.yaml` content. The current version is `v1`. The installation program may also support older API versions.
|
||||
|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:
|
||||
@@ -107,7 +109,7 @@ Required installation configuration parameters are described in the following ta
|
||||
name:
|
||||
|The name of the cluster. DNS records for the cluster are all subdomains of `{{.metadata.name}}.{{.baseDomain}}`.
|
||||
ifdef::agent[]
|
||||
When you do not provide `metadata.name` through either the `install-config.yaml` or `agent-config.yaml` files, for example when you use only ZTP manifests, the cluster name is set to `agent-cluster`.
|
||||
The cluster name is set to `agent-cluster` when you do not provide the `metadata.name` parameter through either the `install-config.yaml` or `agent-config.yaml` files. For example, installations that only use ZTP manifests do not provide the `metadata.name` parameter.
|
||||
endif::agent[]
|
||||
ifndef::bare,nutanix,vsphere[]
|
||||
|String of lowercase letters, hyphens (`-`), and periods (`.`), such as `dev`.
|
||||
@@ -165,13 +167,13 @@ ifdef::ibm-power-vs[]
|
||||
|platform:
|
||||
powervs:
|
||||
region:
|
||||
|Specifies the {ibm-cloud-name} colo region where the cluster will be created.
|
||||
|Specifies the {ibm-cloud-name} region where the cluster is created.
|
||||
|String. For example, `existing_region`.
|
||||
|
||||
|platform:
|
||||
powervs:
|
||||
zone:
|
||||
|Specifies the {ibm-cloud-name} colo region where the cluster will be created.
|
||||
|Specifies the {ibm-cloud-name} colo region where the cluster is created.
|
||||
|String. For example, `existing_zone`.
|
||||
|
||||
endif::ibm-power-vs[]
|
||||
@@ -180,7 +182,7 @@ endif::ibm-power-vs[]
|
||||
[id="installation-configuration-parameters-network_{context}"]
|
||||
== 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.
|
||||
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.
|
||||
|
||||
ifndef::agent,bare,ibm-power,ibm-z,vsphere,osp[]
|
||||
Only IPv4 addresses are supported.
|
||||
@@ -214,7 +216,7 @@ If you configure your cluster to use both IP address families, review the follow
|
||||
|
||||
* 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.
|
||||
* 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:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -248,7 +250,7 @@ endif::osp[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You cannot modify parameters specified by the `networking` object after installation.
|
||||
You cannot change parameters specified by the `networking` object after installation.
|
||||
====
|
||||
|
||||
|networking:
|
||||
@@ -260,7 +262,7 @@ ifdef::openshift-origin[]
|
||||
endif::openshift-origin[]
|
||||
ifndef::openshift-origin[]
|
||||
ifndef::ibm-power-vs[]
|
||||
`OVNKubernetes`. `OVNKubernetes` is a CNI plugin for Linux networks and hybrid networks that contain both Linux and Windows servers. The default value is `OVNKubernetes`.
|
||||
`OVNKubernetes`. `OVNKubernetes` is a Container Network Interface (CNI) plugin for Linux networks and hybrid networks that contain both Linux and Windows servers. The default value is `OVNKubernetes`.
|
||||
endif::ibm-power-vs[]
|
||||
ifdef::ibm-power-vs[]
|
||||
The default value is `OVNKubernetes`.
|
||||
@@ -429,7 +431,7 @@ Optional installation configuration parameters are described in the following ta
|
||||
|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.
|
||||
|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 has been configured.
|
||||
|String
|
||||
|
||||
|capabilities:
|
||||
@@ -443,11 +445,11 @@ Optional installation configuration parameters are described in the following ta
|
||||
|
||||
|capabilities:
|
||||
additionalEnabledCapabilities:
|
||||
|Extends the set of optional capabilities beyond what you specify in `baselineCapabilitySet`. You may specify multiple capabilities in this parameter.
|
||||
|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 {product-title} 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.
|
||||
|Enables workload partitioning, which isolates {product-title} 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:
|
||||
@@ -476,14 +478,14 @@ endif::aws,azure,gcp,bare[]
|
||||
ifdef::ibm-z[]
|
||||
|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 `s390x` (the default).
|
||||
|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. The valid value is the default: `s390x`.
|
||||
|String
|
||||
endif::ibm-z[]
|
||||
|
||||
ifdef::ibm-power,ibm-power-vs[]
|
||||
|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 `ppc64le` (the default).
|
||||
|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. The valid value is the default: `ppc64le`.
|
||||
|String
|
||||
endif::ibm-power,ibm-power-vs[]
|
||||
|
||||
@@ -499,7 +501,7 @@ endif::openshift-origin[]
|
||||
ifdef::openshift-origin[]
|
||||
|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).
|
||||
|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. The valid value is the default: `amd64`.
|
||||
ifdef::aws[]
|
||||
See _Supported installation methods for different platforms_ in _Installing_ documentation for information about instance availability.
|
||||
endif::aws[]
|
||||
@@ -511,15 +513,14 @@ ifndef::vsphere[]
|
||||
|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.
|
||||
If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.
|
||||
====
|
||||
|`Enabled` or `Disabled`
|
||||
endif::vsphere[]
|
||||
ifdef::ibm-power-vs[]
|
||||
|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, `off`, and `on`.
|
||||
|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`, `off`, and `on`.
|
||||
|String
|
||||
endif::ibm-power-vs[]
|
||||
|
||||
@@ -559,7 +560,7 @@ endif::agent[]
|
||||
|String. The name of the feature set to enable, such as `TechPreviewNoUpgrade`.
|
||||
|
||||
|controlPlane:
|
||||
|The configuration for the machines that comprise the control plane.
|
||||
|The configuration for the machines that form the control plane.
|
||||
|Array of `MachinePool` objects.
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
@@ -583,14 +584,14 @@ endif::aws,azure,gcp,bare[]
|
||||
ifdef::ibm-z[]
|
||||
|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 `s390x` (the default).
|
||||
|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. The valid value is the default: `s390x`.
|
||||
|String
|
||||
endif::ibm-z[]
|
||||
|
||||
ifdef::ibm-power,ibm-power-vs[]
|
||||
|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 `ppc64le` (the default).
|
||||
|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. The valid value is the default: `ppc64le`.
|
||||
|String
|
||||
endif::ibm-power,ibm-power-vs[]
|
||||
|
||||
@@ -606,7 +607,7 @@ endif::openshift-origin[]
|
||||
ifdef::openshift-origin[]
|
||||
|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`.
|
||||
|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. The valid value is `amd64`.
|
||||
ifdef::aws[]
|
||||
See _Supported installation methods for different platforms_ in _Installing_ documentation for information about instance availability.
|
||||
endif::aws[]
|
||||
@@ -619,8 +620,7 @@ ifndef::vsphere[]
|
||||
|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.
|
||||
If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.
|
||||
====
|
||||
|`Enabled` or `Disabled`
|
||||
endif::vsphere[]
|
||||
@@ -671,11 +671,11 @@ Not all CCO modes are supported for all cloud providers. For more information ab
|
||||
|
||||
ifndef::openshift-origin,ibm-power-vs[]
|
||||
|fips:
|
||||
|Enable or disable FIPS mode. The default is `false` (disabled). If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
|
||||
|Enable or disable FIPS mode. The default is `false` (disabled). If you enable FIPS mode, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that {op-system} provides instead.
|
||||
|
||||
include::snippets/fips-snippet.adoc[]
|
||||
|
||||
[NOTE]
|
||||
[IMPORTANT]
|
||||
====
|
||||
If you are using Azure File storage, you cannot enable FIPS mode.
|
||||
====
|
||||
@@ -692,7 +692,7 @@ endif::openshift-origin,ibm-power-vs[]
|
||||
|
||||
|imageContentSources:
|
||||
mirrors:
|
||||
|Specify one or more repositories that may also contain the same images.
|
||||
|Specify one or more repositories that might also contain the same images.
|
||||
|Array of strings
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
@@ -709,10 +709,10 @@ endif::openshift-origin[]
|
||||
|How to publish or expose the user-facing endpoints of your cluster, such as the Kubernetes API, OpenShift routes.
|
||||
|
|
||||
ifdef::aws,gcp,ibm-cloud[]
|
||||
`Internal` or `External`. To deploy a private cluster, which cannot be accessed from the internet, set `publish` to `Internal`. The default value is `External`.
|
||||
`Internal` or `External`. To deploy a private cluster that cannot be accessed from the internet, set the `publish` parameter to `Internal`. The default value is `External`.
|
||||
endif::[]
|
||||
ifdef::azure[]
|
||||
`Internal`, `External`, or `Mixed`. To deploy a private cluster, which cannot be accessed from the internet, set `publish` to `Internal`. The default value is `External`. To deploy a cluster where the API and the ingress server have different publishing strategies, set `publish` to `Mixed` and use the `operatorPublishingStrategy` parameter.
|
||||
`Internal`, `External`, or `Mixed`. To deploy a private cluster that cannot be accessed from the internet, set the `publish` parameter to `Internal`. The default value is `External`. To deploy a cluster where the API and the ingress server have different publishing strategies, set `publish` to `Mixed` and use the `operatorPublishingStrategy` parameter.
|
||||
endif::[]
|
||||
ifndef::aws,azure,gcp,ibm-cloud[]
|
||||
`Internal` or `External`. The default value is `External`.
|
||||
@@ -722,8 +722,9 @@ ifndef::ibm-power-vs[]
|
||||
ifeval::[{product-version} <= 4.7]
|
||||
[IMPORTANT]
|
||||
====
|
||||
If the value of the field is set to `Internal`, the cluster will become non-functional. For more information, refer to link:https://bugzilla.redhat.com/show_bug.cgi?id=1953035[BZ#1953035].
|
||||
If the value of the field is set to `Internal`, the cluster becomes non-functional. For more information, refer to link:https://bugzilla.redhat.com/show_bug.cgi?id=1953035[BZ#1953035].
|
||||
====
|
||||
|
||||
endif::[]
|
||||
endif::ibm-power-vs[]
|
||||
endif::[]
|
||||
@@ -746,7 +747,7 @@ ifdef::ibm-power-vs[]
|
||||
|platform:
|
||||
powervs:
|
||||
vpcSubnets:
|
||||
|Specifies existing subnets (by name) where cluster resources will be created.
|
||||
|Specifies existing subnets by name where cluster resources are created.
|
||||
|String. For example, `powervs_region_example_subnet`.
|
||||
|
||||
|platform:
|
||||
@@ -777,19 +778,19 @@ ifdef::ibm-power-vs[]
|
||||
powervs:
|
||||
memoryGiB:
|
||||
|Specifies 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.
|
||||
|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:
|
||||
|Defines the processor sharing model for the instance.
|
||||
|The valid values are Capped, Dedicated, and Shared.
|
||||
|The valid values are `Capped`, `Dedicated`, and `Shared`.
|
||||
|
||||
|platform:
|
||||
powervs:
|
||||
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.
|
||||
|The number of processors must be from `.5` to `32` cores. The processors must be in increments of `.25`.
|
||||
|
||||
|platform:
|
||||
powervs:
|
||||
@@ -980,7 +981,7 @@ belong to the same region as the cluster. This is required for regions that requ
|
||||
|platform:
|
||||
aws:
|
||||
hostedZoneRole:
|
||||
|An Amazon Resource Name (ARN) for an existing IAM role in the account containing the specified hosted zone. The installation program and cluster operators will assume this role when performing operations on the hosted zone. This parameter should only be used if you are installing a cluster into a shared VPC.
|
||||
|An Amazon Resource Name (ARN) for an existing IAM role in the account containing the specified hosted zone. The installation program and cluster operators assume this role when performing operations on the hosted zone. Use this parameter only when you are installing a cluster into a shared VPC.
|
||||
|String, for example `arn:aws:iam::1234567890:role/shared-vpc-role`.
|
||||
|
||||
|platform:
|
||||
@@ -1004,10 +1005,7 @@ endif::openshift-origin[]
|
||||
serviceEndpoints:
|
||||
- name:
|
||||
url:
|
||||
|The AWS service endpoint name and URL. Custom endpoints are only required for cases
|
||||
where alternative AWS endpoints, like FIPS, must be used. Custom API endpoints
|
||||
can be specified for EC2, S3, IAM, Elastic Load Balancing, Tagging, Route 53,
|
||||
and STS AWS services.
|
||||
|The AWS service endpoint name and URL. Custom endpoints are only required for cases where alternative AWS endpoints, such as FIPS, must be used. Custom API endpoints can be specified for EC2, S3, IAM, Elastic Load Balancing, Tagging, Route 53, and STS AWS services.
|
||||
|Valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS service endpoint] name and valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS service endpoint] URL.
|
||||
|
||||
|platform:
|
||||
@@ -1018,7 +1016,7 @@ and STS AWS services.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You can add up to 25 user defined tags during installation. The remaining 25 tags are reserved for {product-title}.
|
||||
You can add up to 25 user-defined tags during installation. The remaining 25 tags are reserved for {product-title}.
|
||||
====
|
||||
|
||||
|platform:
|
||||
@@ -1030,12 +1028,12 @@ You can add up to 25 user defined tags during installation. The remaining 25 tag
|
||||
|platform:
|
||||
aws:
|
||||
publicIpv4Pool:
|
||||
|The public IPv4 pool ID that is used to allocate Elastic IPs (EIPs) when `publish` is set to `External`. You must provision and advertise the pool in the same {aws-short} account and region of the cluster. You must ensure that you have 2n + 1 IPv4 available in the pool where _n_ is the total number of {aws-short} zones used to deploy the Network Load Balancer (NLB) for API, NAT gateways, and bootstrap node. For more information about bring your own IP addresses (BYOIP) in {aws-short}, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-onboard[Onboard your BYOIP].
|
||||
|The public IPv4 pool ID that is used to allocate Elastic IPs (EIPs) when `publish` is set to `External`. You must provision and advertise the pool in the same {aws-short} account and region of the cluster. You must ensure that you have 2n + 1 IPv4 addresses available in the pool where _n_ is the total number of {aws-short} zones used to deploy the Network Load Balancer (NLB) for API, NAT gateways, and bootstrap node. For more information about bring your own IP addresses (BYOIP) in {aws-short}, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-onboard[Onboard your BYOIP].
|
||||
| A valid link:https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-public-ipv4-pools.html[public IPv4 pool id]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
BYOIP can be enabled only for customized installations that have no network restrictions.
|
||||
You can enable BYOIP only for customized installations that do not have any network restrictions.
|
||||
====
|
||||
|
||||
|platform:
|
||||
@@ -1048,7 +1046,7 @@ BYOIP can be enabled only for customized installations that have no network rest
|
||||
aws:
|
||||
vpc:
|
||||
subnets:
|
||||
|A list of subnets in an existing VPC to be used in place of automatically created subnets. You specify a subnet by providing the subnet ID and an optional list of roles that apply to that subnet. If you specify subnet IDs but do not specify roles for any subnet, the subnets' roles will be decided automatically. If you do not specify any roles, you must ensure that any other subnets in your VPC have the `kubernetes.io/cluster/.*: .*` or `kubernetes.io/cluster/unmanaged: true` tags.
|
||||
|A list of subnets in an existing VPC to be used in place of automatically created subnets. You specify a subnet by providing the subnet ID and an optional list of roles that apply to that subnet. If you specify subnet IDs but do not specify roles for any subnet, the subnets' roles are decided automatically. If you do not specify any roles, you must ensure that any other subnets in your VPC have the `kubernetes.io/cluster/.*: .*` or `kubernetes.io/cluster/unmanaged: true` tags.
|
||||
The subnets must be part of the same `machineNetwork[].cidr` ranges that you specify.
|
||||
For a public cluster, specify a public and a private subnet for each availability zone.
|
||||
For a private cluster, specify a private subnet for each availability zone.
|
||||
@@ -1218,7 +1216,7 @@ Optional {rh-openstack} configuration parameters are described in the following
|
||||
platform:
|
||||
openstack:
|
||||
serverGroupPolicy:
|
||||
|Server group policy to apply to the group that will contain the compute machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
|
||||
|The server group policy to apply to the group that contains the compute machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
|
||||
|
||||
An `affinity` policy prevents migrations and therefore affects {rh-openstack} upgrades. The `affinity` policy is not supported.
|
||||
|
||||
@@ -1253,7 +1251,7 @@ Additional networks that are attached to a control plane machine are also attach
|
||||
platform:
|
||||
openstack:
|
||||
serverGroupPolicy:
|
||||
|Server group policy to apply to the group that will contain the control plane machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
|
||||
|Server group policy to apply to the group that contains the control plane machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`.
|
||||
|
||||
An `affinity` policy prevents migrations, and therefore affects {rh-openstack} upgrades. The `affinity` policy is not supported.
|
||||
|
||||
@@ -1894,7 +1892,7 @@ Supplying more than one user-assigned identity is an experimental feature, which
|
||||
defaultMachinePlatform:
|
||||
osImage:
|
||||
publisher:
|
||||
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane and compute machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for both types of machines. Control plane machines do not contribute to licensing costs when using the default image, but if you apply an Azure Marketplace image for a control plane machine, usage costs will apply.
|
||||
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane and compute machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for both types of machines. Control plane machines do not contribute to licensing costs when using the default image. But, if you apply an Azure Marketplace image for a control plane machine, usage costs do apply.
|
||||
|String. The name of the image publisher.
|
||||
|
||||
|platform:
|
||||
@@ -1990,7 +1988,7 @@ Supplying more than one user-assigned identity is an experimental feature, which
|
||||
azure:
|
||||
osImage:
|
||||
publisher:
|
||||
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for control plane machines only. Control plane machines do not contribute to licensing costs when using the default image, but if you apply an Azure Marketplace image for a control plane machine, usage costs will apply.
|
||||
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for control plane machines only. Control plane machines do not contribute to licensing costs when using the default image. But, if you apply an Azure Marketplace image for a control plane machine, usage costs do apply.
|
||||
|String. The name of the image publisher.
|
||||
|
||||
|controlPlane:
|
||||
@@ -2046,11 +2044,7 @@ Supplying more than one user-assigned identity is an experimental feature, which
|
||||
|platform:
|
||||
azure:
|
||||
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. If you specify the `NatGateway` routing strategy, the installation program will only create one NAT gateway. If you specify the `NatGateway` routing strategy, your account must have the `Microsoft.Network/natGateways/read` and `Microsoft.Network/natGateways/write` permissions.
|
||||
|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. The outbound routing must be configured before installing a cluster. The installation program does not configure user-defined routing. If you specify the `NatGateway` routing strategy, the installation program only creates one NAT gateway. If you specify the `NatGateway` routing strategy, your account must have the `Microsoft.Network/natGateways/read` and `Microsoft.Network/natGateways/write` permissions.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
@@ -2322,7 +2316,7 @@ Additional GCP configuration parameters are described in the following table:
|
||||
gcp:
|
||||
osImage:
|
||||
project:
|
||||
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by specifying the location of a custom {op-system} image that the installation program is to use for control plane machines only. Control plane machines do not contribute to licensing costs when using the default image, but if you apply a GCP Marketplace image for a control plane machine, usage costs will apply.
|
||||
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by specifying the location of a custom {op-system} image that the installation program is to use for control plane machines only. Control plane machines do not contribute to licensing costs when using the default image. But, if you apply a GCP Marketplace image for a control plane machine, usage costs do apply.
|
||||
|String. The name of GCP project where the image is located.
|
||||
|
||||
|controlPlane:
|
||||
@@ -2353,7 +2347,7 @@ Additional GCP configuration parameters are described in the following table:
|
||||
platform:
|
||||
gcp:
|
||||
serviceAccount:
|
||||
|Specifies the email address of a {gcp-short} service account to be used during installations. This service account will be used to provision compute machines.
|
||||
|Specifies the email address of a {gcp-short} service account to be used during installations. This service account is used to provision compute machines.
|
||||
|String. The email address of the service account.
|
||||
|
||||
|platform:
|
||||
@@ -2679,7 +2673,7 @@ If you specify any value other than `Disabled`, you must set `controlPlane.platf
|
||||
platform:
|
||||
gcp:
|
||||
serviceAccount:
|
||||
|Specifies the email address of a {gcp-short} service account to be used during installations. This service account will be used to provision control plane machines.
|
||||
|Specifies the email address of a {gcp-short} service account to be used during installations. This service account is used to provision control plane machines.
|
||||
[IMPORTANT]
|
||||
====
|
||||
In the case of shared VPC installations, when the service account is not provided, the installer service account must have the `resourcemanager.projects.getIamPolicy` and `resourcemanager.projects.setIamPolicy` permissions in the host project.
|
||||
@@ -2849,7 +2843,7 @@ The CRN must be enclosed in quotes ("").
|
||||
encryptionKey:
|
||||
d|A Key Protect root key that should be used to encrypt the root (boot) volume of all of the cluster's machines.
|
||||
|
||||
When specified as part of the default machine configuration, all managed storage classes are updated with this key. As such, data volumes that are provisioned after the installation are also encrypted using this key.
|
||||
When specified as part of the default machine configuration, all managed storage classes are updated with this key. Data volumes that are provisioned after the installation are also encrypted using this key.
|
||||
d|The CRN of the root key.
|
||||
|
||||
The CRN must be enclosed in quotes ("").
|
||||
@@ -2858,8 +2852,10 @@ The CRN must be enclosed in quotes ("").
|
||||
ibmcloud:
|
||||
resourceGroupName:
|
||||
|The name of an existing resource group.
|
||||
By default, an installer-provisioned VPC and cluster resources are placed in this resource group. When not specified, the installation program creates the resource group for the cluster.
|
||||
If you are deploying the cluster into an existing VPC, the installer-provisioned cluster resources are placed in this resource group. When not specified, the installation program creates the resource group for the cluster. The VPC resources that you have provisioned must exist in a resource group that you specify using the `networkResourceGroupName` parameter.
|
||||
By default, an installer-provisioned VPC and cluster resources are created and placed in this resource group. The installation program creates the resource group for the cluster if you do not specify these parameters.
|
||||
|
||||
If you are deploying the cluster into an existing VPC, the installation-program-provisioned cluster resources are placed in this resource group. The installation program creates the resource group for the cluster if you do not specify these parameters. The VPC resources that you have provisioned must exist in a resource group that you specify using the `networkResourceGroupName` parameter.
|
||||
|
||||
In either case, this resource group must only be used for a single cluster installation, as the cluster components assume ownership of all of the resources in the resource group. [^1^]
|
||||
|String, for example `existing_resource_group`.
|
||||
|
||||
@@ -2903,7 +2899,7 @@ Valid names include:
|
||||
|platform:
|
||||
ibmcloud:
|
||||
networkResourceGroupName:
|
||||
|The name of an existing resource group. This resource contains the existing VPC and subnets to which the cluster will be deployed. This parameter is required when deploying the cluster to a VPC that you have provisioned.
|
||||
|The name of an existing resource group. This resource contains the existing VPC and subnets to which the cluster is deployed. This parameter is required when deploying the cluster to a VPC that you have provisioned.
|
||||
|String, for example `existing_network_resource_group`.
|
||||
|
||||
|platform:
|
||||
@@ -3498,11 +3494,7 @@ Additional Azure configuration parameters are described in the following table:
|
||||
|platform:
|
||||
azure:
|
||||
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.
|
||||
|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. The outbound routing must be configured before installing a cluster. The installation program does not configure user-defined routing.
|
||||
|`LoadBalancer` or `UserDefinedRouting`. The default is `LoadBalancer`.
|
||||
|
||||
|platform:
|
||||
@@ -3618,7 +3610,7 @@ The name of one or more failures domains.
|
||||
dataDisks:
|
||||
dataSourceImage:
|
||||
referenceName:
|
||||
|Optional. The reference name of the data source image in the failure domain. If you use this parameter, you must configure a matching `dataSourceImage` (with the same `referenceName`) in each failure domain that the compute nodes occupy. For more information about configuring failure domains, see _Configuring failure domains_ in the _Installing a cluster on Nutanix_ page.
|
||||
|Optional. The reference name of the data source image in the failure domain. If you use this parameter, you must configure a matching `dataSourceImage` with the same `referenceName` in each failure domain that the compute nodes occupy. For more information about configuring failure domains, see _Configuring failure domains_ in the _Installing a cluster on Nutanix_ page.
|
||||
|String
|
||||
|
||||
|compute:
|
||||
@@ -3646,8 +3638,8 @@ If the disk type is "CDRom", valid values are "IDE" or "SATA".
|
||||
dataDisks:
|
||||
deviceProperties:
|
||||
deviceIndex:
|
||||
|The index of the disk address. Valid values are non-negative integers including 0. The device index for disks that share the same adapter type should start at 0 and increase consecutively. The default value is 0. For each virtual machine, the `Disk.SCSI.0` and `CDRom.IDE.0` indices are reserved. If you use the `Disk.SCSI` or `CDRom.IDE` disk and adapter types, the `deviceIndex` should start at 1.
|
||||
|Non-negative integer, including 0.
|
||||
|The index of the disk address. Valid values are non-negative integers including `0`. The device index for disks that share the same adapter type should start at 0 and increase consecutively. The default value is `0`. For each virtual machine, the `Disk.SCSI.0` and `CDRom.IDE.0` indices are reserved. If you use the `Disk.SCSI` or `CDRom.IDE` disk and adapter types, the `deviceIndex` should start at `1`.
|
||||
|Non-negative integer, including `0`.
|
||||
|
||||
|compute:
|
||||
platform:
|
||||
@@ -3672,7 +3664,7 @@ If the disk type is "CDRom", valid values are "IDE" or "SATA".
|
||||
dataDisks:
|
||||
storageConfig:
|
||||
diskMode:
|
||||
|The disk mode. Valid values are "Standard" or "Flash", and the default is "Standard".
|
||||
|The disk mode. Valid values are `Standard` or `Flash`, and the default is `Standard`.
|
||||
|String
|
||||
|
||||
|compute:
|
||||
@@ -3692,7 +3684,7 @@ If the disk type is "CDRom", valid values are "IDE" or "SATA".
|
||||
storageConfig:
|
||||
storageContainer:
|
||||
referenceName:
|
||||
|Optional. The reference name of the storage container in the failure domain. If you use this, you must configure a matching `storageContainer` (with the same `referenceName`) in each failure domain the compute nodes occupy. For more information about configuring failure domains, see _Configuring failure domains_ in the _Installing a cluster on Nutanix_ page.
|
||||
|Optional. The reference name of the storage container in the failure domain. If you use this, you must configure a matching `storageContainer` with the same `referenceName` in each failure domain the compute nodes occupy. For more information about configuring failure domains, see _Configuring failure domains_ in the _Installing a cluster on Nutanix_ page.
|
||||
|String
|
||||
|
||||
|compute:
|
||||
@@ -3813,7 +3805,7 @@ The name of one or more failures domains.
|
||||
uuid:
|
||||
subnetUUIDs:
|
||||
-
|
||||
a|By default, the installation program installs cluster machines to a single Prism Element instance. A maximum of 32 subnets for each failure domain (Prism Element) in an {product-title} cluster is supported. All `subnetUUID` values must be unique. You can specify additional Prism Element instances for fault tolerance, and then apply them to:
|
||||
a|By default, the installation program installs cluster machines to a single Prism Element instance. A maximum of 32 subnets for each failure domain (Prism Element) in an {product-title} cluster is supported. All `subnetUUID` values must be unique. You can specify additional Prism Element instances for fault tolerance, and then apply them to:
|
||||
|
||||
* The cluster's default machine configuration
|
||||
* Only control plane or compute machine pools
|
||||
|
||||
Reference in New Issue
Block a user