Skip to content

Commit 2c9e489

Browse files
johnwilkinsjohnwilkins
committed
Added sshKey and pullSecret
1 parent 9cda844 commit 2c9e489

File tree

1 file changed

+68
-12
lines changed

1 file changed

+68
-12
lines changed

‎modules/ipi-install-additional-install-config-parameters.adoc‎

Lines changed: 68 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ and the `bmc` parameter for the `install-config.yaml` file.
1717
|
1818
| The domain name for the cluster. For example, `example.com`.
1919

20+
| [[sshkey]] `sshKey`
21+
|
22+
| The `sshKey` configuration setting contains the key in the `~/.ssh/id_rsa.pub` file required to access the control plane nodes and worker nodes. Typically, this key is from the `provisioner` node.
23+
24+
| [[pullsecret]] `pullSecret`
25+
|
26+
| The `pullSecret` configuration setting contains a copy of the pull secret downloaded from the link:https://cloud.redhat.com/openshift/install/metal/user-provisioned[Install OpenShift on Bare Metal] page when preparing the provisioner node.
27+
2028

2129
a|[[metadataname]]
2230
----
@@ -33,8 +41,13 @@ networking:
3341
machineCIDR:
3442
----
3543
|
36-
|The public CIDR (Classless Inter-Domain Routing) of the external network. For example, `10.0.0.0/24` or `2620:52:0:1302::/64`.
37-
44+
|The public CIDR (Classless Inter-Domain Routing) of the external network. For example, `10.0.0.0/24`
45+
ifdef::upstream[]
46+
ifeval::[{release} >= 4.5]
47+
or `2620:52:0:1302::/64`
48+
endif::[]
49+
endif::[]
50+
.
3851

3952
a|[[workername]]
4053
----
@@ -71,6 +84,13 @@ controlPlane:
7184
|
7285
|Replicas sets the number of control plane (master) nodes included as part of the {product-title} cluster.
7386

87+
ifeval::[{release} >= 4.4]
88+
ifeval::[{release} <= 4.6]
89+
a| [[provisioningNetworkInterface]]`provisioningNetworkInterface` | | The name of the network interface on control plane nodes connected to the
90+
provisioning network.
91+
endif::[]
92+
endif::[]
93+
7494

7595
| `defaultMachinePlatform` | | The default configuration used for machine pools without a platform configuration.
7696

@@ -102,26 +122,36 @@ endif::[]
102122

103123

104124
ifeval::[{release} > 4.3]
125+
ifeval::[{release} < 4.6]
105126
|`provisioningDHCPExternal`
106127
| false
107128
|Defines if the installer uses an external DHCP or the provisioner node DHCP.
129+
endif::[]
130+
endif::[]
108131

109132
|`provisioningDHCPRange`
110133
|`172.22.0.10,172.22.0.100`
111134
|Defines the IP range for nodes on the `provisioning` network.
112135

113136
a|`provisioningNetworkCIDR`
114137
|`172.22.0.0/24`
115-
|The CIDR for the network to use for provisioning. This option is required when using IPv6 addressing on the `provisioning` network.
116-
endif::[]
138+
|The CIDR for the network to use for provisioning. This option is required when not using the default address range on the `provisioning` network.
117139

118140
|`clusterProvisioningIP`
119-
|The third IP address of the `provisioningNetworkCIDR`
141+
|The third IP address of the `provisioningNetworkCIDR`.
120142
|The IP within the cluster where the provisioning services run. Defaults to the 3rd IP of the `provisioning` subnet. For example, `172.22.0.3`.
121143

122144
|`bootstrapProvisioningIP`
123-
|The second IP address of the `provisioningNetworkCIDR`
124-
|The IP on the bootstrap VM where the provisioning services run while the the installer is deploying the control plane (master) nodes. Defaults to the 2nd IP of the `provisioning` subnet. For example, `172.22.0.2` or `2620:52:0:1307::2`. When using no `provisioning` network, set this value to an IP address that is available on the `baremetal` network.
145+
|The second IP address of the `provisioningNetworkCIDR`.
146+
|The IP on the bootstrap VM where the provisioning services run while the the installer is deploying the control plane (master) nodes. Defaults to the second IP of the `provisioning` subnet. For example, `172.22.0.2`
147+
ifdef::upstream[]
148+
ifeval::[{release} >= 4.5]
149+
or `2620:52:0:1307::2`
150+
endif::[]
151+
endif::[]
152+
.
153+
154+
When using no `provisioning` network, set this value to an IP address that is available on the `baremetal` network.
125155

