Skip to content

Commit 05a4a84

Browse files
committed
HCIDOCS-373: Added additionalNTPServers setting to install-config yaml config module, and to additional configuration settings module.
1 parent d617d8b commit 05a4a84

File tree

2 files changed

+53
-26
lines changed

2 files changed

+53
-26
lines changed

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

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66
[id="additional-install-config-parameters_{context}"]
77
= Additional `install-config` parameters
88

9-
See the following tables for the required parameters, the `hosts` parameter,
10-
and the `bmc` parameter for the `install-config.yaml` file.
9+
See the following tables for the required parameters, the `hosts` parameter, and the `bmc` parameter for the `install-config.yaml` file.
1110

12-
[cols="2,1,5"]
11+
[cols="4,1,5"]
1312
[options="header"]
1413
.Required parameters
1514
|===
@@ -24,25 +23,40 @@ and the `bmc` parameter for the `install-config.yaml` file.
2423
| `UEFI`
2524
| The boot mode for a node. Options are `legacy`, `UEFI`, and `UEFISecureBoot`. If `bootMode` is not set, Ironic sets it while inspecting the node.
2625

27-
| `bootstrapExternalStaticDNS`
26+
a|
27+
----
28+
platform:
29+
baremetal:
30+
bootstrapExternalStaticDNS
31+
----
2832
|
2933
| The static network DNS of the bootstrap node. You must set this value when deploying a cluster with static IP addresses when there is no Dynamic Host Configuration Protocol (DHCP) server on the bare-metal network. If you do not set this value, the installation program will use the value from `bootstrapExternalStaticGateway`, which causes problems when the IP address values of the gateway and DNS are different.
3034

31-
| `bootstrapExternalStaticIP`
35+
a|
36+
----
37+
platform:
38+
baremetal:
39+
bootstrapExternalStaticIP
40+
----
3241
|
3342
| The static IP address for the bootstrap VM. You must set this value when deploying a cluster with static IP addresses when there is no DHCP server on the bare-metal network.
3443

35-
| `bootstrapExternalStaticGateway`
44+
a|
45+
----
46+
platform:
47+
baremetal:
48+
bootstrapExternalStaticGateway
49+
----
3650
|
3751
| The static IP address of the gateway for the bootstrap VM. You must set this value when deploying a cluster with static IP addresses when there is no DHCP server on the bare-metal network.
3852

3953
| `sshKey`
4054
|
41-
| The `sshKey` configuration setting contains the key in the `~/.ssh/id_rsa.pub` file required to access the control plane nodes and compute nodes. Typically, this key is from the `provisioner` node.
55+
| The `sshKey` configuration setting has the key in the `~/.ssh/id_rsa.pub` file required to access the control plane nodes and compute nodes. Typically, this key is from the `provisioner` node.
4256

4357
| `pullSecret`
4458
|
45-
| The `pullSecret` configuration setting contains a copy of the pull secret downloaded from the link:https://console.redhat.com/openshift/install/metal/user-provisioned[Install OpenShift on Bare Metal] page when preparing the provisioner node.
59+
| The `pullSecret` configuration setting has a copy of the pull secret downloaded from the link:https://console.redhat.com/openshift/install/metal/user-provisioned[Install OpenShift on Bare Metal] page when preparing the provisioner node.
4660

4761

4862
a|
@@ -51,7 +65,7 @@ metadata:
5165
name:
5266
----
5367
|
54-
|The name to be given to the {product-title} cluster. For example, `openshift`.
68+
|The name of the {product-title} cluster. For example, `openshift`.
5569

5670

5771
a|
@@ -69,7 +83,7 @@ compute:
6983
- name: worker
7084
----
7185
|
72-
|The {product-title} cluster requires a name be provided for compute nodes even if there are zero nodes.
86+
|The {product-title} cluster requires you to provide a name for compute nodes even if there are zero nodes.
7387

7488

7589
a|
@@ -105,7 +119,7 @@ a| `provisioningNetworkInterface` | | The name of the network interface on node
105119

106120
| `apiVIPs` | a| (Optional) The virtual IP address for Kubernetes API communication.
107121

