Bug 1940232 - [Docs][Upgade] Document new CL 4.6 and the functionality it enables
Summary: [Docs][Upgade] Document new CL 4.6 and the functionality it enables
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.4.6
Hardware: Unspecified
OS: Unspecified
high
medium
Target Milestone: ovirt-4.4.6
: ---
Assignee: Donna DaCosta
QA Contact: Lucie Leistnerova
URL:
Whiteboard:
Depends On: 1933974
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-03-17 21:08 UTC by Marina Kalinin
Modified: 2023-09-15 01:03 UTC (History)
18 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-06-02 16:14:11 UTC
oVirt Team: Infra
Target Upstream Version:
Embargoed:
sgoodman: needinfo-
sgoodman: needinfo-
sgoodman: needinfo-


Attachments (Terms of Use)

Description Marina Kalinin 2021-03-17 21:08:44 UTC
In RHV 4.4.6 we will get a new CL introduced - CL 4.6. Check bz#1933974 for additional details and see the bugs it blocks to learn about the new functionality coming with it.

We need to document what is the functionality and that this functionality would not be available, unless you change CL to 4.6. And the whole fact that the new CL is there and required.

The tricky part is where to introduce this.
It should be done together with 4.5 CL, which we did NOT document in the official documentation and has been introduced in RHV 4.4.3. See this KCS: https://access.redhat.com/solutions/5600181. So ideally, we include this CL 4.5 as well.

Upgrade Guide seems to be the best place for this. But where would you put it? Under upgrade between minor releases?
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/upgrade_guide/index#Updates_between_Minor_Releases
But this section is under Appendix. Why? It is an important section, should not be under Appendix. IMO it should be a standard chapter of its own together with upgrades from minor releases. Regardless,
This chapter altogether needs to have a new section where we talk about changing CL.
And maybe there we can also introduce the two new CLs - 4.5 and 4.6?


Additional Information:
Since the new features are documented in the Release Notes for that z-stream release, this is not a request to document those features per se. However, we may consider adding to the release notes the requirements for CL 4.6 with them.

Comment 1 Martin Perina 2021-03-18 08:25:45 UTC
DC/CL level 4.6 is just an infrastructrue enablement, by its own it doesn't bring any value to customers. Each RFE depending on BZ1933974 will have its own documentation requirements, because only those RFEs delivers features visible to customers.

Comment 3 Steve Goodman 2021-04-25 13:49:24 UTC
Here's my understanding of the scope of the changes we're talking about:

RFE: New features. These DO REQUIRE documentation.
Bugs: These DO NOT require documentation. If the *requires_doc_text* field is set to `?` these require a note in the Release Notes.

NOTICE: Only bug 1892800 provides text for a release note. All others do not and therefore will not appear in the Release Notes as of now.

----

Cluster and Datacenter compatibility version 4.5 in RHV 4.4.3

RFE:
    Bug 1725166 - [RFE] Private VLAN / port isolation, for more details about this feature please see Is there support for Private VLANs (PVLANs) or Port Isolation in RHV?
    Bug 1745024 - [RFE] Enabling Icelake new NIs

[1]

----

Cluster and Datacenter compatibility version 4.6 in RHV 4.4.6

RFE:
    Bug 1927718 [RFE] Provide Reset option for VMs
    Bug 1688177 [RFE] [SR-IOV] Migration should not require downtime as of today

BUGS:
    Bug 1834250 CPU hotplug on UEFI VM causes VM reboot
    Bug 1892800 NVDIMM: VM hangs in wait for launch for more than 7 minutes before VM is up. RELEASE NOTE PROVIDED
    Bug 1936163 Enable bochs-display for UEFI guests by default
    Bug 1936164 Enable KVM Software TPM by default
    Bug 1942494 Provide Reset option for VMs
    Bug 1821199 HP VM fails to migrate between identical hosts (the same cpu flags) not supporting TSC.


--------
[1] https://access.redhat.com/solutions/5600181
[2] https://bugzilla.redhat.com/show_bug.cgi?id=1933974

Comment 4 Steve Goodman 2021-04-25 13:51:29 UTC
Martin and Marina,

Comment 3 shows the scope of what I understand needs to be documented. Notice that I am only addressing RFEs and any bugs that have requires_doc_text set to `?` and includes a draft of a release note in the doc_text field.

Comment 5 Steve Goodman 2021-04-25 14:00:07 UTC
Bug 1927718 [RFE] Provide Reset option for VMs

I will document how to reset a VM using the Admin Portal and/or VM portal as follows:

To reset a virtual machine without shutting it down:

1. Click Computer>Virtual Machines
2. Select the virtual machine you want to reset.
3. Click the down arrow next to *Reboot*, then click *Reset*.

The virtual machine the virtual machine's console remains open and connected while the virtual machine reboots.

