Showing posts with label gnome. Show all posts
Showing posts with label gnome. Show all posts

Monday, January 22, 2024

GNOME Boxes - Backup / Restore

Introduction

I finally started to play with GNOME Boxes in conjunction with getting a RedHat Enterprise Linux (RHEL) individual developer subscription. Immediately I was curious about what it would take to backup and restore a virtual machine (VM) for a host reload, or to move a VM from one host to another. This post details my experience with this process.

GNOME Boxes

GNOME Boxes is a Graphical User Interface (GUI) for managing VMs on a Linux host. It aims to simply the process of creating and running a VM. In my exploration I ran it on a Pop!_OS 22.04 host and a Fedora Workstation 39 host. It is installed by default on Fedora (assuming the default Fedora Workstation is what you are running) and it has to be manually installed on Pop!_OS.

Pop!_OS is where I started playing around with it. I installed it via the Pop!_Shop. There are two options, one to install the Ubuntu .deb package and the second to install it via Flatpak. I started with the .deb package.

Boxes gives you an opportunity to let it download an operating system (OS) image for you. Unfortunately, on Pop!_OS, RHEL was not one of the choices. So I simply downloaded the image myself. Later on I did notice on Fedora, and with the Flatpak install, RHEL was an option listed.

RHEL

RedHat provides a free RHEL subscription to individual developers. They allow up to 16 instances to be deployed with that subscription. I opted to use RHEL because I wanted to have an instance around for some personal development activities. The registration did not bother me as I welcomed the RedHat Developer weekly emails that I get. While not everything in them is relevant to me, I am finding a useful article here or there.

Backup

I had to do some searching to find out how to properly backup a VM image managed by Boxes. There isn't anything in the GUI that exports a VM and its metadata. But I found a couple of posts both detailing the same information.

Although I ran the backup on Pop!_OS, the instructions are the same on Fedora and should be the same on any other distribution. The variation will be with a Flatpak install which I cover later.

Metadata

To export the metadata for an image, you need its domain name. This does not appear to be available via Boxes. It can be retrieved via the 'virsh' command. This command is installed by default on Fedora but it needs to be installed on Pop!_OS via the 'libvirt-clients' package. To get the list of domain names, run:

virsh -c qemu:///session list --all

On my system, this was the output:

 Id   Name        State
----------------------------
 -    rhel9.3-2   shut off

In this case, 'rhel9.3-2' is my domain name. To export the metadata I ran:

virsh dumpxml rhel9.3-2 > rhel9.3-2.xml

I then copied the resulting XML to a USB stick for my backup.

Image

The image itself was easy to find. The images are all located here:

$HOME/.local/share/gnome-boxes/images

The filename of the image should match the domain name. On some posts it was stated there would be a file extension, but that was not the case for my image, it was simply called 'rhel9.3-2'. I copied this to my USB stick for a backup.

Restore

While I did the backup on Pop!_OS, I did the restore on Fedora. Again, this describes the process when using the distribution package rather than the Flatpak install. After performing these two steps, the VM showed up in Boxes for me and worked just fine.

Image

I simply copied my 'rhel9.3-2' image backup to:

$HOME/.local/share/gnome-boxes/images

Metadata

The metadata restore was also straightforward:

virsh define rhel9.3-2.xml

Flatpak Variations

A Flatpak is simply a distribution independent application package that runs on in a sandbox environment. Boxes is available as a Flatpak. After my initial backup / restore test with distribution native packages, I installed the Boxes Flatpak on Pop!_OS. There were just a couple of things I had to adjust in the process.

virsh

When running Boxes via Flatpak, the distribution native 'virsh' will not have access to your image metadata. You need to run 'virsh' from within the Flatpak sandbox for Boxes. You can enter a shell for that environment via this command:

flatpak --command=bash run org.gnome.Boxes

