Bug 2035985

Summary: The description of --timeout should be updated in sub-daemon's manpage except virtqemud
Product: Red Hat Enterprise Linux 9 Reporter: yafu <yafu>
Component: libvirtAssignee: Ján Tomko <jtomko>
libvirt sub component: General QA Contact: yafu <yafu>
Status: CLOSED ERRATA Docs Contact:
Severity: unspecified    
Priority: unspecified CC: jdenemar, jtomko, lmen, virt-maint, xuzhang
Version: 9.0Keywords: Triaged
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: libvirt-9.2.0-1.el9 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-11-07 08:30:47 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: 9.2.0
Embargoed:

Description yafu 2021-12-29 05:54:22 UTC
Description of problem:
The description of --timeout should be updated in sub-daemon's manpage except virtqemud

Version-Release number of selected component (if applicable):
libvirt-7.10.0-1.el9.x86_64

How reproducible:
100%

Steps to Reproduce:
1.#man virtnetworkd
...
-t, --timeout *SECONDS*

       Exit after timeout period (in seconds), provided there are neither any client connections nor any running domains.
...


2.
3.

Actual results:
sub-daemon except virtqemdu will exit after timeout period even there are running domains or related resources. So should update the description of --timeout.


Expected results:


Additional info:

Comment 1 Peter Krempa 2022-01-19 17:14:43 UTC
Per discussion upstream, adding a blanket vague description of the timeout is not desired:

https://listman.redhat.com/archives/libvir-list/2022-January/msg00878.html

Comment 2 Ján Tomko 2023-03-15 10:24:38 UTC
Upstream patch:
https://listman.redhat.com/archives/libvir-list/2023-March/238816.html

Comment 3 Ján Tomko 2023-03-15 16:33:06 UTC
Pushed as:
commit 3916df52a4a9174acc7812d15d8726651768f207
Author:     Ján Tomko <jtomko>
CommitDate: 2023-03-15 17:23:18 +0100

    docs: clarify --timeout description for virtsecretd
    
    As of commit 9e3cc0ff5 the virtsecretd daemon does not timeout
    while it keeps any ephemeral secrets.
    
    https://bugzilla.redhat.com/show_bug.cgi?id=2035985
    
    Signed-off-by: Ján Tomko <jtomko>
    Reviewed-by: Andrea Bolognani <abologna>

commit f65c9d83ab8463bd91c60d6edbc35768fa2804a8
Author:     Ján Tomko <jtomko>
CommitDate: 2023-03-15 17:23:18 +0100

    docs: clarify --timeout description for split daemons
    
    Remove the reference to "running domains" for daemons that happily
    exit while domains are running.
    
    https://bugzilla.redhat.com/show_bug.cgi?id=2035985
    
    Signed-off-by: Ján Tomko <jtomko>
    Reviewed-by: Andrea Bolognani <abologna>

git describe: v9.1.0-232-g3916df52a4

Comment 4 yafu 2023-04-07 09:19:41 UTC
Pre-verified with libvirt-9.2.0-1.el9.x86_64.

Test steps:
1.Check --timeout description for virtqemud:
#man virtqemud
...
-t, --timeout *SECONDS*

       Exit after timeout period (in seconds), provided there are neither any client connections nor any running domains.

2.Check --timeout description for other sub-daemons except virtsecrtd:
#man virtnetworkd
..
-t, --timeout *SECONDS*

       Exit after timeout period (in seconds), provided there are no client connections.

3.Check --timeout description for virtsecretd:
#man virtsecretd
...
-t, --timeout *SECONDS*

       Exit  after  timeout period (in seconds), provided there are neither any client con‐
       nections nor any ephemeral secrets.

Comment 8 yafu 2023-05-22 08:05:28 UTC
Verified with libvirt-9.3.0-2.el9.x86_64.

Comment 10 errata-xmlrpc 2023-11-07 08:30:47 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: libvirt 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-2023:6409