Point virtio-win docs at project README

The virtio-win docs are out of date, and soon to be even more so with
coming upstream changes to the yum repo. Upstream devs would like to
move the docs closer to the upstream project infrastructure.

Delete most of the content and point at the upstream packaging README.md

https://pagure.io/fedora-docs/quick-docs/issue/327

Signed-off-by: Cole Robinson <crobinso@redhat.com>
This commit is contained in:
Cole Robinson 2021-01-25 09:54:25 -05:00 committed by pbokoc
parent faab1a6e21
commit 0eb5c5836a
7 changed files with 2 additions and 140 deletions

View file

@ -1,17 +0,0 @@
[[fedora-virtio-drivers-vs-rhel]]
= Fedora VirtIO Drivers vs. RHEL VirtIO Drivers
The RPMs in the *virtio-win-stable* repository are the same driver builds as what is shipped with Red Hat Enterprise Linux. All the Windows binaries are from builds done on Red Hat's internal build system, which are generated using publicly available code. For more details about how the RPM and repo are built, see the https://github.com/crobinso/virtio-win-pkg-scripts[README for this repo].
The drivers are cryptographically signed with Red Hat's vendor signature. However they are not signed with Microsoft's https://docs.microsoft.com/en-us/windows-hardware/drivers/install/whql-release-signature[WHQL signature].
WARNING: Due to the https://docs.microsoft.com/en-us/windows-hardware/drivers/install/kernel-mode-code-signing-policy\--windows-vista-and-later-#signing-requirements-by-version[signing requirements of the Windows Driver Signing Policy], drivers which are not signed by Microsoft will not be loaded by some versions of Windows when https://docs.microsoft.com/en-us/windows-hardware/design/device-experiences/oem-secure-boot[Secure Boot] is enabled in the virtual machine. See https://bugzilla.redhat.com/1844726[bug #1844726].
NOTE: Historically the .iso files shipped on alt.fedoraproject.org did _not_ match the layout of the .iso shipped with Red Hat Enterprise Linux. This changed in April 2015.
The current Fedora RPM/ISO directory structure is laid out to mirror exactly the layout that is shipped with the latest release of Red Hat Enterprise Linux. This is so that users and developers don't seen any differences between the two distros.
* The `.iso` directories are named after the driver code directories from the upstream driver git tree.
* Below the driver directories, the `$winversion/$arch/` directory naming
is a Windows convention.
* The RPM layout is arbitrary in that it ships the `.vfd` content in the `drivers/` dir, but not many of the other drivers from the `.iso`. This seems to be an historical oversight and should probably be fixed.

View file

@ -1,10 +0,0 @@
[[virtio-win-repo-overview]]
= VirtIO-Win Repo Overview
There is a yum|dnf repo available via the RPM package manager (RPM) that ships virtio-win packages. You can use these RPMs to install driver binaries and agent installers into the `/usr/share` directory on your host machine. You can then share the bits with Windows VMs running on the host.
The .repo file provides two different repositories:
* *virtio-win-stable* - This repository provides builds of virtio-win that roughly correlate to what was shipped with the most recent Red Hat Enterprise Linux release, meaning these builds have undergone testing and are considered stable. This repo is enabled by default.
* *virtio-win-latest* - This repository provides the latest driver builds. The builds may be bug free, development quality, or completely broken. https://en.wikipedia.org/wiki/Caveat_emptor[Caveat emptor]. This repo is disabled by default.

View file

@ -1,10 +0,0 @@
[[enabling-latest-virtio-win-repo]]
= Enabling the latest Windows VirtIO Repository
By default, the *virtio-win-latest* repository is disabled and *virtio-win-stable* repo is enabled.
To enable the *virtio-win-latest* repo with DNF:
----
# dnf --enablerepo=virtio-win-latest upgrade virtio-win
----

View file

@ -1,16 +0,0 @@
[[filing-virtio-win-bugs]]
= Filing Windows VirtIO Bugs
Please file any bug reports in Bugzilla against https://bugzilla.redhat.com/enter_bug.cgi?product=Virtualization%20Tools&component=virtio-win[Product=Virtualization Tools Component=virtio-win].
When filing a bug, please provide the following information:
* The virtio-win version
* The host distro
* The qemu version
** If using libvirt: `sudo virsh dumpxml $vmname`
* The qemu command log
** If using libvirt this can be found at `/var/log/libvirt/qemu/$vmname.log`
Questions/Comments about the RPMs or the yum|dnf repos should be sent to the regular Fedora virt https://fedoraproject.org/wiki/Virtualization#Mailing_list_and_IRC[mailing list and IRC] channels.
Questions/Comments about the actual drivers are best send to the upstream https://lists.nongnu.org/mailman/listinfo/qemu-devel[qemu-devel] or http://www.linux-kvm.org/page/Lists,_IRC[kvm] mailing lists.

View file

@ -1,15 +0,0 @@
[[installing-virtio-win-repo]]
= Installing the Windows VirtIO Repository
Install the repo file using the following command:
----
# wget https://fedorapeople.org/groups/virt/virtio-win/virtio-win.repo \
-O /etc/yum.repos.d/virtio-win.repo
----
Then install the _virtio-win_ package:
----
# dnf install virtio-win
----

View file

