Bug 1976799 - [DOC] Document removal of ovirt-guest-agent windows from Virtio-win installer
Summary: [DOC] Document removal of ovirt-guest-agent windows from Virtio-win installer
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.4.8
Hardware: Unspecified
OS: Unspecified
high
medium
Target Milestone: ovirt-4.4.9
: ---
Assignee: Steve Goodman
QA Contact: Nisim Simsolo
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-06-28 09:50 UTC by Gal Zaidman
Modified: 2023-09-15 01:10 UTC (History)
11 users (show)

Fixed In Version:
Doc Type: Removed functionality
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-11-01 15:18:34 UTC
oVirt Team: Integration
Target Upstream Version:
Embargoed:
sgoodman: needinfo-


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github virtio-win virtio-win-guest-tools-installer pull 20 0 None closed Bug 1976799: Remove ovirt guest agent windows 2021-06-29 08:52:51 UTC

Description Gal Zaidman 2021-06-28 09:50:33 UTC
The ovirt guest agent windows is deprecated and we do not build it for el8 and above, the outcome for this is that SSO to windows machines is deprecated see[1].

We need to remove the agent from the virtio-win installer and document that SSO is not supported and that the agent is not a part of virtio-win.

[1] https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html/release_notes/deprecated_features_rhv

Comment 1 RHEL Program Management 2021-06-28 11:38:37 UTC
The documentation text flag should only be set after 'doc text' field is provided. Please provide the documentation text and set the flag to '?' again.

Comment 2 Michal Skrivanek 2021-06-28 12:40:14 UTC
Bug 1869251 tracks deprecation of SSO. Without SSO there is no reason for ovirt-guest-agent and then it can be removed

Comment 3 Sandro Bonazzola 2021-06-30 06:56:57 UTC
Moving back to assigned and moving to doc team for documenting the removal.
The modified code is in virtio-win package.

Comment 4 Steve Goodman 2021-10-03 14:38:00 UTC
If I understand correctly, I should remove this line in table 3.4 [1]:

--------
Table 3.4. Possible values for ADDLOCAL to install agents and required corresponding drivers

...

RHEV_Agent | Enables the Red Hat           | vioserial | FE_RHEV_Agent,FE_vioserial_driver 
             Virtualization Manager
             to receive internal virtual
             machine events and information,
             SSO support, Also enables the
             Manager to execute specific commands
             on a virtual machine.
...

--------


And we have a deprecation notice that I think could be clearer. Is this correct:


[NOTE]
====
Single Sign-On (SSO) is deprecated for virtual machines running Red Hat Enterprise Linux version 7 or earlier.
 
SSO is not supported for the following guest operating systems:
* Red Hat Enterprise Linux 8 or later 
* All versions of Windows 
====

This is actually confusing. "Deprecated" means: We don't provide support--use at your own risk.
So what is the case with support for RHEL 8 and Windows? Do they work but we don't support them? Or do they not work at all?




	
[1] https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide#values_for_addlocal_to_customize_virtio_win_command_line_installation

[2] https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide#Red_Hat_Virtualization_Guest_Agents_and_Drivers_windows_vm

