Bug 1354391

Summary:	[doc]Update manual page for schedinfo command with new added parameters
Product:	Red Hat Enterprise Linux Advanced Virtualization	Reporter:	Pei Zhang <pzhang>
Component:	libvirt	Assignee:	Andrea Bolognani <abologna>
Status:	CLOSED ERRATA	QA Contact:	Jing Qi <jinqi>
Severity:	low	Docs Contact:
Priority:	low
Version:	8.3	CC:	dyuan, jdenemar, knoel, phrdina, virt-maint, xuzhang, yalzhang
Target Milestone:	rc	Flags:	pm-rhel: mirror+
Target Release:	8.3
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	libvirt-6.10.0-1.el8	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-05-25 06:41:16 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:	6.8.0
Embargoed:

Description Pei Zhang 2016-07-11 08:33:24 UTC

Description of problem:
schedinfo command added two parameters, but no description about them in man page. 

Version-Release number of selected component (if applicable):
libvirt-2.0.0-2.el7.x86_64

How reproducible:
100%

Steps to Reproduce:
1. check schedinfo command 

# virsh schedinfo vm1
Scheduler      : posix
cpu_shares     : 1024
vcpu_period    : 100000
vcpu_quota     : -1
emulator_period: 100000
emulator_quota : -1
global_period  : 100000
global_quota   : -1 

2. check man page 
#man virsh 
schedinfo :
......           
QEMU/KVM (posix scheduler): cpu_shares, vcpu_period, vcpu_quota, emulator_period, emulator_quota
......

Actual results:
As above, There is no description for new added parameters.

Expected results:
It should add descriptions for them including value range, the relationships with other parameters. Such as global values should be equal or more than the vcpu values.
 
Additional info:

Comment 3 Andrea Bolognani 2020-09-18 16:40:52 UTC

Patch posted upstream.

  https://www.redhat.com/archives/libvir-list/2020-September/msg01045.html

Comment 4 Andrea Bolognani 2020-09-23 09:39:50 UTC

Fix merged upstream.

  commit 1d46f03a55b7a22075046f03bf356ee89a32e0a6
  Author: Andrea Bolognani <abologna>
  Date:   Fri Sep 18 18:36:25 2020 +0200

    docs: Document global_{period,quota} schedinfo fields
    
    These fields have existed for a very long time but they were
    never documented in virsh(1).
    
    https://bugzilla.redhat.com/show_bug.cgi?id=1354391
    
    Signed-off-by: Andrea Bolognani <abologna>
    Reviewed-by: Pavel Hrdina <phrdina>

Comment 9 Jing Qi 2020-12-08 09:48:12 UTC

Verified in version libvirt-daemon-6.10.0-1.module+el8.4.0+8898+a84e86e1.x86_64


S1: Check the virsh schedinfo parameters all exist

1. Check the virsh man page about the schedinfo
man virsh |grep -A10 schedinfo
   schedinfo
       Syntax:

          schedinfo domain [[--config] [--live] | [--current]] [[--set] parameter=value]...
          schedinfo [--weight number] [--cap number] domain

       Allows you to show (and set) the domain scheduler parameters. The parameters available for each hypervisor
       are:

       LXC (posix scheduler) : cpu_shares, vcpu_period, vcpu_quota

       QEMU/KVM  (posix  scheduler):  cpu_shares,  vcpu_period,  vcpu_quota,   emulator_period,   emulator_quota,
       global_period, global_quota, iothread_period, iothread_quota

       Xen (credit scheduler): weight, cap

2. Check the domain schedinfo 

# virsh schedinfo rhel8

Scheduler      : posix
cpu_shares     : 1024
vcpu_period    : 100000
vcpu_quota     : -1
emulator_period: 100000
emulator_quota : -1
global_period  : 100000
global_quota   : -1
iothread_period: 100000
iothread_quota : -1

Comment 14 errata-xmlrpc 2021-05-25 06:41:16 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 (virt:av 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/RHBA-2021:2098