126156
| `externalBridge`
127157
| `baremetal`
@@ -138,25 +168,49 @@ endif::[]
138168
| `bootstrapOSImage`
139169
|
140170
| A URL to override the default operating system image for the bootstrap node. The URL must contain a SHA-256 hash of the image. For example:
141-
`https://mirror.openshift.com/rhcos-<version>-qemu.qcow2.gz?sha256=<uncompressed_sha256>` or `http://[2620:52:0:1307::1]/rhcos-<version>-qemu.x86_64.qcow2.gz?sha256=<uncompressed_sha256>`.
142-
171+
`https://mirror.openshift.com/rhcos-<version>-qemu.qcow2.gz?sha256=<uncompressed_sha256>`
172+
ifdef::upstream[]
173+
ifeval::[{release} >= 4.5]
174+
or `http://[2620:52:0:1307::1]/rhcos-<version>-qemu.x86_64.qcow2.gz?sha256=<uncompressed_sha256>`
175+
endif::[]
176+
endif::[]
177+
.
143178

144179
| `clusterOSImage`
145180
|
146-
| A URL to override the default operating system for cluster nodes. The URL must include a SHA-256 hash of the image. For example, https://mirror.openshift.com/images/rhcos-<version>-openstack.qcow2.gz?sha256=<compressed_sha256>.
181+
| A URL to override the default operating system for cluster nodes. The URL must include a SHA-256 hash of the image. For example, `https://mirror.openshift.com/images/rhcos-<version>-openstack.qcow2.gz?sha256=<compressed_sha256>`.
147182

148183

149184
| `provisioningNetwork`
150185
|
151-
| Set this parameter to `Disabled` to disable the requirement for a `provisioning` network.
186+
| Set this parameter to `Disabled` to disable the requirement for a `provisioning` network. User may only do virtual media based provisioning, or bring up the cluster using assisted installation. If using power management, BMC's must be accessible from the machine networks. User must provide two IP addresses on the external network that are used for the provisioning services.
187+
ifeval::[{release} >= 4.6]
188+
Set this parameter to `managed`, which is the default, to fully manage the provisioning network, including DHCP, TFTP, and so on.
189+
190+
Set this parameter to `unmanaged` to still enable the provisioning network but take care of manual configuration of DHCP. Virtual Media provisioning is recommended but PXE is still available if required.
191+
endif::[]
152192

153193
| `provisioningHostingIp`
154194
|
155195
| Set this parameter to an available IP address on the `baremetal` network when the `provisioningNetwork` configuration setting is set to `Disabled`.
156196

157-
|===
197+
ifeval::[{release} > 4.4]
198+
| `httpProxy`
199+
|
200+
| Set this parameter to the appropriate HTTP proxy used within your environment.
158201

202+
| `httpsProxy`
203+
|
204+
| Set this parameter to the appropriate HTTPS proxy used within your environment.
205+
206+
| `noProxy`
207+
|
208+
| Set this parameter to the appropriate list of exclusions for proxy usage within your environment.
209+
endif::[]
159210

211+
|===
212+
213+
[id="hoststable"]
160214
.Hosts
161215

162216
The `hosts` parameter is a list of separate bare metal assets used to build the cluster.
@@ -182,7 +236,9 @@ The `hosts` parameter is a list of separate bare metal assets used to build the
182236
|
183237
| The MAC address of the NIC the host will use to boot on the `provisioning` network.
184238

239+
ifeval::[{release} < 4.6]
185240
| [[hardwareProfile]]`hardwareProfile`
186241
| `default`
187242
| This parameter exposes the device name that the installer attempts to deploy the {product-title} cluster for the control plane and worker nodes. The value defaults to `default` for control plane nodes and `unknown` for worker nodes. The list of profiles includes: `default`, `libvirt`, `dell`, `dell-raid`, and `openstack`. The `default` parameter attempts to install on `/dev/sda` of the {product-title} cluster nodes.
243+
endif::[]
188244
|===

0 commit comments

Comments
 (0)