Bug 2082671

Document URL: https://docs.openshift.com/container-platform/4.10/installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.html

Section Number and Name: https://docs.openshift.com/container-platform/4.10/installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.html

Describe the issue: In the "Preparing the bare metal node" section of the above documentation there is Baremetalhost definition file that includes the section "networkConfig".

~~~
apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  name: openshift-worker-<num> 
spec:
  online: true
  bootMACAddress: <NIC1-mac-address> 
  bmc:
    address: <protocol>://<bmc-ip> 
    credentialsName: openshift-worker-<num>-bmc-secret 
  networkConfig:                              <------------------
    interfaces:
    - name: <NIC1_name>
      type: ethernet
      state: up
      ipv4:
        address:
        - ip: "<IP_address>"
          prefix-length: 24
        enabled: true
    dns-resolver:
      config:
        server:
        - <DNS_IP_address>
    routes:
      config:
      - destination: 0.0.0.0/0
        next-hop-address: <IP_address>
        next-hop-interface: <NIC1_name>
~~~

This is not valid as it is not included in the API reference documentation page:

https://docs.openshift.com/container-platform/4.10/rest_api/provisioning_apis/baremetalhost-metal3-io-v1alpha1.html

Or at the latest version oc client:

~~~
[nstamate@nstamate ~]$ oc version
Client Version: 4.10.12
Server Version: 4.10.8
Kubernetes Version: v1.23.5+1f952b3
[nstamate@nstamate ~]$ oc explain baremetalhost.spec
KIND:     BareMetalHost
VERSION:  metal3.io/v1alpha1

RESOURCE: spec <Object>

DESCRIPTION:
     BareMetalHostSpec defines the desired state of BareMetalHost

FIELDS:
   ------------------ trimmed output -----------------------------------
   metaData	<Object>
     MetaData holds the reference to the Secret containing host metadata (e.g.
     meta_data.json) which is passed to the Config Drive.

   networkData	<Object>
     NetworkData holds the reference to the Secret containing network
     configuration (e.g content of network_data.json) which is passed to the
     Config Drive.

   online	<boolean> -required-
     Should the server be online?

   ------------------ trimmed output -----------------------------------

The only way to configure the bare metal node's networking during provisioning is using the "networkData" object or using "networkConfig" during installation fo the cluster AFAIK or correct me if I'm wrong.

Suggestions for improvement: 

This section should be removed/corrected as it is misleading customers. 

Additional information: 

This was found during the investigation of the attached case.