External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-25 23:25:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
6df8455aac
libvirt/docs/kbase/index.rst

64 lines
2.0 KiB
ReStructuredText
Raw Normal View History

docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
==============
Knowledge base
==============
docs: kbase: Split articles into sections Split the existing list of kbase articles into a 'Usage' category and into 'Internals/Debugging'. This will later represent the two columns on the web page. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 14:51:17 +00:00
Usage
-----
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Remove extra container from index page The container was used to apply CSS classes to the content, so the looks are degraded. The idea is to have a similar layout to the 'docs.html' page with multiple columns, which will be added later. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 14:37:46 +00:00
`Secure usage <secureusage.html>`__
Secure usage of the libvirt APIs
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Reorder some articles in the 'Usage' section Historically we've added them in chronological order, but certain articles are more likely to be needed and thus are easier to find when placed earlier. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 16:31:57 +00:00
`Backing chain management <backing_chains.html>`__
Explanation of how disk backing chain specification impacts libvirt's
behaviour and basic troubleshooting steps of disk problems.
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Reorder some articles in the 'Usage' section Historically we've added them in chronological order, but certain articles are more likely to be needed and thus are easier to find when placed earlier. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 16:31:57 +00:00
`Virtio-FS <virtiofs.html>`__
Share a filesystem between the guest and the host
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Reorder some articles in the 'Usage' section Historically we've added them in chronological order, but certain articles are more likely to be needed and thus are easier to find when placed earlier. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 16:31:57 +00:00
`Security with QEMU passthrough <qemu-passthrough-security.html>`__
Examination of the security protections used for QEMU and how they need
configuring to allow use of QEMU passthrough with host files/devices.
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Remove extra container from index page The container was used to apply CSS classes to the content, so the looks are degraded. The idea is to have a similar layout to the 'docs.html' page with multiple columns, which will be added later. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 14:37:46 +00:00
`RPM deployment <rpm-deployment.html>`__
Explanation of the different RPM packages and illustration of which to
pick for installation
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Reorder some articles in the 'Usage' section Historically we've added them in chronological order, but certain articles are more likely to be needed and thus are easier to find when placed earlier. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 16:31:57 +00:00
`Domain state capture <domainstatecapture.html>`__
Comparison between different methods of capturing domain state
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Reorder some articles in the 'Usage' section Historically we've added them in chronological order, but certain articles are more likely to be needed and thus are easier to find when placed earlier. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 16:31:57 +00:00
`Disk locking <locking.html>`__
Ensuring exclusive guest access to disks with
`virtlockd <locking-lockd.html>`__ or
`Sanlock <locking-sanlock.html>`__
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Reorder some articles in the 'Usage' section Historically we've added them in chronological order, but certain articles are more likely to be needed and thus are easier to find when placed earlier. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 16:31:57 +00:00
`Protected virtualization on s390 <s390_protected_virt.html>`__
Running secure s390 guests with IBM Secure Execution
`Launch security <launch_security_sev.html>`__
Securely launching VMs with AMD SEV
kbase: Add knowledge base for libvirt systemtap Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Han Han <hhan@redhat.com>
2020-08-06 06:34:02 +00:00
docs: kbase: Remove extra container from index page The container was used to apply CSS classes to the content, so the looks are degraded. The idea is to have a similar layout to the 'docs.html' page with multiple columns, which will be added later. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 14:37:46 +00:00
`KVM real time <kvm-realtime.html>`__
Run real time workloads in guests on a KVM hypervisor
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: link to PCI docs from the kbase page While the PCI docs are linked from formatdomain.html, finding those links is not straightforward. It is good for users to highlight them in the kbase pages. The PCI docs are intentionally not moved to the kbase/ sub-directory in order to avoid breaking hyperlinks. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2021-01-22 15:23:33 +00:00
`PCI hotplug <../pci-hotplug.html>`__
Effective usage of PCI hotplug
`PCI topology <../pci-addresses.html>`__
Addressing schemes for PCI devices
docs: kbase: Split articles into sections Split the existing list of kbase articles into a 'Usage' category and into 'Internals/Debugging'. This will later represent the two columns on the web page. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 14:51:17 +00:00
Internals / Debugging
---------------------
`Debug logs <debuglogs.html>`__
Configuration of logging and tips on how to file a good bug report.
`Systemtap <systemtap.html>`__
Explanation of how to use systemtap for libvirt tracing.
docs: kbase: Remove extra container from index page The container was used to apply CSS classes to the content, so the looks are degraded. The idea is to have a similar layout to the 'docs.html' page with multiple columns, which will be added later. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 14:37:46 +00:00
`Incremental backup internals <incrementalbackupinternals.html>`__
Incremental backup implementation details relevant for users
docs: kbase: Convert 'kbase' article registry to RST Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-07-30 09:32:14 +00:00
docs: kbase: Remove extra container from index page The container was used to apply CSS classes to the content, so the looks are degraded. The idea is to have a similar layout to the 'docs.html' page with multiple columns, which will be added later. Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2020-11-04 14:37:46 +00:00
`VM migration internals <migrationinternals.html>`__
VM migration implementation details, complementing the info in
`migration <migration.html>`__
Reference in New Issue Copy Permalink