mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Update
This commit is contained in:
Rolfe Dlugy-Hegwer
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
01af57e5d8
commit
324bbbb7bc
@@ -197,7 +197,7 @@ Create a [filename]#Dockerfile# at the root of your repository.
|
||||
|
||||
Usage: identity or identities as appropriate
|
||||
|
||||
Both the username and list of groups the user belongs to.
|
||||
Both the user name and list of groups the user belongs to.
|
||||
|
||||
''''
|
||||
=== image
|
||||
|
||||
@@ -51,10 +51,9 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-initializing.adoc[leveloffset=+1]
|
||||
|
||||
// The RHV installer for 4.4 GA has not been implemented or tested support for most configuration parameters. This will be fixed in an upcoming z-stream. When that happens, (1) uncomment the following line, (2) update the contents of the included file to display RHV-supported parameters, and (3) remove this comment.
|
||||
// include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
|
||||
include::modules/installing-rhv-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installing-rhv-config-yaml.adoc[leveloffset=+1]
|
||||
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-launching-installer.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -71,6 +71,9 @@ ifeval::["{context}" == "installing-openstack-user-kuryr"]
|
||||
:osp:
|
||||
:osp-kuryr:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-rhv-customizations"]
|
||||
:rhv:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations"]
|
||||
:vsphere:
|
||||
endif::[]
|
||||
@@ -79,17 +82,11 @@ endif::[]
|
||||
[id="installation-configuration-parameters_{context}"]
|
||||
= Installation configuration parameters
|
||||
|
||||
Before you deploy an {product-title} cluster, you provide parameter values to
|
||||
describe your account on the cloud platform that hosts your cluster
|
||||
and optionally customize your
|
||||
cluster's platform. When you create the `install-config.yaml` installation
|
||||
configuration file, you provide values for the required parameters through the
|
||||
command line. If you customize your cluster, you can modify the
|
||||
`install-config.yaml` file to provide more details about the platform.
|
||||
Before you deploy an {product-title} cluster, you provide parameter values to describe your account on the cloud platform that hosts your cluster and optionally customize your cluster's platform. When you create the `install-config.yaml` installation configuration file, you provide values for the required parameters through the command line. If you customize your cluster, you can modify the `install-config.yaml` file to provide more details about the platform.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You cannot modify these parameters in the `install-config.yaml` file after installation.
|
||||
After installation, you cannot modify these parameters in the `install-config.yaml` file.
|
||||
====
|
||||
|
||||
.Required parameters
|
||||
@@ -97,44 +94,32 @@ You cannot modify these parameters in the `install-config.yaml` file after insta
|
||||
|====
|
||||
|Parameter|Description|Values
|
||||
|
||||
|`apiVersion`
|
||||
|The API version for the install-config.yaml content. The current version is `v1`. The installer may also support older API versions.
|
||||
|String
|
||||
|
||||
|`baseDomain`
|
||||
|The base domain of your cloud provider. This value is used to create routes
|
||||
to your {product-title} 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.
|
||||
|The base domain of your cloud provider. The base domain is used to create routes to your {product-title} 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`.
|
||||
|
||||
|`controlPlane.platform`
|
||||
|The cloud provider to host the control plane machines. This parameter value
|
||||
must match the `compute.platform` parameter value.
|
||||
|`aws`, `azure`, `gcp`, `openstack`, `vsphere`, or `{}`
|
||||
|
||||
|`compute.platform`
|
||||
|The cloud provider to host the worker machines. This parameter value
|
||||
must match the `controlPlane.platform` parameter value.
|
||||
|`aws`, `azure`, `gcp`, `openstack`, `vsphere`, or `{}`
|
||||
|`metadata`
|
||||
|Kubernetes resource ObjectMeta, from which only the `name` parameter is consumed.
|
||||
|Object
|
||||
|
||||
|`metadata.name`
|
||||
|The name of your cluster.
|
||||
|A string that contains lowercase letters, hyphens (-), or periods (.), such as `dev`.
|
||||
|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`.
|
||||
ifdef::osp[]
|
||||
The string must be 14 characters or fewer long.
|
||||
endif::osp[]
|
||||
|
||||
|`platform.<platform>.region`
|
||||
|The region to deploy your cluster in.
|
||||
|A valid region for your cloud, such as `us-east-1` for AWS, `centralus`
|
||||
for Azure. {rh-openstack-first} and vSphere do not use this parameter.
|
||||
|`platform`
|
||||
|The configuration for the specific platform upon which to perform the installation: `aws`, `baremetal`, `azure`, `openstack`, `ovirt`, `vsphere`. For additional information about `platform.<platform>` parameters, consult the following table for your specific platform.
|
||||
|Object
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
|`pullSecret`
|
||||
|The pull secret that you obtained from the
|
||||
link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site.
|
||||
You use this pull secret to authenticate with the services that are
|
||||
provided by the included authorities, including Quay.io, which serves the
|
||||
container images for {product-title} components.
|
||||
ifdef::openshift-origin[]
|
||||
This field is optional.
|
||||
endif::[]
|
||||
|Get this pull secret from link:https://cloud.redhat.com/openshift/install/pull-secret[] to authenticate downloading container images for {product-title} components from services such as Quay.io.
|
||||
|
|
||||
[source,json]
|
||||
----
|
||||
@@ -151,6 +136,8 @@ endif::[]
|
||||
}
|
||||
}
|
||||
----
|
||||
endif::[]
|
||||
|
||||
|====
|
||||
|
||||
.Optional parameters
|
||||
@@ -158,26 +145,20 @@ endif::[]
|
||||
|====
|
||||
|Parameter|Description|Values
|
||||
|
||||
|`sshKey`
|
||||
|The SSH key to use to access your cluster machines.
|
||||
[NOTE]
|
||||
====
|
||||
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your `ssh-agent` process uses.
|
||||
====
|
||||
|A valid, local public SSH key that you added to the `ssh-agent` process.
|
||||
|`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
|
||||
|
||||
|`fips`
|
||||
|Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. 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.
|
||||
|`false` or `true`
|
||||
|`compute`
|
||||
|The configuration for the machines that comprise the compute nodes.
|
||||
|Array of machine-pool objects. For details, see the following "Machine-pool" table.
|
||||
|
||||
|`publish`
|
||||
|How to publish the user-facing endpoints of your cluster.
|
||||
|`Internal` or `External`. Set `publish` to `Internal` to deploy a private cluster, which cannot be accessed from the internet. The default value is `External`.
|
||||
|`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 `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.
|
||||
|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
|
||||
@@ -185,14 +166,28 @@ 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.
|
||||
|`aws`, `azure`, `gcp`, `openstack`, `ovirt`, `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`.
|
||||
|
||||
|`controlPlane`
|
||||
|The configuration for the machines that comprise the control plane.
|
||||
|Array of machine-pool objects. For details, see the following "Machine-pool" table.
|
||||
|
||||
|`controlPlane.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 `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.
|
||||
|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
|
||||
@@ -200,11 +195,86 @@ 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.
|
||||
|`aws`, `azure`, `gcp`, `openstack`, `ovirt`, `vsphere`, or `{}`
|
||||
|
||||
|`controlPlane.replicas`
|
||||
|The number of control plane machines to provision.
|
||||
|A positive integer greater than or equal to `3`. The default value is `3`.
|
||||
|
||||
|`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.
|
||||
|`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 may also contain the same images.
|
||||
|Array of strings
|
||||
|
||||
|`networking`
|
||||
|The configuration for the Pod network provider in the cluster.
|
||||
|Object
|
||||
|
||||
|`networking.clusterNetwork`
|
||||
|The IP address pools for Pods. The default is `10.128.0.0/14` with a host prefix of `/23`.
|
||||
|Array of objects
|
||||
|
||||
|`networking.clusterNetwork.cidr`
|
||||
|Required if you use `networking.clusterNetwork`. The IP block address pool.
|
||||
|IP network. IP networks are represented as strings using Classless Inter-Domain Routing (CIDR) notation with a traditional IP address or network number, followed by the "/" (slash) character, followed by a decimal value between 0 and 32 that describes the number of significant bits. For example, `10.0.0.0/16` represents IP addresses `10.0.0.0` through `10.0.255.255`.
|
||||
|
||||
|`networking.clusterNetwork.hostPrefix`
|
||||
|Required if you use `networking.clusterNetwork`. The prefix size to allocate to each node from the CIDR. For example, 24 would allocate 2^8=256 adresses to each node.
|
||||
|Integer
|
||||
|
||||
|`networking.machineNetwork`
|
||||
|The IP address pools for machines.
|
||||
|Array of objects
|
||||
|
||||
|`networking.machineNetwork.cidr`
|
||||
|Required if you use `networking.machineNetwork`. The IP block address pool. The default is `10.0.0.0/16` for all platforms other than libvirt. For libvirt, the default is `192.168.126.0/24`.
|
||||
|IP network. IP networks are represented as strings using Classless Inter-Domain Routing (CIDR) notation with a traditional IP address or network number, followed by the "/" (slash) character, followed by a decimal value between 0 and 32 that describes the number of significant bits. For example, `10.0.0.0/16` represents IP addresses `10.0.0.0` through `10.0.255.255`.
|
||||
|
||||
|`networking.networkType`
|
||||
|The type of network to install. The default is `OpenShiftSDN`.
|
||||
|String
|
||||
|
||||
|`networking.serviceNetwork`
|
||||
|The IP address pools for services. The default is 172.30.0.0/16.
|
||||
|Array of IP networks. IP networks are represented as strings using Classless Inter-Domain Routing (CIDR) notation with a traditional IP address or network number, followed by the "/" (slash) character, followed by a decimal value between 0 and 32 that describes the number of significant bits. For example, `10.0.0.0/16` represents IP addresses `10.0.0.0` through `10.0.255.255`.
|
||||
|
||||
|`publish`
|
||||
|How to publish or expose the user-facing endpoints of your cluster, such as the Kubernetes API, OpenShift routes.
|
||||
|`Internal` or `External`. To deploy a private cluster, which cannot be accessed from the internet, set `publish` to `Internal`. The default value is `External`.
|
||||
|
||||
|`sshKey`
|
||||
| The SSH key or keys to authenticate access your cluster machines.
|
||||
[NOTE]
|
||||
====
|
||||
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your `ssh-agent` process uses.
|
||||
====
|
||||
a|One or more keys. For example:
|
||||
```
|
||||
sshKey: |
|
||||
<key1>
|
||||
<key2>
|
||||
<key3>
|
||||
```
|
||||
|====
|
||||
|
||||
|
||||
ifdef::aws[]
|
||||
.Optional AWS parameters
|
||||
[cols=".^2,.^3,.^5a",options="header"]
|
||||
@@ -226,8 +296,7 @@ such as `io1`.
|
||||
|
||||
|`compute.platform.aws.type`
|
||||
|The EC2 instance type for the compute machines.
|
||||
|Valid link:https://aws.amazon.com/ec2/instance-types/[AWS instance type],
|
||||
such as `c5.9xlarge`.
|
||||
|Valid link:https://aws.amazon.com/ec2/instance-types/[AWS instance type], such as `c5.9xlarge`.
|
||||
|
||||
|`compute.platform.aws.zones`
|
||||
|The availability zones where the installation program creates machines for the compute MachinePool. If you provide your own VPC, you must provide a subnet in that availability zone.
|
||||
@@ -236,32 +305,24 @@ link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
|
||||
|
||||
|`compute.aws.region`
|
||||
|The AWS region that the installation program creates compute resources in.
|
||||
|Valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS region],
|
||||
such as `us-east-1`.
|
||||
|Any valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS region], such as `us-east-1`.
|
||||
|
||||
|`controlPlane.platform.aws.type`
|
||||
|The EC2 instance type for the control plane machines.
|
||||
|Valid link:https://aws.amazon.com/ec2/instance-types/[AWS instance type],
|
||||
such as `c5.9xlarge`.
|
||||
|Valid link:https://aws.amazon.com/ec2/instance-types/[AWS instance type], such as `c5.9xlarge`.
|
||||
|
||||
|`controlPlane.platform.aws.zones`
|
||||
|The availability zones where the installation program creates machines for the
|
||||
control plane MachinePool.
|
||||
|A list of valid AWS availability zones, such as `us-east-1c`, in a
|
||||
link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
|
||||
|A list of valid AWS availability zones, such as `us-east-1c`, in a link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
|
||||
|
||||
|`controlPlane.aws.region`
|
||||
|The AWS region that the installation program creates control plane resources in.
|
||||
|Valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS region],
|
||||
such as `us-east-1`.
|
||||
|Valid link:https://docs.aws.amazon.com/general/latest/gr/rande.html[AWS region], such as `us-east-1`.
|
||||
|
||||
|`platform.aws.userTags`
|
||||
|A map of keys and values that the installation program adds as tags to all
|
||||
resources that it creates.
|
||||
|Any valid YAML map, such as key value pairs in the `<key>: <value>` format.
|
||||
For more information about AWS tags,
|
||||
see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html[Tagging Your Amazon EC2 Resources]
|
||||
in the AWS documentation.
|
||||
|A map of keys and values that the installation program adds as tags to all resources that it creates.
|
||||
|Any valid YAML map, such as key value pairs in the `<key>: <value>` format. For more information about AWS tags, see link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html[Tagging Your Amazon EC2 Resources] in the AWS documentation.
|
||||
|
||||
|`platform.aws.subnets`
|
||||
|If you provide the VPC instead of allowing the installation program to create the VPC for you, specify the subnet for the cluster to use. The subnet must be part of the same `machineNetwork[].cidr` ranges that you specify. For a standard cluster, specify a public and a private subnet for each availability zone. For a private cluster, specify a private subnet for each availability zone.
|
||||
@@ -350,16 +411,36 @@ ifdef::osp[]
|
||||
----
|
||||
|
||||
|`platform.openstack.machinesSubnet`
|
||||
|The UUID of a {rh-openstack} subnet that the cluster's nodes use. Nodes and VIP ports are created on this subnet.
|
||||
|The UUID of a {rh-openstack} subnet that the cluster's nodes use. Nodes and virtual IP (VIP) ports are created on this subnet.
|
||||
|
||||
The first item in `networking.machineNetwork` must match the value of `machinesSubnet`.
|
||||
|
||||
If you deploy to a custom subnet, you cannot specify an external DNS server to the {product-title} installer. Instead, link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.0/html/command_line_interface_reference/subnet[add DNS to the subnet in {rh-openstack}].
|
||||
|
||||
|A UUID as a string. For example, `fa806b2f-ac49-4bce-b9db-124bc64209bf`.
|
||||
|A UUID as a string, for example `fa806b2f-ac49-4bce-b9db-124bc64209bf`.
|
||||
|
||||
|`pullSecret`
|
||||
|Get this pull secret from link:https://cloud.redhat.com/openshift/install/pull-secret[] to authenticate downloading container images for {product-title} components from services such as Quay.io.
|
||||
|
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"auths":{
|
||||
"cloud.openshift.com":{
|
||||
"auth":"b3Blb=",
|
||||
"email":"you@example.com"
|
||||
},
|
||||
"quay.io":{
|
||||
"auth":"b3Blb=",
|
||||
"email":"you@example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
|====
|
||||
|
||||
|
||||
endif::osp[]
|
||||
|
||||
ifdef::azure[]
|
||||
@@ -385,7 +466,7 @@ minimum supported disk size is `120`.
|
||||
|
||||
|`platform.azure.region`
|
||||
|The name of the Azure region that hosts your cluster.
|
||||
|Any valid region name.
|
||||
|Any valid region name, such as `centralus`.
|
||||
|
||||
|`platform.azure.zone`
|
||||
|List of availability zones to place machines in. For high availability, specify
|
||||
@@ -436,8 +517,7 @@ ifdef::gcp[]
|
||||
|The GCP machine type.
|
||||
|
||||
|`platform.gcp.zones`
|
||||
|The availability zones where the installation program creates machines for the
|
||||
specified MachinePool.
|
||||
|The availability zones where the installation program creates machines for the specified MachinePool.
|
||||
|A list of valid link:https://cloud.google.com/compute/docs/regions-zones#available[GCP availability zones], such as `us-central1-a`, in a
|
||||
link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
|
||||
|
||||
@@ -452,6 +532,85 @@ link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
|
||||
|
||||
endif::gcp[]
|
||||
|
||||
ifdef::rhv[]
|
||||
|
||||
.Additional {rh-virtualization-first} parameters for clusters
|
||||
[cols=".^2,.^3a,.^3a",options="header"]
|
||||
|====
|
||||
|Parameter|Description|Values
|
||||
|
||||
|`platform.ovirt.ovirt_cluster_id`
|
||||
|Required. The Cluster where the VMs will be created.
|
||||
|String. For example: `68833f9f-e89c-4891-b768-e2ba0815b76b`
|
||||
|
||||
|`platform.ovirt.ovirt_storage_domain_id`
|
||||
|Required. The Storage Domain ID where the VM disks will be created.
|
||||
|String. For example: `ed7b0f4e-0e96-492a-8fff-279213ee1468`
|
||||
|
||||
|`platform.ovirt.ovirt_network_name`
|
||||
|Required. The network name where the VM nics will be created.
|
||||
|String. For example: `ocpcluster`
|
||||
|
||||
|`platform.ovirt.vnicProfileID`
|
||||
|Required. The vNIC profile ID of the VM network interfaces. This can be inferred if the cluster network has a single profile.
|
||||
|String. For example: `3fa86930-0be5-4052-b667-b79f0a729692`
|
||||
|
||||
|`platform.ovirt.api_vip`
|
||||
|Required. An IP address on the machineNetwork that will be assigned to the API virtual IP (VIP). You can access the OpenShift API at this endpoint.
|
||||
|String. Example: `10.46.8.230`
|
||||
|
||||
|`platform.ovirt.ingress_vip`
|
||||
|Required. An IP address on the machineNetwork that will be assigned to the Ingress virtual IP (VIP).
|
||||
|String. Example: `10.46.8.232`
|
||||
|====
|
||||
|
||||
|
||||
.Additional {rh-virtualization} parameters for machine pools
|
||||
[cols=".^2,.^3a,.^3a",options="header"]
|
||||
|====
|
||||
|Parameter|Description|Values
|
||||
|
||||
|`<machine-pool>.platform.ovirt.cpu`
|
||||
|Optional. Defines the CPU of the VM.
|
||||
|Object
|
||||
|
||||
|`<machine-pool>.platform.ovirt.cpu.cores`
|
||||
|Required if you use `<machine-pool>.platform.ovirt.cpu`. The number of cores. Total virtual CPUs (vCPUs) is cores * sockets.
|
||||
|Integer
|
||||
|
||||
|`<machine-pool>.platform.ovirt.cpu.sockets`
|
||||
|Required if you use `<machine-pool>.platform.ovirt.cpu`. The number of sockets per core. Total virtual CPUs (vCPUs) is cores * sockets.
|
||||
|Integer
|
||||
|
||||
|`<machine-pool>.platform.ovirt.memoryMB`
|
||||
|Optional. Memory of the VM in MiB.
|
||||
| Integer
|
||||
|
||||
|`<machine-pool>.platform.ovirt.instanceTypeID`
|
||||
|Optional. The VM instance-type, such as `tiny`, `small`, `medium`, `large`, or `xlarge`.
|
||||
|String
|
||||
// TBD - Please confirm the "url" in front of instanceTypeID
|
||||
|
||||
|`<machine-pool>.platform.ovirt.osDisk`
|
||||
|Optional. Defines the first and bootable disk of the VM.
|
||||
|String
|
||||
|
||||
|`<machine-pool>.platform.ovirt.osDisk.sizeGB`
|
||||
|Required if you use `<machine-pool>.platform.ovirt.osDisk`. Size of the disk in GiB.
|
||||
|Number
|
||||
|
||||
|`<machine-pool>.platform.ovirt.vmType`
|
||||
|Optional. The VM workload type, such as `high-performance`, `server`, or `desktop`.
|
||||
|String
|
||||
|====
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
You can replace `<machine-pool>` with `controlPlane` or `compute`.
|
||||
====
|
||||
|
||||
endif::rhv[]
|
||||
|
||||
ifdef::vsphere[]
|
||||
.Additional VMware vSphere cluster parameters
|
||||
[cols=".^2,.^3a,.^3a",options="header"]
|
||||
@@ -494,11 +653,11 @@ in vSphere.
|
||||
|String.
|
||||
|
||||
|`platform.vsphere.apiVIP`
|
||||
|The virtual IP address that you configured for control plane API access.
|
||||
|The virtual IP (VIP) address that you configured for control plane API access.
|
||||
|An IP address, for example `128.0.0.1`.
|
||||
|
||||
|`platform.vsphere.ingressVIP`
|
||||
|The virtual IP address that you configured for cluster ingress.
|
||||
|The virtual IP (VIP) address that you configured for cluster ingress.
|
||||
|An IP address, for example `128.0.0.1`.
|
||||
|====
|
||||
|
||||
@@ -516,7 +675,7 @@ in vSphere.
|
||||
|Integer.
|
||||
|
||||
|`platform.vsphere.coresPerSocket`
|
||||
|The number of cores per socket in a virtual machine. The number of vCPUs on the virtual machine is will be `platform.vsphere.cpus`/`platform.vsphere.coresPerSocket`. The default value is `1`
|
||||
|The number of cores per socket in a virtual machine. The number of virtual CPUs (vCPUs) on the virtual machine is `platform.vsphere.cpus`/`platform.vsphere.coresPerSocket`. The default value is `1`
|
||||
|Integer.
|
||||
|
||||
|`platform.vsphere.memoryMB`
|
||||
@@ -578,6 +737,9 @@ ifeval::["{context}" == "installing-openstack-user-kuryr"]
|
||||
:!osp:
|
||||
:!osp-kuryr:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-rhv-customizations"]
|
||||
:!rhv:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations"]
|
||||
:!vsphere:
|
||||
endif::[]
|
||||
|
||||
@@ -269,31 +269,31 @@ For example:
|
||||
https://rhv-env.virtlab.example.com/ovirt-engine/api
|
||||
----
|
||||
+
|
||||
... For `Is the installed oVirt certificate trusted?`, enter `Yes` since you have already set up a CA certificate. Otherwise, enter `No`.
|
||||
... For `Is the oVirt CA trusted locally?`, enter `Yes` since you have already set up a CA certificate. Otherwise, enter `No`.
|
||||
... For `oVirt's CA bundle`, if you entered `Yes` for the preceding question, copy the certificate content from `/etc/pki/ca-trust/source/anchors/ca.pem` and paste it here. Then, press `Enter` twice. Otherwise, if you entered `No` for the preceding question, this question does not appear.
|
||||
... For `Enter the oVirt engine username`, enter the username and profile of the {rh-virtualization} administrator using this format:
|
||||
... For `oVirt engine username`, enter the user name and profile of the {rh-virtualization} administrator using this format:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
<username>@<profile> <1>
|
||||
----
|
||||
<1> For `<username>`, specify the username of an {rh-virtualization} administrator. For `<profile>`, specify the login profile, which you can get by going to the {rh-virtualization} Administration Portal login page and reviewing the *Profile* dropdown list. Together, the user name and profile should look similar to this example:
|
||||
<1> For `<username>`, specify the user name of an {rh-virtualization} administrator. For `<profile>`, specify the login profile, which you can get by going to the {rh-virtualization} Administration Portal login page and reviewing the *Profile* dropdown list. Together, the user name and profile should look similar to this example:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
admin@internal
|
||||
----
|
||||
+
|
||||
... For `Enter password`, enter the {rh-virtualization} admin password.
|
||||
... For `Select the oVirt cluster`, select the cluster for installing {product-title}.
|
||||
... For `Select the oVirt storage domain`, select the storage domain for installing {product-title}.
|
||||
... For `Select the oVirt network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
|
||||
... For `Enter the internal API Virtual IP`, enter the static IP address you set aside for the cluster’s REST API.
|
||||
... For `Enter the internal DNS Virtual IP`, enter the static IP address you set aside for the cluster’s internal DNS service.
|
||||
... For `Enter the ingress IP`, enter the static IP address you reserved for the wildcard apps domain.
|
||||
... For `Base domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com`
|
||||
... For `Cluster name`, enter the name of the cluster. For example, `my-cluster`. Use cluster name from the externally registered/resolvable DNS entries you created for the {product-title} REST API and apps domain names. The installation program also gives this name to the cluster in the {rh-virtualization} environment.
|
||||
... For `Pull secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site.
|
||||
... For `oVirt engine password`, enter the {rh-virtualization} admin password.
|
||||
... For `oVirt cluster`, select the cluster for installing {product-title}.
|
||||
... For `oVirt storage domain`, select the storage domain for installing {product-title}.
|
||||
... For `oVirt network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
|
||||
... For `Internal API Virtual IP`, enter the static IP address you set aside for the cluster’s REST API.
|
||||
... For `Internal DNS Virtual IP`, enter the static IP address you set aside for the cluster’s internal DNS service.
|
||||
... For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain.
|
||||
... For `Base Domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com`
|
||||
... For `Cluster Name`, enter the name of the cluster. For example, `my-cluster`. Use cluster name from the externally registered/resolvable DNS entries you created for the {product-title} REST API and apps domain names. The installation program also gives this name to the cluster in the {rh-virtualization} environment.
|
||||
... For `Pull Secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site.
|
||||
endif::rhv[]
|
||||
ifndef::rhv[]
|
||||
... Paste the pull secret that you obtained from the
|
||||
|
||||
@@ -294,32 +294,32 @@ For example:
|
||||
https://rhv-env.virtlab.example.com/ovirt-engine/api
|
||||
----
|
||||
+
|
||||
.. For `Is the installed oVirt certificate trusted?`, enter `Yes` since you have already set up a CA certificate. Otherwise, enter `No`.
|
||||
.. For `Is the oVirt CA trusted locally?`, enter `Yes` since you have already set up a CA certificate. Otherwise, enter `No`.
|
||||
.. For `oVirt's CA bundle`, if you entered `Yes` for the preceding question, copy the certificate content from `/etc/pki/ca-trust/source/anchors/ca.pem` and paste it here. Then, press `Enter` twice. Otherwise, if you entered `No` for the preceding question, this question does not appear.
|
||||
.. For `Enter the oVirt engine username`, enter the username and profile of the {rh-virtualization} administrator using this format:
|
||||
.. For `oVirt engine username`, enter the user name and profile of the {rh-virtualization} administrator using this format:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
<username>@<profile> <1>
|
||||
----
|
||||
+
|
||||
<1> For `<username>`, specify the username of an {rh-virtualization} administrator. For `<profile>`, specify the login profile, which you can get by going to the {rh-virtualization} Administration Portal login page and reviewing the *Profile* dropdown list. Together, the user name and profile should look similar to this example:
|
||||
<1> For `<username>`, specify the user name of an {rh-virtualization} administrator. For `<profile>`, specify the login profile, which you can get by going to the {rh-virtualization} Administration Portal login page and reviewing the *Profile* dropdown list. Together, the user name and profile should look similar to this example:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
admin@internal
|
||||
----
|
||||
+
|
||||
.. For `Enter password`, enter the {rh-virtualization} admin password.
|
||||
.. For `Select the oVirt cluster`, select the cluster for installing {product-title}.
|
||||
.. For `Select the oVirt storage domain`, select the storage domain for installing {product-title}.
|
||||
.. For `Select the oVirt network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
|
||||
.. For `Enter the internal API Virtual IP`, enter the static IP address you set aside for the cluster’s REST API.
|
||||
.. For `Enter the internal DNS Virtual IP`, enter the static IP address you set aside for the cluster’s internal DNS service.
|
||||
.. For `Enter the ingress IP`, enter the static IP address you reserved for the wildcard apps domain.
|
||||
.. For `Base domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com`
|
||||
.. For `Cluster name`, enter the name of the cluster. For example, `my-cluster`. Use cluster name from the externally registered/resolvable DNS entries you created for the {product-title} REST API and apps domain names. The installation program also gives this name to the cluster in the {rh-virtualization} environment.
|
||||
.. For `Pull secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site.
|
||||
.. For `oVirt engine password`, enter the {rh-virtualization} admin password.
|
||||
.. For `oVirt cluster`, select the cluster for installing {product-title}.
|
||||
.. For `oVirt storage domain`, select the storage domain for installing {product-title}.
|
||||
.. For `oVirt network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
|
||||
.. For `Internal API Virtual IP`, enter the static IP address you set aside for the cluster’s REST API.
|
||||
.. For `Internal DNS Virtual IP`, enter the static IP address you set aside for the cluster’s internal DNS service.
|
||||
.. For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain.
|
||||
.. For `Base Domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com`
|
||||
.. For `Cluster Name`, enter the name of the cluster. For example, `my-cluster`. Use cluster name from the externally registered/resolvable DNS entries you created for the {product-title} REST API and apps domain names. The installation program also gives this name to the cluster in the {rh-virtualization} environment.
|
||||
.. For `Pull Secret`, copy the pull secret from the `pull-secret.txt` file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site.
|
||||
endif::rhv[]
|
||||
--
|
||||
endif::no-config[]
|
||||
|
||||
@@ -4,13 +4,13 @@
|
||||
// * installing/installing_rhv/installing-rhv-default.adoc
|
||||
|
||||
[id="installing-rhv-installation-configuration-parameters_{context}"]
|
||||
= Installation configuration parameters for {rh-virtualization}
|
||||
= Example `install-config.yaml` files for {rh-virtualization-first}
|
||||
|
||||
Before you deploy an {product-title} cluster, you provide parameter values to describe your account on the cloud platform that hosts your cluster and optionally customize your cluster's platform. When you create the `install-config.yaml` installation configuration file, you provide values for the required parameters through the command line. If you customize your cluster, you can modify the `install-config.yaml` file to provide more details about the platform.
|
||||
You can customize the {product-title} cluster the installation program creates by changing the parameters and parameter values in the `install-config.yaml` file.
|
||||
|
||||
The following example is specific to installing {product-title} on {rh-virtualization}. It uses numbered callouts to show which parameter values you can edit. Do not modify the parameters values without callouts.
|
||||
The following example is specific to installing {product-title} on {rh-virtualization}.
|
||||
|
||||
This file is located in the `<installation directory>` you specified when you ran the following command.
|
||||
This file is located in the `<installation_directory>` you specified when you ran the following command.
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo ./openshift-install create install-config --dir=<installation_directory>
|
||||
@@ -18,52 +18,116 @@ $ sudo ./openshift-install create install-config --dir=<installation_directory>
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
* Do not copy the following example. Instead, run the installation program to create one.
|
||||
* You cannot modify these parameters in the `install-config.yaml` file after installation.
|
||||
* These example files are provided for reference only. You must obtain your
|
||||
`install-config.yaml` file by using the installation program.
|
||||
* Changing the `install-config.yaml` file can increase the resources your cluster requires. Verify that your {rh-virtualization} environment has those additional resources. Otherwise, the installation or cluster will fail.
|
||||
====
|
||||
|
||||
IMPORTANT: If you make customizations that require additional resources, such as adding control plane and compute machines, verify that your {rh-virtualization} environment has enough resources. Otherwise, these customizations might cause the installation to fail.
|
||||
|
||||
|
||||
.Example `install-config.yaml` configuration file
|
||||
.Example: This is the default `install-config.yaml` file
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: v1
|
||||
baseDomain: <virtlab.example.com> <1>
|
||||
baseDomain: example.com
|
||||
compute:
|
||||
- hyperthreading: Enabled
|
||||
- architecture: amd64
|
||||
hyperthreading: Enabled
|
||||
name: worker
|
||||
platform: {}
|
||||
replicas: 3 <2>
|
||||
replicas: 3
|
||||
controlPlane:
|
||||
architecture: amd64
|
||||
hyperthreading: Enabled
|
||||
name: master
|
||||
platform: {}
|
||||
replicas: 3 <3>
|
||||
replicas: 3
|
||||
metadata:
|
||||
name: <my-cluster> <4>
|
||||
creationTimestamp: null
|
||||
name: my-cluster
|
||||
networking:
|
||||
clusterNetwork:
|
||||
- cidr: 10.128.0.0/14
|
||||
hostPrefix: 23
|
||||
machineNetwork:
|
||||
- cidr: 10.0.0.0/16
|
||||
networkType: OpenShiftSDN
|
||||
serviceNetwork:
|
||||
- 172.30.0.0/16
|
||||
platform:
|
||||
ovirt:
|
||||
api_vip: <ip-address> <5>
|
||||
dns_vip: <ip-address> <6>
|
||||
ingress_vip: <ip-address> <7>
|
||||
ovirt_cluster_id: <rhv-cluster-id> <8>
|
||||
ovirt_storage_domain_id: <rhv-storage-domain-id> <9>
|
||||
api_vip: 10.46.8.230
|
||||
ingress_vip: 192.168.1.5
|
||||
ovirt_cluster_id: 68833f9f-e89c-4891-b768-e2ba0815b76b
|
||||
ovirt_storage_domain_id: ed7b0f4e-0e96-492a-8fff-279213ee1468
|
||||
ovirt_network_name: ovirtmgmt
|
||||
vnicProfileID: 3fa86930-0be5-4052-b667-b79f0a729692
|
||||
publish: External
|
||||
pullSecret: |
|
||||
<pull-secret> <10>
|
||||
sshKey: |
|
||||
<ssh-public-key> <11>
|
||||
pullSecret: '{"auths": ...}'
|
||||
sshKey: ssh-ed12345 AAAA...
|
||||
----
|
||||
|
||||
|
||||
.Example: A minimal `install-config.yaml` file
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: v1
|
||||
baseDomain: example.com
|
||||
metadata:
|
||||
name: test-cluster
|
||||
platform:
|
||||
ovirt:
|
||||
api_vip: 10.46.8.230
|
||||
ingress_vip: 10.46.8.232
|
||||
ovirt_cluster_id: 68833f9f-e89c-4891-b768-e2ba0815b76b
|
||||
ovirt_storage_domain_id: ed7b0f4e-0e96-492a-8fff-279213ee1468
|
||||
ovirt_network_name: ovirtmgmt
|
||||
vnicProfileID: 3fa86930-0be5-4052-b667-b79f0a729692
|
||||
pullSecret: '{"auths": ...}'
|
||||
sshKey: ssh-ed12345 AAAA...
|
||||
----
|
||||
|
||||
|
||||
.Example: Custom machine pools in an `install-config.yaml` file
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: v1
|
||||
baseDomain: example.com
|
||||
controlPlane:
|
||||
name: master
|
||||
platform:
|
||||
ovirt:
|
||||
cpu:
|
||||
cores: 4
|
||||
sockets: 2
|
||||
memoryMB: 65536
|
||||
osDisk:
|
||||
sizeGB: 100
|
||||
vmType: high_performance
|
||||
replicas: 3
|
||||
compute:
|
||||
- name: worker
|
||||
platform:
|
||||
ovirt:
|
||||
cpu:
|
||||
cores: 4
|
||||
sockets: 4
|
||||
memoryMB: 65536
|
||||
osDisk:
|
||||
sizeGB: 200
|
||||
vmType: high_performance
|
||||
replicas: 5
|
||||
metadata:
|
||||
name: test-cluster
|
||||
platform:
|
||||
ovirt:
|
||||
api_vip: 10.46.8.230
|
||||
ingress_vip: 10.46.8.232
|
||||
ovirt_cluster_id: 68833f9f-e89c-4891-b768-e2ba0815b76b
|
||||
ovirt_storage_domain_id: ed7b0f4e-0e96-492a-8fff-279213ee1468
|
||||
ovirt_network_name: ovirtmgmt
|
||||
vnicProfileID: 3fa86930-0be5-4052-b667-b79f0a729692
|
||||
pullSecret: '{"auths": ...}'
|
||||
sshKey: ssh-ed25519 AAAA...
|
||||
----
|
||||
<1> For `<virtlab.example.com>`, specify the base domain of the {product-title} cluster.
|
||||
<2> Specify `3` or more compute machines. The default value is `3`.
|
||||
<3> Specify `3` or more control plane machines. The default value is `3`.
|
||||
<4> For `<my-cluster>`, specify the name of the new {product-title} cluster.
|
||||
<5> For `<ip-address>`, specify the static IP address of the API for which you created the `api.` DNS entry.
|
||||
<6> For `<ip-address>`, specify the static IP address of the internal DNS of the {product-title} cluster.
|
||||
<7> For `<ip-address>`, specify the static IP address of the cluster applications for which you created the `*.apps.` DNS entry.
|
||||
<8> For `<rhv-cluster-id>`, specify an {rh-virtualization} cluster ID.
|
||||
<9> For `<rhv-storage-domain-id>`, specify an {rh-virtualization} storage domain ID.
|
||||
<10> For `<pull-secret>`, specify your pull secret in JSON format.
|
||||
<11> For `<ssh-public-key>`, specify your public SSH key.
|
||||
|
||||
@@ -14,7 +14,7 @@ By default, the installation program creates seven machines during the installat
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
If you increase the resource usage or cluster size in the `install_config.yaml` file, increase these requirements accordingly.
|
||||
If you increase the number of virtual machines or resources in the `install_config.yaml` file, you must also increase these requirements.
|
||||
====
|
||||
|
||||
.Requirements
|
||||
|
||||
@@ -58,8 +58,9 @@ $ cat install-config.yaml
|
||||
----
|
||||
...
|
||||
proxy:
|
||||
httpProxy: http://<HTTP_PROXY>
|
||||
httpsProxy: https://<HTTPS_PROXY>
|
||||
httpProxy: http://<https://username:password@proxy.example.com:123/>
|
||||
httpsProxy: https://<https://username:password@proxy.example.com:123/>
|
||||
noProxy: <123.example.com,10.88.0.0/16>
|
||||
additionalTrustBundle: |
|
||||
-----BEGIN CERTIFICATE-----
|
||||
<MY_HTTPS_PROXY_TRUSTED_CA_CERT>
|
||||
|
||||
Reference in New Issue
Block a user