Skip to content

Commit c5dae2e

Browse files
Merge pull request #100007 from bscott-rh/restructure-config-params-tables
OSDOCS-16392 Updating remaining install config param tables for readability
2 parents 6093120 + c0d9791 commit c5dae2e

File tree

2 files changed

+836
-461
lines changed

2 files changed

+836
-461
lines changed

modules/agent-configuration-parameters.adoc

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,30 @@ These settings are used for installation only, and cannot be modified after inst
2121
Required Agent configuration parameters are described in the following table:
2222

2323
.Required parameters
24-
[cols=".^4l,.^4,.^2a",options="header"]
24+
[cols=".^l,.^a",options="header"]
2525
|====
26-
|Parameter|Description|Values
26+
|Parameter|Description
2727

2828
|apiVersion:
2929
|The API version for the `agent-config.yaml` content.
3030
The current version is `v1beta1`.
3131
The installation program might also support older API versions.
32-
|String
32+
33+
*Value:* String
3334

3435
|metadata:
3536
|Kubernetes resource `ObjectMeta`, from which only the `name` parameter is consumed.
36-
|Object
37+
38+
*Value:* Object
3739

3840
|metadata:
3941
name:
4042
|The name of the cluster.
4143
DNS records for the cluster are all subdomains of `{{.metadata.name}}.{{.baseDomain}}`.
4244
The value entered in the `agent-config.yaml` file is ignored, and instead the value specified in the `install-config.yaml` file is used.
4345
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`.
44-
|String of lowercase letters and hyphens (`-`), such as `dev`.
46+
47+
*Value:* String of lowercase letters and hyphens (`-`), such as `dev`.
4548
|====
4649

4750

@@ -51,90 +54,103 @@ When you do not provide `metadata.name` through either the `install-config.yaml`
5154
Optional Agent configuration parameters are described in the following table:
5255

5356
.Optional parameters
54-
[cols=".^2l,.^4,.^4a",options="header"]
57+
[cols=".^l,.^a",options="header"]
5558
|====
56-
|Parameter|Description|Values
59+
|Parameter|Description
5760

5861
|rendezvousIP:
5962
|The IP address of the node that performs the bootstrapping process as well as running the `assisted-service` component.
6063
You must provide the rendezvous IP address when you do not specify at least one host's IP address in the `networkConfig` parameter.
6164
If this address is not provided, one IP address is selected from the provided hosts' `networkConfig`.
62-
|IPv4 or IPv6 address.
65+
66+
*Value:* IPv4 or IPv6 address.
6367

6468
|bootArtifactsBaseURL:
6569
|When you use the Agent-based Installer to generate a minimal ISO image, this parameter specifies a URL where the rootfs image file can be retrieved from during cluster installation. This parameter is optional for booting minimal ISO images in connected environments.
6670

6771
When you use the Agent-based Installer to generate an iPXE script, this parameter specifies the URL of the server to upload Preboot Execution Environment (PXE) assets to.
6872
For more information, see "Preparing PXE assets for {product-title}".
69-
|String.
73+
74+
*Value:* String.
7075

7176
|additionalNTPSources:
7277
|A list of Network Time Protocol (NTP) sources to be added to all cluster hosts, which are added to any NTP sources that are configured through other means.
73-
|List of hostnames or IP addresses.
78+
79+
*Value:* List of hostnames or IP addresses.
7480

7581
|hosts:
7682
|Host configuration.
7783
An optional list of hosts.
7884
The number of hosts defined must not exceed the total number of hosts defined in the `install-config.yaml` file, which is the sum of the values of the `compute.replicas` and `controlPlane.replicas` parameters.
79-
|An array of host configuration objects.
85+
86+
*Value:* An array of host configuration objects.
8087

8188
|hosts:
8289
hostname:
8390
|Hostname.
8491
Overrides the hostname obtained from either the Dynamic Host Configuration Protocol (DHCP) or a reverse DNS lookup.
8592
Each host must have a unique hostname supplied by one of these methods, although configuring a hostname through this parameter is optional.
86-
|String.
93+
94+
*Value:* String.
8795

8896
|hosts:
8997
interfaces:
9098
|Provides a table of the name and MAC address mappings for the interfaces on the host.
9199
If a `NetworkConfig` section is provided in the `agent-config.yaml` file, this table must be included and the values must match the mappings provided in the `NetworkConfig` section.
92-
|An array of host configuration objects.
100+
101+
*Value:* An array of host configuration objects.
93102

94103
|hosts:
95104
interfaces:
96105
name:
97106
|The name of an interface on the host.
98-
|String.
107+
108+
*Value:* String.
99109

100110
|hosts:
101111
interfaces:
102112
macAddress:
103113
|The MAC address of an interface on the host.
104-
|A MAC address such as the following example: `00-B0-D0-63-C2-26`.
114+
115+
*Value:* A MAC address such as the following example: `00-B0-D0-63-C2-26`.
105116

106117
|hosts:
107118
role:
108119
|Defines whether the host is a `master` or `worker` node.
109120
If no role is defined in the `agent-config.yaml` file, roles will be assigned at random during cluster installation.
110-
|`master` or `worker`.
121+
122+
*Value:* `master` or `worker`.
111123

112124
|hosts:
113125
rootDeviceHints:
114126
|Enables provisioning of the {op-system-first} image to a particular device.
115127
The installation program examines the devices in the order it discovers them, and compares the discovered values with the hint values.
116128
It uses the first discovered device that matches the hint value.
117129
This is the device that the operating system is written on during installation.
118-
|A dictionary of key-value pairs.
130+
131+
*Value:* A dictionary of key-value pairs.
119132
For more information, see "Root device hints" in the "Setting up the environment for an OpenShift installation" page.
120133

121134
|hosts:
122135
rootDeviceHints:
123136
deviceName:
124137
|The name of the device the {op-system} image is provisioned to.
125-
|String.
138+
139+
*Value:* String.
126140

127141
|hosts:
128142
networkConfig:
129143
|The host network definition.
130144
The configuration must match the Host Network Management API defined in the link:https://nmstate.io/[nmstate documentation].
131-
|A dictionary of host network configuration objects.
145+
146+
*Value:* A dictionary of host network configuration objects.
132147

133148
|minimalISO:
134149
|Defines whether the Agent-based Installer generates a full ISO or a minimal ISO image. When this parameter is set to `True`, the Agent-based Installer generates an ISO without a rootfs image file, and instead contains details about where to pull the rootfs file from.
135150

136151
When you generate a minimal ISO, if you do not specify a rootfs URL through the `bootArtifactsBaseURL` parameter, the Agent-based Installer embeds a default URL that is accessible in environments with an internet connection.
137152

138153
The default value is `False`.
139-
|Boolean.
154+
155+
*Value:* Boolean.
140156
|====

0 commit comments

Comments
 (0)