Comment 6 Martin Perina 2021-04-26 06:08:54 UTC
(In reply to Steve Goodman from comment #3)
> Here's my understanding of the scope of the changes we're talking about:
> 
> RFE: New features. These DO REQUIRE documentation.
> Bugs: These DO NOT require documentation. If the *requires_doc_text* field
> is set to `?` these require a note in the Release Notes.
> 
> NOTICE: Only bug 1892800 provides text for a release note. All others do not
> and therefore will not appear in the Release Notes as of now.
> 
> ----
> 
> Cluster and Datacenter compatibility version 4.5 in RHV 4.4.3
> 
> RFE:
>     Bug 1725166 - [RFE] Private VLAN / port isolation, for more details
> about this feature please see Is there support for Private VLANs (PVLANs) or
> Port Isolation in RHV?
>     Bug 1745024 - [RFE] Enabling Icelake new NIs
> 
> [1]

Looks good to me

> 
> ----
> 
> Cluster and Datacenter compatibility version 4.6 in RHV 4.4.6
> 
> RFE:
>     Bug 1927718 [RFE] Provide Reset option for VMs
>     Bug 1688177 [RFE] [SR-IOV] Migration should not require downtime as of
> today

BZ1688177 is currently blocked by significant platform issues, so it will either be released as tech preview or moved to later RHV 4.4.z, which will depend on RHEL 8.5. We are going to have a decision about it this week.

> 
> BUGS:
>     Bug 1834250 CPU hotplug on UEFI VM causes VM reboot
>     Bug 1892800 NVDIMM: VM hangs in wait for launch for more than 7 minutes
> before VM is up. RELEASE NOTE PROVIDED
>     Bug 1936163 Enable bochs-display for UEFI guests by default
>     Bug 1936164 Enable KVM Software TPM by default
>     Bug 1942494 Provide Reset option for VMs
>     Bug 1821199 HP VM fails to migrate between identical hosts (the same cpu
> flags) not supporting TSC.
> 
> 
> --------
> [1] https://access.redhat.com/solutions/5600181
> [2] https://bugzilla.redhat.com/show_bug.cgi?id=1933974

Arik/Eyal/Sandro, any other RFEs/bugs, which depend on CL 4.6 and you would like to mention?

Comment 7 Eyal Shenitzky 2021-04-26 06:33:09 UTC
Those are the RFEs/bugs from the storage side that dependent on CL 4.6 - 

Bug 1906074 - [RFE] Support disks copy between regular and managed block storage domains
Bug 1950752 - [RFE][CBT] redefine only the checkpoint that the backup is taken from and not the entire chain

Comment 8 Arik 2021-04-26 07:14:11 UTC
added bz 1669178 to the list of depended bugs - should be mentioned as well

Comment 9 Marina Kalinin 2021-04-26 14:44:48 UTC
Hi Steve,

I didn't understand 100% what you meant.
I want a note explaning that (1) 4.6 CL is introduced; (2) What does it include. I probably do not know to say, if we care about other bugs release notes presence. Just to have them listed.
And same for CL 4.5.
Does it help?


Also, can move out the minor upgrades section from appendix to a regular section?

Thank you,
Marina.

Comment 10 Steve Goodman 2021-05-09 13:11:03 UTC
(In reply to Marina Kalinin from comment #9)
> Hi Steve,

Hi Marina,

 
> I didn't understand 100% what you meant.
> I want a note explaning that (1) 4.6 CL is introduced; 

Can you clarify? Do we have a similar note for any previous CL level?

(2) What does it
> include. I probably do not know to say, if we care about other bugs release
> notes presence. Just to have them listed.
> And same for CL 4.5.
> Does it help?

Not really. Comment 1 indicates that the compatibility level is simply a collection of new features and bug fixes, and that those require documentation.

Comment 3 describes what I understand needs to be done as far as documentation.


> Also, can move out the minor upgrades section from appendix to a regular
> section?

Are you talking about the Admin Guide? Or the Upgrade Guide?

Comment 14 Steve Goodman 2021-05-11 15:39:03 UTC
After meeting with Peter, Marina and Michal, this is the scope of this bug:

1. Release Notes: Mention the new features in the compatibility level in the Enhancements section of the RN. All new features should have a release note, with "Supported in compatibility version 4.n"
2. Technical Reference: Add a table mentioning which versions of RHV support which compatibility level (4.5, 4.6,...4.n) in "Compatibility levels" in TBD section 1.7 of the technical reference.
3. Upgrade Guide: Currently we document updating the cluster and data center compatibility version as part of the regular upgrade flow. Because there is no longer a Y-stream upgrade, but new compatibility levels are still being introduced as part of z-streams, that content needs to be part of the section "Appendix A. Updates between minor releases". Marina would also make that section _not_ an appendix, so it would become Part IV.

Additionally, we can address comment 5 as part of this bug. It can be added to the VMM Guide as part of section 6.3 Rebooting a virtual machine. I would change the title to Rebooting/Resetting a virtual machine" and possibly add a separate procedure for it in the same module with an explanation of the difference between reboot and reset.


Out of scope: Listing each individual feature introduced/bug fixed in the table in the Technical Reference.

Comment 15 Steve Goodman 2021-05-11 15:41:40 UTC
The upgrade guide changes will require QE verification.

Comment 16 Sandro Bonazzola 2021-05-12 11:50:10 UTC
(In reply to Martin Perina from comment #6)

> Arik/Eyal/Sandro, any other RFEs/bugs, which depend on CL 4.6 and you would
> like to mention?

Nothing on my side

Comment 17 Eyal Shenitzky 2021-05-12 12:04:05 UTC
Yes - 

Redefine only the checkpoint that the backup is taken from and not the entire chain - bug 1950752
Support disks copy between regular and managed block storage domains - bug 1906074

Comment 18 Eyal Shenitzky 2021-05-12 12:05:12 UTC
(In reply to Eyal Shenitzky from comment #17)
> Yes - 
> 
> Redefine only the checkpoint that the backup is taken from and not the
> entire chain - bug 1950752
> Support disks copy between regular and managed block storage domains - bug
> 1906074

Oh sorry, I just saw that I already replied on this one, so you can ignore comment #17.

Comment 30 Steve Goodman 2021-06-01 17:04:53 UTC
Peer review completed. I made several comments.

Comment 31 Steve Goodman 2021-06-01 17:05:25 UTC
I removed NEEDINFO from Richard and Eli.

Comment 37 Red Hat Bugzilla 2023-09-15 01:03:36 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 500 days


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