Bug 1868748

Summary: ClusterProvisioningIP in baremetal platform has wrong JSON annotation
Product: OpenShift Container Platform Reporter: Stephen Benjamin <stbenjam>
Component: InstallerAssignee: Stephen Benjamin <stbenjam>
Installer sub component: OpenShift on Bare Metal IPI QA Contact: Shelly Miron <smiron>
Status: CLOSED ERRATA Docs Contact:
Severity: medium    
Priority: medium CC: asimonel, beth.white, rbartal
Version: 4.6Keywords: Triaged
Target Milestone: ---   
Target Release: 4.7.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Cause: The baremetal IPI platform in the install-config.yaml used an incorrect field name for the clusterProvisioningIP, calling it provisioningHostIP. Consequence: There was a disconnect between documentation and the actual field name used in the YAML file. Fix: provisioningHostIP is deprecated in favor of clusterProvisioningIP.
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-02-24 15:15:36 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Stephen Benjamin 2020-08-13 17:32:23 UTC
The ClusterProvisioningIP field in the baremetal platform had an
incorrect JSON annotation for serialization/deserialization, using
"provisioningHostIP" instead of "clusterProvisioningIP." This name is
incorrect and doesn't adequately reflect it's purpose. This field is
the IP used in the cluster for provisioning.

We should deprecate the old name and move to the new one to prevent confusion.

Comment 9 Shelly Miron 2020-12-23 13:31:53 UTC
When configuring the install-config.yaml to include both clusterProvisioningIP and provisioningHostIP, this message appear (as expected):

[kni@provisionhost-0-0 ~]$ ./openshift-baremetal-install --dir ~/ocp create manifests

FATAL failed to fetch Master Machines: failed to load asset "Install Config": failed to upconvert install config: platform.baremetal.provisioningHostIP: Invalid value: "172.23.0.3": provisioningHostIP is deprecated; only clusterProvisioningIP needs to be specified  

But when specifying only the provisioningHostIP field in the install-config.yaml, it is actually continuing with no problem - 
so if the field is deprecated shouldn't the manifests command show an alert here also?

Comment 10 Stephen Benjamin 2021-01-05 14:07:17 UTC
It's working as designed, the installer team asked us to deprecate it this way and it's consistent with how other things are upconverted silently.

Comment 11 Shelly Miron 2021-01-05 14:12:57 UTC
OK. so I'm verifying it as described in comment 9 .

Comment 13 errata-xmlrpc 2021-02-24 15:15:36 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: OpenShift Container Platform 4.7.0 security, bug fix, and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2020:5633