@ -1,44 +0,0 @@
[[virtio-win-rpm-contents]]
= RPM contents
The virtio-win RPM package contains the following files:
* `/usr/share/virtio-win/*.iso` - ISO CDROM containing all the drivers.
* `/usr/share/virtio-win/*.vfd` - VFD floppy images for using during install of Windows XP
* `/usr/share/virtio-win/drivers` - Copy of the extracted VFD driver contents
* `/usr/share/virtio-win/guest-agent/*.msi` - QEMU Guest Agent 32bit and 64bit MSI installers
[[virtio-win-iso-contents]]
== ISO contents
ISO is used to install paravirtual drivers in Windows guests. The `virtio-win/*.iso` included in the RPM contains the following bits:
* `NetKVM/` - Virtio network driver
* `viostor/` - Virtio block driver
* `vioscsi/` - Virtio Small Computer System Interface (SCSI) driver
* `viorng/` - Virtio RNG driver
* `vioser/` - Virtio serial driver
* `Balloon/` - Virtio memory balloon driver
* `qxl/` - QXL graphics driver for Windows 7 and earlier. (build virtio-win-0.1.103-1 and later)
* `qxldod/` - QXL graphics driver for Windows 8 and later. (build virtio-win-0.1.103-2 and later)
* `pvpanic/` - https://github.com/qemu/qemu/blob/master/docs/specs/pvpanic.txt[QEMU pvpanic] device driver (build virtio-win-0.1.103-2 and later)
* `guest-agent/` - QEMU Guest Agent 32bit and 64bit MSI installers
* `qemupciserial/` - https://github.com/qemu/qemu/blob/master/docs/qemupciserial.inf[QEMU PCI serial] device driver
* `*.vfd` VFD floppy images for using during install of Windows XP
NOTE: If you previously used isos from alt.fedoraproject.org, note that the current isos have a different file layout that matches the layout of the Red Hat Enterprise Linux isos. If you need old isos for backwards compatiblity you can find them on the https://fedorapeople.org/groups/virt/virtio-win/deprecated-isos/[deprecated isos page].
[[virtio-win-direct-downloads]]
== Direct downloads
Direct downloads are available for the `.iso`, `.vfd`, and qemu-ga installers.
* Stable https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win.iso[virtio-win iso]
* Stable https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win_x86.vfd[virtio-win x86 floppy]
* Stable https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win_amd64.vfd[virtio-win amd64 floppy]
* Latest https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/latest-virtio/virtio-win.iso[virtio-win iso]
* Latest https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/latest-virtio/virtio-win_x86.vfd[virtio-win x86 floppy]
* Latest https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/latest-virtio/virtio-win_amd64.vfd[virtio-win amd64 floppy]
* Latest https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/latest-qemu-ga/[qemu-ga files]
* https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/[Full archive]
* https://fedorapeople.org/groups/virt/virtio-win/CHANGELOG[Changelog]

View file

@ -3,37 +3,11 @@ ifdef::context[:parent-context: {context}]
[id='creating-windows-virtual-machines-using-virtio-drivers']
= Creating Windows virtual machines using virtIO drivers
include::{partialsdir}/unreviewed-message.adoc[]
This document describes how to obtain virtIO drivers and additional software agents for Windows virtual machines running on kernel-based virtual machines (KVM). https://www.linux-kvm.org/page/Virtio[virtIO] is a virtualization standard for network and disk device drivers.
Fedora infrastructure hosts virtIO drivers and additional software agents for Windows virtual machines running on kernel-based virtual machines (KVM). https://www.linux-kvm.org/page/Virtio[virtIO] is a virtualization standard for network and disk device drivers.
Fedora cannot ship Windows virtIO drivers because they cannot be built automatically as part of Fedoras build system: the only way to build Windows virtIO drivers is on a machine running Windows. In addition, shipping pre-compiled sources is generally against Fedora policies. Microsoft does not provide virtIO drivers, you must download them yourself in order to make virtIO drivers available for Windows VMs running on Fedora hosts.
The drivers in these repos are licensed under the https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html[GPLv2] license.
For details on downloading the drivers, please see: https://github.com/virtio-win/virtio-win-pkg-scripts/blob/master/README.md
include::{partialsdir}/concept_virtio-win-repo-overview.adoc[leveloffset=+1]
include::{partialsdir}/concept_fedora-virtio-drivers-vs-rhel.adoc[leveloffset=+1]
include::{partialsdir}/proc_installing-virtio-win-repo.adoc[leveloffset=+1]
include::{partialsdir}/proc_enabling-latest-virtio-win-repo.adoc[leveloffset=+1]
include::{partialsdir}/ref_virtio-win-rpm-contents.adoc[leveloffset=+1]
include::{partialsdir}/proc_filing-virtio-win-bugs.adoc[leveloffset=+1]
[discrete]
== Additional resources
* KVM windows guest drivers upstream code: https://github.com/virtio-win/kvm-guest-drivers-windows
* QXL XDDM driver code: http://cgit.freedesktop.org/spice/win32/qxl
* QXL WDDM driver code: https://github.com/vrozenfe/qxl-dod
* Tree used by gnome-boxes for automatic driver installation: https://zeenix.fedorapeople.org/drivers/
* Windows spice agent git repo: http://cgit.freedesktop.org/spice/win32/vd_agent
* Spice guest tools installer code: http://cgit.freedesktop.org/~teuf/spice-nsis/
* spice-guest-tools downloads: http://www.spice-space.org/download/binaries/spice-guest-tools/
* Fedora virtio-win build scripts: https://github.com/crobinso/virtio-win-pkg-scripts
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]