When doing so, since it is a sandbox you will not have access to your full host filesystem. Unless you restrict the permissions yourself, you will have access to your home fileystem and can run the 'virsh' commands from above and have read / write access to your home filesystem.

Image Location

Your VM images will still be stored in your home filesystem, but Flatpaks store their data in a different location. You will find your images here:

$HOME/.var/app/org.gnome.Boxes/data/gnome-boxes/images

XML

A backup / restore from a distribution native package to a distribution native package does not require any XML changes. A backup / restore from a Flatpak install to a Flatpak install does not require any XML changes. But if one system is using a distribution native package and the other is using Flatpak, the metadata XML will require two modifications before it can be restored. Please note that it was only two modifications for my use case, more advanced use cases may require additional changes.

Disk Image Location

The path to the VM image is in the XML. The difference between distribution native and Flatpak can be seen here:

<source file='/home/userid/.local/share/gnome-boxes/images/rhel9.3-2'/>

vs

<source file='/var/data/gnome-boxes/images/rhel9.3-2'/>
The path just needs to be updated for the desired target.

The reason the Flatpak image location looks different in the XML than the path I provided in the previous section is because the Flatpak sets up the sandbox environment with /var/data/gnome-boxes pointed to $HOME/.var/app/org.gnome.Boxes/data.

Emulator

The path to the hardware emulator is also in the XML. The difference between distribution native and Flatpak can be seen here:

<emulator>/usr/bin/qemu-system-x86_64</emulator>

vs

<emulator>/app/bin/qemu-system-x86_64</emulator>

Once again, the path just needs to be adjusted for the desired target.

Conclusion

While Boxes doesn't provide a direct way of backing up and restoring your VM images, it doesn't take much to do so. Beyond testing this process out I have yet to do anything useful with Boxes or RHEL, so I am not an expert by any means. But I hope this little bit of information will be useful.

 

Saturday, December 6, 2014

GNOME Orca on Slackware 14.1

On Slackware 14.1 I wanted to get Orca up and running without a full GNOME install just like I had in the past with 13.37. With the GNOME Slackbuilds project no longer active I took a different route.

From Slackbuilds.org I installed the following packages because I am going to be using espeak as my speech synthesizer:
I got everything else from the dropline GNOME project. I am only installing selected packages from their 3.10 packages just to get Orca running, but you could simply use their installer to install the full GNOME desktop for an overall better accessibility experience on the desktop.

Download and install/upgrade the following packages from their 3.10 site:
  • at-spi2-atk-2.10.2-x86_64-1dl (use upgradepkg)
  • at-spi2-core-2.10.2-x86_64-1dl (use upgradepkg)
  • atk-2.10.0-x86_64-1dl (use upgradepkg)
  • dotconf-1.3-x86_64-1dl
  • glib2-2.38.2-x86_64-1dl (use upgradepkg)
  • gobject-introspection-1.38.0-x86_64-1dl (use upgradepkg)
  • orca-3.10.2-x86_64-1dl
  • py3gobject-3.10.2-x86_64-1dl
  • pyatspi-2.10.0-x86_64-1dl
  • pygobject3-3.10.2-x86_64-1dl (use upgradepkg)
  • python3-3.3.2-x86_64-1dl
There is one required package that I do not have in that list, speechd-0.8-x86_64-1dl.txz. It was built without espeak installed so it does not have espeak support. By default it has Festival support. If you use Festival, you should be fine with the downloaded package. Since I am using espeak, I needed to rebuild it.

How you rebuild speech-dispatcher is up to you. I was playing around with some alternate instructions I found before I just used the dropline packages. Since I still had Aiyumi's slackbuilds on my system I modified the speech-dispatcher slackbuild to install 0.8.1 and build it that way. Orca 3.10 requires speech-dispatcher 0.8 or greater which is why I had to change the version.

On a final note, Firefox on Slackware is built without accessibility support enabled. You either need to rebuild after modifying Patrick's slackbuild to enable it, or you just need to download it directly. I do the latter, but I us Ruario's latest-firefox script in order to repackage it as a Slackware package.

