Bug 1313613
| Summary: | Need documentation for blkiotune options in libvirt.org | ||
|---|---|---|---|
| Product: | [Community] Virtualization Tools | Reporter: | Pei Zhang <pzhang> |
| Component: | libvirt | Assignee: | Libvirt Maintainers <libvirt-maint> |
| Status: | CLOSED UPSTREAM | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | unspecified | CC: | crobinso, dyuan, jsuchane, mzhan, rbalakri, xuzhang |
| Target Milestone: | --- | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-04-14 17:30:24 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: | |
| Embargoed: | |||
formatdomain.html is primarily upstream documentation. Patch sent upstream: http://www.redhat.com/archives/libvir-list/2016-April/msg00767.html commit fd52de12c0088cbd41011c1e4473bcb680b0ff36
Author: Cole Robinson <crobinso>
Date: Wed Apr 13 16:37:17 2016 -0400
docs: domain: document blkiotune {read, write}_{bytes, iops}_sec
Added with commit 3b431929 in v1.2.2 but never documented
https://bugzilla.redhat.com/show_bug.cgi?id=1313613
|
Description of problem: Options description for blkiotune are missing in libvirt.org Version-Release number of selected component (if applicable): libvirt-1.3.1-2.el7.x86_64 How reproducible: 100% Steps to Reproduce: 1. open libvirt doc for <blkiotune>, it only has explanation for <weight> and <device> file:///usr/share/doc/libvirt-docs-1.3.2/html/formatdomain.html#elementsBlockTuning 2. check man page and virsh help # virsh help blkiotune ...... --device-weights <string> per-device IO Weights, in the form of /path/to/device,weight,... --device-read-iops-sec <string> per-device read I/O limit per second, in the form of /path/to/device,read_iops_sec,... --device-write-iops-sec <string> per-device write I/O limit per second, in the form of /path/to/device,write_iops_sec,... --device-read-bytes-sec <string> per-device bytes read per second, in the form of /path/to/device,read_bytes_sec,... --device-write-bytes-sec <string> per-device bytes wrote per second, in the form of /path/to/device,write_bytes_sec,... ...... 3.xml in domain # virsh blkiotune r72 weight : 888 device_weight : device_read_iops_sec: /dev/sdc,1024000 device_write_iops_sec: device_read_bytes_sec: /dev/sdc,102400 device_write_bytes_sec: # virsh dumpxml r72|grep blkiotune -A 6 <blkiotune> <weight>888</weight> <device> <path>/dev/sdc</path> <read_iops_sec>1024000</read_iops_sec> <read_bytes_sec>102400</read_bytes_sec> </device> ...... Actual results: As step 1, missing explanations for other four options in device Expected results: Update doc. Additional info: Refer iotune in <disk>, it has all options explanations.