You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/agent-configuration-parameters.adoc
+36-20Lines changed: 36 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,27 +21,30 @@ These settings are used for installation only, and cannot be modified after inst
21
21
Required Agent configuration parameters are described in the following table:
22
22
23
23
.Required parameters
24
-
[cols=".^4l,.^4,.^2a",options="header"]
24
+
[cols=".^l,.^a",options="header"]
25
25
|====
26
-
|Parameter|Description|Values
26
+
|Parameter|Description
27
27
28
28
|apiVersion:
29
29
|The API version for the `agent-config.yaml` content.
30
30
The current version is `v1beta1`.
31
31
The installation program might also support older API versions.
32
-
|String
32
+
33
+
*Value:* String
33
34
34
35
|metadata:
35
36
|Kubernetes resource `ObjectMeta`, from which only the `name` parameter is consumed.
36
-
|Object
37
+
38
+
*Value:* Object
37
39
38
40
|metadata:
39
41
name:
40
42
|The name of the cluster.
41
43
DNS records for the cluster are all subdomains of `{{.metadata.name}}.{{.baseDomain}}`.
42
44
The value entered in the `agent-config.yaml` file is ignored, and instead the value specified in the `install-config.yaml` file is used.
43
45
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`.
45
48
|====
46
49
47
50
@@ -51,90 +54,103 @@ When you do not provide `metadata.name` through either the `install-config.yaml`
51
54
Optional Agent configuration parameters are described in the following table:
52
55
53
56
.Optional parameters
54
-
[cols=".^2l,.^4,.^4a",options="header"]
57
+
[cols=".^l,.^a",options="header"]
55
58
|====
56
-
|Parameter|Description|Values
59
+
|Parameter|Description
57
60
58
61
|rendezvousIP:
59
62
|The IP address of the node that performs the bootstrapping process as well as running the `assisted-service` component.
60
63
You must provide the rendezvous IP address when you do not specify at least one host's IP address in the `networkConfig` parameter.
61
64
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.
63
67
64
68
|bootArtifactsBaseURL:
65
69
|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.
66
70
67
71
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.
68
72
For more information, see "Preparing PXE assets for {product-title}".
69
-
|String.
73
+
74
+
*Value:* String.
70
75
71
76
|additionalNTPSources:
72
77
|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.
74
80
75
81
|hosts:
76
82
|Host configuration.
77
83
An optional list of hosts.
78
84
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.
80
87
81
88
|hosts:
82
89
hostname:
83
90
|Hostname.
84
91
Overrides the hostname obtained from either the Dynamic Host Configuration Protocol (DHCP) or a reverse DNS lookup.
85
92
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.
87
95
88
96
|hosts:
89
97
interfaces:
90
98
|Provides a table of the name and MAC address mappings for the interfaces on the host.
91
99
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.
93
102
94
103
|hosts:
95
104
interfaces:
96
105
name:
97
106
|The name of an interface on the host.
98
-
|String.
107
+
108
+
*Value:* String.
99
109
100
110
|hosts:
101
111
interfaces:
102
112
macAddress:
103
113
|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`.
105
116
106
117
|hosts:
107
118
role:
108
119
|Defines whether the host is a `master` or `worker` node.
109
120
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`.
111
123
112
124
|hosts:
113
125
rootDeviceHints:
114
126
|Enables provisioning of the {op-system-first} image to a particular device.
115
127
The installation program examines the devices in the order it discovers them, and compares the discovered values with the hint values.
116
128
It uses the first discovered device that matches the hint value.
117
129
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.
119
132
For more information, see "Root device hints" in the "Setting up the environment for an OpenShift installation" page.
120
133
121
134
|hosts:
122
135
rootDeviceHints:
123
136
deviceName:
124
137
|The name of the device the {op-system} image is provisioned to.
125
-
|String.
138
+
139
+
*Value:* String.
126
140
127
141
|hosts:
128
142
networkConfig:
129
143
|The host network definition.
130
144
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.
132
147
133
148
|minimalISO:
134
149
|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.
135
150
136
151
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.
0 commit comments