Bug 2015218 - Add a deprecated notice on instance_type_id field of machine object and release notes for 4.9 release
Summary: Add a deprecated notice on instance_type_id field of machine object and relea...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Installer
Version: 4.9
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 4.9.z
Assignee: Steve Goodman
QA Contact: Michael Burman
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-10-18 16:23 UTC by Gal Zaidman
Modified: 2021-10-27 13:34 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Deprecated Functionality
Doc Text:
The `instance_type_id` installation configuration parameter is deprecated and will be removed in a future release.
Clone Of:
Environment:
Last Closed: 2021-10-27 13:34:42 UTC
Target Upstream Version:
Embargoed:
pelauter: needinfo-


Attachments (Terms of Use)

Description Gal Zaidman 2021-10-18 16:23:46 UTC
We want to remove the "instance_type_id" field from the machine object on 4.10 since it is deprecated in RHV.

We need to add a deprecated warning on the following pages:

1. https://docs.openshift.com/container-platform/4.9/machine_management/creating_machinesets/creating-machineset-rhv.html#machineset-yaml-rhv_creating-machineset-rhv

We should write that:
The "instance_type_id" field is deprecated and will be removed on openshift 4.10.

On the "instance_type_id" field number 8.

2. https://docs.openshift.com/container-platform/4.9/installing/installing_rhv/installing-rhv-customizations.html#installation-configuration-parameters-additional-machine_installing-rhv-customizations

We should write that:
The "instanceTypeID" field is deprecated and will be removed on openshift 4.10.

On the "instanceTypeID" field in the table.

And a note on the release notes of 4.9.

We should write that the "instance_type_id" field of the machine object and the "instanceTypeID" field of the install-config is deprecated and will be removed on openshift 4.10

Comment 1 Steve Goodman 2021-10-20 12:15:58 UTC
PR created. Please review:

https://github.com/openshift/openshift-docs/pull/37745

Comment 2 Steve Goodman 2021-10-20 12:25:37 UTC
Gal, does this only apply to 4.9? Or should I add it in 4.8 and 4.7 as well?

Comment 3 Gal Zaidman 2021-10-20 12:33:27 UTC
I think you can add it to 4.8 and 4.7

Comment 4 Steve Goodman 2021-10-20 16:57:39 UTC
Michael, please review the PR.

There is a process for adding a release note, so although comment 0 mentions this as well, please just review the PR right now. We might address the Release Note separately to expedite getting this into the main doc.

Comment 5 Steve Goodman 2021-10-20 16:58:39 UTC
Michael, the PR (comment 1) includes links to preview topics where you can see the changes mentioned.

Comment 6 Michael Burman 2021-10-21 06:18:08 UTC
(In reply to Steve Goodman from comment #4)
> Michael, please review the PR.
> 
> There is a process for adding a release note, so although comment 0 mentions
> this as well, please just review the PR right now. We might address the
> Release Note separately to expedite getting this into the main doc.

Hi Steve, lgtm! thanks,

Comment 7 Steve Goodman 2021-10-21 15:11:09 UTC
As per the OpenShift process for changing the Release Notes for a z-stream release (hopefully we'll hit it before 4.9.1), I need formal Acks on updating the Release Notes from:

Eng (Gal)
PM (Peter)
Product experience...?
QE (Michael)
DPM (Catherine)

Please respond with ACK.

Comment 8 Michael Burman 2021-10-25 06:28:31 UTC
(In reply to Steve Goodman from comment #7)
> As per the OpenShift process for changing the Release Notes for a z-stream
> release (hopefully we'll hit it before 4.9.1), I need formal Acks on
> updating the Release Notes from:
> 
> Eng (Gal)
> PM (Peter)
> Product experience...?
> QE (Michael)
Looks good to me
> DPM (Catherine)
> 
> Please respond with ACK.

Comment 9 ctomasko 2021-10-25 18:26:21 UTC
@sgoodman LGTM to please add a release note. Looks like it's deprecated in 4.9. Go ahead and add the release note to 4.9. There is no need to wait until 4.9.1. Thanks

Comment 10 Gal Zaidman 2021-10-26 07:32:02 UTC
ACK from dev

Comment 13 Marina Kalinin 2021-10-26 17:36:42 UTC
(In reply to Steve Goodman from comment #7)
> As per the OpenShift process for changing the Release Notes for a z-stream
> release (hopefully we'll hit it before 4.9.1), I need formal Acks on
> updating the Release Notes from:
> 
> Eng (Gal)
> PM (Peter)
> Product experience...?
Ack
> QE (Michael)
> DPM (Catherine)
> 
> Please respond with ACK.


Note You need to log in before you can comment on or make changes to this bug.