Skip to content

Commit

Permalink
Updating docs (kevoreilly#2241)
Browse files Browse the repository at this point in the history
* Updating .gitignore to ignore docs' _build

* Updating docs on virtmanager snapshot handling

* Updating docs
  • Loading branch information
RazviOverflow authored Jul 20, 2024
1 parent 303bdcc commit a0203ae
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ tests/test_bson.bson.compressed

installer/cape-config.sh
installer/kvm-config.sh

docs/book/src/_build
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/book/src/installation/guest/agent.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ agent not being able to work as intended.
Windows 10+
===========

.. note:: Using the shceduler as documented below is not **strictly necessary**. There are several ways to achieve execution of the analyzer for a given snapshot. For example, you could run the analyzer (let us call it ``pizza.pyw``) and create a snapshot with it already running. That would be more than enough.

To start the script at boot, you will need to set the agent to be run
as a scheduler task. Dropping it in
``C:\ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp`` will
Expand Down
17 changes: 17 additions & 0 deletions docs/book/src/installation/guest/saving.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,23 @@ After snapshotting the guest, you can shut it down.

$ virsh snapshot-delete "<VM-Name>" "<Snapshot-Name>""

Snapshot with Virtual Manager (``virt-manager``)
------------------------------------------------

If you are using virtual manager (``virt-manager``) to manage you VMs (as mentioned in the :ref:`installation_kvm` chapter), you can also use it to create the snapshots.

.. warning:: Virtual manager allows you to create either internal or external snapshots (which you can read more about `here <https://wiki.libvirt.org/I_created_an_external_snapshot_but_libvirt_will_not_let_me_delete_or_revert_to_it.html#background>`_). The arguably easier mode of operation are internal snapshots, given that external ones use individual files that may mess up your whole libvirt - qemu - kvm installation in case of name/path modification or loss.

When creating a new snapshot, in newer versions of KVM you can select whether you want an internal or external or one:

.. image:: ../../_images/screenshots/create_kvm_snapshot.png
:align: center

When any given snapshot is external, it's label will be suffixed with "*(External)*".

.. image:: ../../_images/screenshots/internal_external_snapshot.png
:align: center

VirtualBox
==========

Expand Down
2 changes: 2 additions & 0 deletions docs/book/src/installation/host/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Automated installation, read the full page before you start
We have automated all work for you, but bear in mind, that 3rd party dependencies change frequently and can break the installation,
so please check the installation log and try to provide the fix / correct issue to the developers.

.. _installation_kvm:

To install KVM
==============

Expand Down

0 comments on commit a0203ae

Please sign in to comment.