Monday, August 1, 2011

GNOME Orca on Slackware 13.37

I am trying to learn more about web accessibility. Since I am a Linux user, GNOME Orca with Firefox is the route to go (right now at least). The only problem with that for me is that I am a Slackware user right now and GNOME is not available out of the box on Slackware. Plus I do not really want a full GNOME install, I would prefer to just install Orca and the components needed by it.

Thankfully, the GNOME SlackBuild project makes this relatively easy to do. The first thing you want to do is to install slapt-get using their manual instructions. I am running Slackware 13.37 but I used the 13.1 64-bit package (I was having trouble getting this going with the work-in-progress that they had for Slackware  13.37). I did not have to worry about any of the configuration, it worked out of the box as is, however you still need to update it:

slapt-get --update
slapt-get --add-keys

Once that is done, you can install Orca itself via slapt-get:

slapt-get --install orca

This installed the following packages:


GConf-2.28.1-x86_64-1gsb
gnome-keyring-2.28.2-x86_64-1gsb
gnome-vfs-2.24.3-x86_64-1gsb
libgnomeui-2.24.3-x86_64-1gsb
at-spi-1.30.1-x86_64-1gsb
espeak-1.43.03-x86_64-1gsb
gail-1.22.3-x86_64-3gsb
gnome-mag-0.16.1-x86_64-1gsb
gnome-speech-0.4.25-x86_64-4gsb
libgail-gnome-1.20.3-x86_64-1gsb
ORBit2-2.14.18-x86_64-1gsb
gnome-mime-data-2.18.0-x86_64-3gsb
libbonobo-2.24.3-x86_64-1gsb
libbonoboui-2.24.3-x86_64-1gsb
libdaemon-0.14-x86_64-1gsb
libgnome-2.30.0-x86_64-1gsb
libgnomecanvas-2.30.1-x86_64-1gsb
libtasn1-2.7-x86_64-1gsb
portaudio-V19-x86_64-1gsb
pyorbit-2.24.0-x86_64-2gsb
speex-1.2rc1-x86_64-3gsb
avahi-0.6.27-x86_64-1gsb
orca-2.30.2-x86_64-1gsb


There is one more package that is needed that was not installed:

slapt-get --install gnome-python

Which will just install gnome-python-2.28.1-x86_64-1gsb. I did have to reboot after all of this to get Orca to run. There was probably something else that could be done but I took the quick and easy route for that part.

Next there is a gconf2 setting needed that I found on the Orca mailing list:

gconftool-2 --set /desktop/gnome/interface/accessibility --type boolean true

Once that is set you should be able to run Orca from a terminal to go through its setup. After that Orca should run just fine if you are running KDE (as I am) due to the dbus dependency. But you can just run Orca with dbus-launch if you are running something like Fluxbox (I am currently testing it in Fluxbox as I type this).

There is one final issue. Orca is relatively useless without applications that provide it the necessary information. Firefox normally would do this but Pat's SlackBuild script configures it with the --disable-accessibility option. So you either need to alter the SlackBuild script to enable accessibility and rebuild the package or just download Firefox from its site (this is what I did as I didn't want to wait for the build) and you will be set.

I don't have much experience at all with using screen readers so I cannot comment on how well Orca works compared to others, but it is reading Firefox for me and should be good enough to validate accessibility techniques for me.

On a side note, I did try Orca on a couple of other distros just in case I wanted to switch for this reason or at least dual boot. I was happy that I got it working on Slackware though. But Orca Ubuntu 11.04 worked great out of the box for me in both fallback and Unity (once again, I don't have experience with screen readers so my assessment may not reflect reality for someone that has to depend on this technology). It worked relatively well on Fedora 15 as well with Gnome 3 but I did have to set the gconf setting manually there.

So I consider this a success for my purposes (a sighted developer looking to learn more about accessibility).