108-
This setting must either be provided in the `install-config.yaml` file as a reserved IP from the MachineNetwork or preconfigured in the DNS so that the default name resolves correctly. Use the virtual IP address and not the FQDN when adding a value to the `apiVIPs` configuration setting in the `install-config.yaml` file. The primary IP address must be from the IPv4 network when using dual stack networking. If not set, the installation program uses `api.<cluster_name>.<base_domain>` to derive the IP address from the DNS.
122+
You must either provide this setting in the `install-config.yaml` file as a reserved IP from the `MachineNetwork` parameter or preconfigured in the DNS so that the default name resolves correctly. Use the virtual IP address and not the FQDN when adding a value to the `apiVIPs` configuration setting in the `install-config.yaml` file. The primary IP address must be from the IPv4 network when using dual stack networking. If not set, the installation program uses `api.<cluster_name>.<base_domain>` to derive the IP address from the DNS.
109123

110124
[NOTE]
111125
====
@@ -117,7 +131,7 @@ Before {product-title} 4.12, the cluster installation program only accepted an I
117131

118132
| `ingressVIPs` | a| (Optional) The virtual IP address for ingress traffic.
119133

120-
This setting must either be provided in the `install-config.yaml` file as a reserved IP from the MachineNetwork or preconfigured in the DNS so that the default name resolves correctly. Use the virtual IP address and not the FQDN when adding a value to the `ingressVIPs` configuration setting in the `install-config.yaml` file. The primary IP address must be from the IPv4 network when using dual stack networking. If not set, the installation program uses `test.apps.<cluster_name>.<base_domain>` to derive the IP address from the DNS.
134+
You must either provide this setting in the `install-config.yaml` file as a reserved IP from the `MachineNetwork` parameter or preconfigured in the DNS so that the default name resolves correctly. Use the virtual IP address and not the FQDN when adding a value to the `ingressVIPs` configuration setting in the `install-config.yaml` file. The primary IP address must be from the IPv4 network when using dual stack networking. If not set, the installation program uses `test.apps.<cluster_name>.<base_domain>` to derive the IP address from the DNS.
121135

122136
[NOTE]
123137
====
@@ -134,21 +148,31 @@ Before {product-title} 4.12, the cluster installation program only accepted an I
134148
|Default
135149
|Description
136150

151+
a|
152+
----
153+
platform:
154+
baremetal:
155+
additionalNTPServers:
156+
- <ip_address_or_domain_name>
157+
----
158+
|
159+
| An optional list of additional NTP servers to add to each host. You can use an IP address or a domain name to specify each NTP server. Additional NTP servers are user-defined NTP servers that enable preinstallation clock synchronization when the cluster host clocks are out of synchronization.
160+
137161
|`provisioningDHCPRange`
138162
|`172.22.0.10,172.22.0.100`
139163
|Defines the IP range for nodes on the provisioning network.
140164

141165
a|`provisioningNetworkCIDR`
142166
|`172.22.0.0/24`
143-
|The CIDR for the network to use for provisioning. This option is required when not using the default address range on the provisioning network.
167+
|The CIDR for the network to use for provisioning. The installation program requires this option when not using the default address range on the provisioning network.
144168

145169
|`clusterProvisioningIP`
146170
|The third IP address of the `provisioningNetworkCIDR`.
147171
|The IP address within the cluster where the provisioning services run. Defaults to the third IP address of the provisioning subnet. For example, `172.22.0.3`.
148172

149173
|`bootstrapProvisioningIP`
150174
|The second IP address of the `provisioningNetworkCIDR`.
151-
|The IP address on the bootstrap VM where the provisioning services run while the installer is deploying the control plane (master) nodes. Defaults to the second IP address of the provisioning subnet. For example, `172.22.0.2` or `2620:52:0:1307::2`.
175+
|The IP address on the bootstrap VM where the provisioning services run while the installation program is deploying the control plane (master) nodes. Defaults to the second IP address of the provisioning subnet. For example, `172.22.0.2` or `2620:52:0:1307::2`.
152176

153177
| `externalBridge`
154178
| `baremetal`
@@ -175,7 +199,7 @@ a|`provisioningNetworkCIDR`
175199
|
176200
| The `provisioningNetwork` configuration setting determines whether the cluster uses the provisioning network. If it does, the configuration setting also determines if the cluster manages the network.
177201