Comment 5 Gal Zaidman 2021-10-04 09:17:16 UTC
(In reply to Steve Goodman from comment #4)
> If I understand correctly, I should remove this line in table 3.4 [1]:
> 
> --------
> Table 3.4. Possible values for ADDLOCAL to install agents and required
> corresponding drivers
> 
> ...
> 
> RHEV_Agent | Enables the Red Hat           | vioserial |
> FE_RHEV_Agent,FE_vioserial_driver 
>              Virtualization Manager
>              to receive internal virtual
>              machine events and information,
>              SSO support, Also enables the
>              Manager to execute specific commands
>              on a virtual machine.
> ...
> 
> --------
> 
> 
> And we have a deprecation notice that I think could be clearer. Is this
> correct:
> 
> 
> [NOTE]
> ====
> Single Sign-On (SSO) is deprecated for virtual machines running Red Hat
> Enterprise Linux version 7 or earlier.
>  
> SSO is not supported for the following guest operating systems:
> * Red Hat Enterprise Linux 8 or later 
> * All versions of Windows 
> ====
> 
> This is actually confusing. "Deprecated" means: We don't provide
> support--use at your own risk.
> So what is the case with support for RHEL 8 and Windows? Do they work but we
> don't support them? Or do they not work at all?
> 
> 
> 
> 
> 	
> [1]
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/
> html-single/
> virtual_machine_management_guide#values_for_addlocal_to_customize_virtio_win_
> command_line_installation
> 
> [2]
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/
> html-single/
> virtual_machine_management_guide#Red_Hat_Virtualization_Guest_Agents_and_Driv
> ers_windows_vm

You will need to remove:
1. From "Table 3.2. Red Hat Virtualization Guest agents and tools":
```
ovirt-guest-agent-common

Enables the Red Hat Virtualization Manager to receive internal virtual machine events and information such as IP address and installed applications. Also enables the Manager to execute specific commands on a virtual machine, such as shut down or reboot.

On virtual machines running Red Hat Enterprise Linux 6 or 7, ovirt-guest-agent-common installs tuned on your virtual machine and configures it to use an optimized, virtual machine profile. Use qemu-guest-agent on Red Hat Enterprise Linux 8 virtual machines

Server and Desktop.
```

and

```
rhev-sso

An agent that enables users to automatically log in to their virtual machines based on the credentials used to access the Red Hat Virtualization Manager.

Desktop.
```

2. From "3.3.2. Installing the guest agents, tools, and drivers on Windows":

```
Follow the prompts in the installation wizard. Ensure all check boxes in the list of components are selected, including the RHEV Agent, which is disabled by default.
```
to
```
Follow the prompts in the installation wizard.
```

```
After installation completes, the guest agents and drivers pass usage information to the Red Hat Virtualization Manager and enable you to access USB devices, single sign-on into virtual machines, and other functionality. The Red Hat Virtualization guest agent runs as a service called RHEV Agent that you can configure using the rhev-agent configuration file located in C:\Program Files\Virtio-Win\RHV_Agent.
````
to
```
After installation completes, the guest agents and drivers pass usage information to the Red Hat Virtualization Manager and enable you to access USB devices and other functionality.
```

3. From: Table 3.3. Possible values for ADDLOCAL to install drivers

Remove:
```
RHEV_Agent

Enables the Red Hat Virtualization Manager to receive internal virtual machine events and information, SSO support, Also enables the Manager to execute specific commands on a virtual machine.

vioserial

FE_RHEV_Agent,FE_vioserial_driver
```

Comment 6 Gal Zaidman 2021-10-04 09:18:52 UTC
(In reply to Steve Goodman from comment #4)
> If I understand correctly, I should remove this line in table 3.4 [1]:
> 
> --------
> Table 3.4. Possible values for ADDLOCAL to install agents and required
> corresponding drivers
> 
> ...
> 
> RHEV_Agent | Enables the Red Hat           | vioserial |
> FE_RHEV_Agent,FE_vioserial_driver 
>              Virtualization Manager
>              to receive internal virtual
>              machine events and information,
>              SSO support, Also enables the
>              Manager to execute specific commands
>              on a virtual machine.
> ...
> 
> --------
> 
> 
> And we have a deprecation notice that I think could be clearer. Is this
> correct:
> 
> 
> [NOTE]
> ====
> Single Sign-On (SSO) is deprecated for virtual machines running Red Hat
> Enterprise Linux version 7 or earlier.
>  
> SSO is not supported for the following guest operating systems:
> * Red Hat Enterprise Linux 8 or later 
> * All versions of Windows 
> ====
> 
> This is actually confusing. "Deprecated" means: We don't provide
> support--use at your own risk.
> So what is the case with support for RHEL 8 and Windows? Do they work but we
> don't support them? Or do they not work at all?
> 


> 
> 
> 
> 	
> [1]
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/
> html-single/
> virtual_machine_management_guide#values_for_addlocal_to_customize_virtio_win_
> command_line_installation
> 
> [2]
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/
> html-single/
> virtual_machine_management_guide#Red_Hat_Virtualization_Guest_Agents_and_Driv
> ers_windows_vm

They don't work at all because they don't exist :)

Comment 7 Gal Zaidman 2021-10-04 09:53:01 UTC
Hi QE,
I think that some of the things that are written have changed, specifically the installation from CLI.
Maybe QE can find the time to go over the instructions in this doc and make sure they still work? and if not then open a bug

Comment 8 Steve Goodman 2021-10-05 05:41:04 UTC
(In reply to Gal Zaidman from comment #6)
 
> They don't work at all because they don't exist :)

So is this correct:

[NOTE]
====
Single Sign-On (SSO) is deprecated for virtual machines running Red Hat Enterprise Linux version 7 or earlier.
 
SSO functionality is not included for the following guest operating systems:
* Red Hat Enterprise Linux 8 or later 
* All versions of Windows
====

Comment 9 Steve Goodman 2021-10-05 05:50:13 UTC
It's not clear to me from your latest comments if SSO is still supported for RHEL 7 and earlier virtual machines.

If SSO *is* supported for RHEL 7 and earlier VMs, then section 4.2. Configuring Single Sign-On for Virtual Machines [1] should be marked as applying only to RHEL 7 and earlier virtual machines, correct?

If SSO is *not* supported at all, then I need to remove section 4.2 entirely and update the deprecation notice to say that SSO has been removed entirely.

[1] https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#sect-Configuring_Single_Sign-On_for_Virtual_Machines

Comment 10 Steve Goodman 2021-10-05 06:02:43 UTC
Please add comments directly in the merge request:

https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/2080

Comment 11 Gal Zaidman 2021-10-05 07:04:18 UTC
(In reply to Steve Goodman from comment #8)
> (In reply to Gal Zaidman from comment #6)
>  
> > They don't work at all because they don't exist :)
> 
> So is this correct:
> 
> [NOTE]
> ====
> Single Sign-On (SSO) is deprecated for virtual machines running Red Hat
> Enterprise Linux version 7 or earlier.
>  
> SSO functionality is not included for the following guest operating systems:
> * Red Hat Enterprise Linux 8 or later 
> * All versions of Windows
> ====

don't know about rhel8, but the windows version is right

Comment 12 Gal Zaidman 2021-10-05 07:09:10 UTC
Let me remind you that this bug is for removing ovirt-guest-agent *windows* from *Virtio-win* installer - nothing about RHEL related, notice that there is a ovirt-guest-agent for linux and a different one for windows - this bug is about windows.

Comment 13 Steve Goodman 2021-10-05 12:32:50 UTC
(In reply to Gal Zaidman from comment #12)
> Let me remind you that this bug is for removing ovirt-guest-agent *windows*
> from *Virtio-win* installer - nothing about RHEL related, notice that there
> is a ovirt-guest-agent for linux and a different one for windows - this bug
> is about windows.

I understand that, but some of this content, such as the deprecation notice, has info for both Linux and Windows, so I want to get it right for both of them. I asked the RHV Developers on gchat about RHEL VMs.

Comment 14 Steve Goodman 2021-10-11 15:34:36 UTC
OK. As far as the Windows part is concerned, do you approve the MR?

Comment 15 Gal Zaidman 2021-10-12 08:27:47 UTC
(In reply to Steve Goodman from comment #14)
> OK. As far as the Windows part is concerned, do you approve the MR?

Can you link the PR? I don't see it on the bug

Comment 16 Steve Goodman 2021-10-12 10:07:38 UTC
(In reply to Gal Zaidman from comment #15)
> > OK. As far as the Windows part is concerned, do you approve the MR?
> 
> Can you link the PR? I don't see it on the bug

https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_Enterprise_Virtualization/-/merge_requests/2080

Comment 17 Gal Zaidman 2021-10-13 12:14:31 UTC
(In reply to Steve Goodman from comment #16)
> (In reply to Gal Zaidman from comment #15)
> > > OK. As far as the Windows part is concerned, do you approve the MR?
> > 
> > Can you link the PR? I don't see it on the bug
> 
> https://gitlab.cee.redhat.com/rhci-documentation/docs-
> Red_Hat_Enterprise_Virtualization/-/merge_requests/2080

There is only one thing to remove, on "6.14.5. Guest Agent Hooks" - remove the windows stuff
Other then that you are good to go

Comment 18 Steve Goodman 2021-10-14 08:29:25 UTC
(In reply to Gal Zaidman from comment #17)
> There is only one thing to remove, on "6.14.5. Guest Agent Hooks" - remove
> the windows stuff
> Other then that you are good to go

Please take a final look and approve.

Comment 19 Steve Goodman 2021-10-18 15:27:08 UTC
Gal approved offline.

Eli, please do peer review.

Comment 20 Steve Goodman 2021-10-19 11:01:35 UTC
Please review the Github PR (In the Gitlab MR, only the deprecation notice in the Release Notes will be merged.)

https://github.com/oVirt/ovirt-site/pull/2593

Comment 22 Steve Goodman 2021-10-20 11:25:37 UTC
(In reply to Gal Zaidman from comment #7)
> Hi QE,
> I think that some of the things that are written have changed, specifically
> the installation from CLI.
> Maybe QE can find the time to go over the instructions in this doc and make
> sure they still work? and if not then open a bug

Gal, can you specify which procedures you want QE to test?

Comment 24 Nisim Simsolo 2021-10-28 13:32:49 UTC
Verified (ovirt-engine-4.4.9-0.6.el8ev)

procedure [1] is still working, using Wizard and CMD line commands.
no comments to add inside google doc [2]

Comment 27 Red Hat Bugzilla 2023-09-15 01:10:39 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.