Skip to content

Commit 50b4a9d

Browse files
jldohmannjldohmann
authored
Merge pull request #70677 from skopacz1/OSDOCS-9003
OSDOCS#9003: Agent BMC configuration parameters
2 parents 2173285 + 68797a4 commit 50b4a9d

File tree

2 files changed

+137
-0
lines changed

2 files changed

+137
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ When you create the `install-config.yaml` and `agent-config.yaml` files, you mus
1111

1212
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
1313

14+
[role="_additional-resources"]
15+
.Additional resources
16+
* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
17+
1418
include::modules/agent-configuration-parameters.adoc[leveloffset=+1]
1519

1620
[role="_additional-resources"]

‎modules/installation-configuration-parameters.adoc

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1882,6 +1882,139 @@ with an Azure cluster.
18821882
====
18831883
endif::azure[]
18841884

1885+
ifdef::agent[]
1886+
[id="installation-configuration-parameters-additional-bare_{context}"]
1887+
== Additional bare metal configuration parameters for the Agent-based Installer
1888+
1889+
Additional bare metal installation configuration parameters for the Agent-based Installer are described in the following table:
1890+
1891+
[NOTE]
1892+
====
1893+
These fields are not used during the initial provisioning of the cluster, but they are available to use once the cluster has been installed.
1894+
Configuring these fields at install time eliminates the need to set them as a Day 2 operation.
1895+
====
1896+
1897+
.Additional bare metal parameters
1898+
[cols=".^2l,.^3a,.^3a",options="header"]
1899+
|====
1900+
|Parameter|Description|Values
1901+
1902+
|platform:
1903+
baremetal:
1904+
clusterProvisioningIP:
1905+
|The IP address within the cluster where the provisioning services run.
1906+
Defaults to the third IP address of the provisioning subnet.
1907+
For example, `172.22.0.3` or `2620:52:0:1307::3`.
1908+
|IPv4 or IPv6 address.
1909+
1910+
|platform:
1911+
baremetal:
1912+
provisioningNetwork:
1913+
|The `provisioningNetwork` configuration setting determines whether the cluster uses the provisioning network.
1914+
If it does, the configuration setting also determines if the cluster manages the network.
1915+
1916+
`Managed`: Default. Set this parameter to `Managed` to fully manage the provisioning network, including DHCP, TFTP, and so on.
1917+
1918+
`Disabled`: Set this parameter to `Disabled` to disable the requirement for a provisioning network.
1919+
When set to `Disabled`, you can use only virtual media based provisioning on Day 2.
1920+
If `Disabled` and using power management, BMCs must be accessible from the bare-metal network.
1921+
If Disabled, you must provide two IP addresses on the bare-metal network that are used for the provisioning services.
1922+
1923+
|`Managed` or `Disabled`.
1924+
1925+
|platform:
1926+
baremetal:
1927+
provisioningMACAddress:
1928+
|The MAC address within the cluster where provisioning services run.
1929+
|MAC address.
1930+
1931+
|platform:
1932+
baremetal:
1933+
provisioningNetworkCIDR:
1934+
|The CIDR for the network to use for provisioning.
1935+
This option is required when not using the default address range on the provisioning network.
1936+
|Valid CIDR, for example `10.0.0.0/16`.
1937+
1938+
|platform:
1939+
baremetal:
1940+
provisioningNetworkInterface:
1941+
|The name of the network interface on nodes connected to the provisioning network.
1942+
Use the `bootMACAddress` configuration setting to enable Ironic to identify the IP address of the NIC instead of using the `provisioningNetworkInterface` configuration setting to identify the name of the NIC.
1943+
|String.
1944+
1945+
|platform:
1946+
baremetal:
1947+
provisioningDHCPRange:
1948+
|Defines the IP range for nodes on the provisioning network, for example `172.22.0.10,172.22.0.254`.
1949+
|IP address range.
1950+
1951+
|platform:
1952+
baremetal:
1953+
hosts:
1954+
|Configuration for bare metal hosts.
1955+
|Array of host configuration objects.
1956+
1957+
|platform:
1958+
baremetal:
1959+
hosts:
1960+
name:
1961+
|The name of the host.
1962+
|String.
1963+
1964+
|platform:
1965+
baremetal:
1966+
hosts:
1967+
bootMACAddress:
1968+
|The MAC address of the NIC used for provisioning the host.
1969+
|MAC address.
1970+
1971+
|platform:
1972+
baremetal:
1973+
hosts:
1974+
bmc:
1975+
|Configuration for the host to connect to the baseboard management controller (BMC).
1976+
|Dictionary of BMC configuration objects.
1977+
1978+
|platform:
1979+
baremetal:
1980+
hosts:
1981+
bmc:
1982+
username:
1983+
|The username for the BMC.
1984+
|String.
1985+
1986+
|platform:
1987+
baremetal:
1988+
hosts:
1989+
bmc:
1990+
password:
1991+
|Password for the BMC.
1992+
|String.
1993+
1994+
|platform:
1995+
baremetal:
1996+
hosts:
1997+
bmc:
1998+
address:
1999+
|The URL for communicating with the host's BMC controller.
2000+
The address configuration setting specifies the protocol.
2001+
For example, `redfish+http://10.10.10.1:8000/redfish/v1/Systems/1234` enables Redfish.
2002+
For more information, see "BMC addressing" in the "Deploying installer-provisioned clusters on bare metal" section.
2003+
|URL.
2004+
2005+
|platform:
2006+
baremetal:
2007+
hosts:
2008+
bmc:
2009+
disableCertificateVerification:
2010+
|`redfish` and `redfish-virtualmedia` need this parameter to manage BMC addresses.
2011+
The value should be `True` when using a self-signed certificate for BMC addresses.
2012+
|Boolean.
2013+
2014+
|====
2015+
endif::agent[]
2016+
2017+
18852018
ifdef::gcp[]
18862019
[id="installation-configuration-parameters-additional-gcp_{context}"]
18872020
== Additional Google Cloud Platform (GCP) configuration parameters

0 commit comments

Comments
 (0)