178-
`Disabled`: Set this parameter to `Disabled` to disable the requirement for a provisioning network. When set to `Disabled`, you must only use virtual media based provisioning, or bring up the cluster using the assisted installer. If `Disabled` and using power management, BMCs must be accessible from the bare-metal network. If `Disabled`, you must provide two IP addresses on the bare-metal network that are used for the provisioning services.
202+
`Disabled`: Set this parameter to `Disabled` to disable the requirement for a provisioning network. When set to `Disabled`, you must only use virtual media based provisioning, or start the cluster by using the {ai-full}. If set to `Disabled` and using power management, BMCs must be accessible from the bare-metal network. If set to `Disabled`, you must provide two IP addresses on the bare-metal network that the installation program uses for the provisioning services.
179203

180204
`Managed`: Set this parameter to `Managed`, which is the default, to fully manage the provisioning network, including DHCP, TFTP, and so on.
181205

@@ -211,7 +235,7 @@ The `hosts` parameter is a list of separate bare metal assets used to build the
211235

212236
| `role`
213237
|
214-
| The role of the bare metal node. Either `master` (control plane node) or `worker` (compute node).
238+
| The role of the bare-metal node. Either `master` (control plane node) or `worker` (compute node).
215239

216240

217241
| `bmc`

modules/ipi-install-configuring-the-install-config-file.adoc

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,26 @@ controlPlane:
3636
baremetal: {}
3737
platform:
3838
baremetal:
39+
additionalNTPServers: <2>
40+
- <ntp_domain_or_ip>
3941
apiVIPs:
4042
- <api_ip>
4143
ingressVIPs:
4244
- <wildcard_ip>
4345
provisioningNetworkCIDR: <CIDR>
44-
bootstrapExternalStaticIP: <bootstrap_static_ip_address> <2>
45-
bootstrapExternalStaticGateway: <bootstrap_static_gateway> <3>
46-
bootstrapExternalStaticDNS: <bootstrap_static_dns> <4>
46+
bootstrapExternalStaticIP: <bootstrap_static_ip_address> <3>
47+
bootstrapExternalStaticGateway: <bootstrap_static_gateway> <4>
48+
bootstrapExternalStaticDNS: <bootstrap_static_dns> <5>
4749
hosts:
4850
- name: openshift-master-0
4951
role: master
5052
bmc:
51-
address: ipmi://<out_of_band_ip> <5>
53+
address: ipmi://<out_of_band_ip> <6>
5254
username: <user>
5355
password: <password>
5456
bootMACAddress: <NIC1_mac_address>
5557
rootDeviceHints:
56-
deviceName: "<installation_disk_drive_path>" <6>
58+
deviceName: "<installation_disk_drive_path>" <7>
5759
- name: <openshift_master_1>
5860
role: master
5961
bmc:
@@ -94,11 +96,12 @@ sshKey: '<ssh_pub_key>'
9496
+
9597
--
9698
<1> Scale the compute machines based on the number of compute nodes that are part of the {product-title} cluster. Valid options for the `replicas` value are `0` and integers greater than or equal to `2`. Set the number of replicas to `0` to deploy a three-node cluster, which contains only three control plane machines. A three-node cluster is a smaller, more resource-efficient cluster that can be used for testing, development, and production. You cannot install the cluster with only one compute node.
97-
<2> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticIP` configuration setting to specify the static IP address of the bootstrap VM when there is no DHCP server on the bare-metal network.
98-
<3> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticGateway` configuration setting to specify the gateway IP address for the bootstrap VM when there is no DHCP server on the bare-metal network.
99-
<4> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticDNS` configuration setting to specify the DNS address for the bootstrap VM when there is no DHCP server on the bare-metal network.
100-
<5> See the BMC addressing sections for more options.
101-
<6> To set the path to the installation disk drive, enter the kernel name of the disk. For example, `/dev/sda`.
99+
<2> An optional list of additional NTP server domain names or IP addresses to add to each host configuration when the cluster host clocks are out of synchronization.
100+
<3> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticIP` configuration setting to specify the static IP address of the bootstrap VM when there is no DHCP server on the bare metal network.
101+
<4> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticGateway` configuration setting to specify the gateway IP address for the bootstrap VM when there is no DHCP server on the bare metal network.
102+
<5> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticDNS` configuration setting to specify the DNS address for the bootstrap VM when there is no DHCP server on the bare metal network.
103+
<6> See the BMC addressing sections for more options.
104+
<7> To set the path to the installation disk drive, enter the kernel name of the disk. For example, `/dev/sda`.
102105
+
103106
[IMPORTANT]
104107
====

0 commit comments

Comments
 (0)