Skip to content

Commit 86dfd1f

Browse files
skopacz1skopacz1
committed
OSDOCS-8773: Agent configuration reference assembly
1 parent 46cff94 commit 86dfd1f

File tree

5 files changed

+233
-34
lines changed

5 files changed

+233
-34
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,8 @@ Topics:
353353
File: prepare-pxe-assets-agent
354354
- Name: Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes
355355
File: preparing-an-agent-based-installed-cluster-for-mce
356+
- Name: Installation configuration parameters for the Agent-based Installer
357+
File: installation-config-parameters-agent
356358
- Name: Installing on a single node
357359
Dir: installing_sno
358360
Distros: openshift-enterprise

‎installing/installing_with_agent_based_installer/installation-config-parameters-agent.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="installation-config-parameters-agent"]
3+
= Installation configuration parameters for the Agent-based Installer
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installation-config-parameters-agent
6+
7+
toc::[]
8+
9+
Before you deploy an {product-title} cluster using the Agent-based Installer, you provide parameters to customize your cluster and the platform that hosts it.
10+
When you create the `install-config.yaml` and `agent-config.yaml` files, you must provide values for the required parameters, and you can use the optional parameters to customize your cluster further.
11+
12+
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
13+
14+
include::modules/agent-configuration-parameters.adoc[leveloffset=+1]
15+
16+
[role="_additional-resources"]
17+
.Additional resources
18+
* xref:../../installing/installing_with_agent_based_installer/prepare-pxe-assets-agent.adoc#prepare-pxe-assets-agent[Preparing PXE assets for {product-title}]
19+
* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#root-device-hints_ipi-install-installation-workflow[Root device hints]

‎modules/agent-configuration-parameters.adoc

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_with_agent_based_installer/installation-config-parameters-agent.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="agent-configuration-parameters_{context}"]
7+
= Available Agent configuration parameters
8+
9+
The following tables specify the required and optional Agent configuration parameters that you can set as part of the Agent-based installation process.
10+
11+
These values are specified in the `agent-config.yaml` file.
12+
13+
[NOTE]
14+
====
15+
These settings are used for installation only, and cannot be modified after installation.
16+
====
17+
18+
[id="agent-configuration-parameters-required_{context}"]
19+
== Required configuration parameters
20+
21+
Required Agent configuration parameters are described in the following table:
22+
23+
.Required parameters
24+
[cols=".^2l,.^3,.^5a",options="header"]
25+
|====
26+
|Parameter|Description|Values
27+
28+
|apiVersion:
29+
|The API version for the `agent-config.yaml` content.
30+
The current version is `v1beta1`.
31+
The installation program might also support older API versions.
32+
|String
33+
34+
|metadata:
35+
|Kubernetes resource `ObjectMeta`, from which only the `name` parameter is consumed.
36+
|Object
37+
38+
|metadata:
39+
name:
40+
|The name of the cluster.
41+
DNS records for the cluster are all subdomains of `{{.metadata.name}}.{{.baseDomain}}`.
42+
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+
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`.
45+
|====
46+
47+
48+
[id="agent-configuration-parameters-optional_{context}"]
49+
== Optional configuration parameters
50+
51+
Optional Agent configuration parameters are described in the following table:
52+
53+
.Optional parameters
54+
[cols=".^2l,.^4,.^4a",options="header"]
55+
|====
56+
|Parameter|Description|Values
57+
58+
|rendezvousIP:
59+
|The IP address of the node that performs the bootstrapping process as well as running the `assisted-service` component.
60+
You must provide the rendezvous IP address when you do not specify at least one host's IP address in the `networkConfig` parameter.
61+
If this address is not provided, one IP address is selected from the provided hosts' `networkConfig`.
62+
|IPv4 or IPv6 address.
63+
64+
|bootArtifactsBaseURL:
65+
|The URL of the server to upload Preboot Execution Environment (PXE) assets to when using the Agent-based Installer to generate an iPXE script.
66+
For more information, see "Preparing PXE assets for {product-title}".
67+
|String.
68+
69+
|additionalNTPSources:
70+
|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.
71+
|List of hostnames or IP addresses.
72+
73+
|hosts:
74+
|Host configuration.
75+
An optional list of hosts.
76+
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.
77+
|An array of host configuration objects.
78+
79+
|hosts:
80+
hostname:
81+
|Hostname.
82+
Overrides the hostname obtained from either the Dynamic Host Configuration Protocol (DHCP) or a reverse DNS lookup.
83+
Each host must have a unique hostname supplied by one of these methods, although configuring a hostname through this parameter is optional.
84+
|String.
85+
86+
|hosts:
87+
interfaces:
88+
|Provides a table of the name and MAC address mappings for the interfaces on the host.
89+
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.
90+
|An array of host configuration objects.
91+
92+
|hosts:
93+
interfaces:
94+
name:
95+
|The name of an interface on the host.
96+
|String.
97+
98+
|hosts:
99+
interfaces:
100+
macAddress:
101+
|The MAC address of an interface on the host.
102+
|A MAC address such as the following example: `00-B0-D0-63-C2-26`
103+
104+
|hosts:
105+
rootDeviceHints:
106+
|Enables provisioning of the {op-system-first} image to a particular device.
107+
The installation program examines the devices in the order it discovers them, and compares the discovered values with the hint values.
108+
It uses the first discovered device that matches the hint value.
109+
This is the device that the operating system is written on during installation.
110+
|A dictionary of key-value pairs.
111+
For more information, see "Root device hints" in the "Setting up the environment for an OpenShift installation" page.
112+
113+
|hosts:
114+
rootDeviceHints:
115+
deviceName:
116+
|The name of the device the {op-system} image is provisioned to.
117+
|String.
118+
119+
|hosts:
120+
networkConfig:
121+
|The host network definition.
122+
The configuration must match the Host Network Management API defined in the link:https://nmstate.io/[nmstate documentation].
123+
|A dictionary of host network configuration objects.
124+
|====

0 commit comments

Comments
 (0)