summarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevdog2019-11-20 10:47:49 -0600
committerKevdog2019-11-20 10:47:49 -0600
commitc3acd3246b875940ae4a7270033f552bd7b1e2c8 (patch)
tree90c5ec3ca7f8fccb0069534dffb1710ba6288ce8
parentc6f9b082cbf46e397b73cea0903eaa5c2dfdfa1b (diff)
downloadaur-c3acd3246b875940ae4a7270033f552bd7b1e2c8.tar.gz
Modified README file
-rw-r--r--README.md43
1 files changed, 42 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2dc177022bd..f6cc4986f60 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,43 @@
# xe-guest-utilities-git
-Xe Guest Utilities for Arch
+
+###Purpose
+xe-guest-utilities is an add-on package for the [Xen](https://xenproject.org/developers/teams/xen-hypervisor/) and [xcp-ng](https://xcp-ng.org/) hypervisors. As per [documentation](https://xenproject.org/developers/teams/xen-hypervisor/) these tools:
+ - Report extra VM info (that only the Operating system can know, not your underlying hypervisor), like VM IP address, kernel version etc.
+ - Communicate with the OS in case of quiesce snapshots (Windows and its VSS)
+ - Allow sending signals to the OS (clean reboot, hotplug hardware etc.)
+This package provides a service file which can be activated/enabled by systemd to provide these features to your VM running with Xen/xcp-ng.
+
+###Source Code
+xe-guest-utilities pulls its sourcecode from the [Xenserver](https://github.com/xenserver/xe-guest-utilities) github repository. The source code requires a [Go development environment](https://golang.org/doc/install) in order to successfully compile the code. This script should automatically download the go-pie package, compile and install the script.
+
+###Installation
+The following files are installed by the package: (Listed here in case manual removal is necessary)
+ - /usr/share/licenses/xe-guest-utilities-git/LICENSE
+ - /usr/share/oem/xs/xe-daemon
+ - /usr/share/oem/xs/xe-linux-distribution
+ - /usr/lib/udev/rules.d/10-xen-vcpu-hotplug.rules
+ - /usr/lib/systemd/system/xe-guest-utilities.service
+ - /usr/bin/xenstore
+ - /usr/bin/xenstore-exists
+ - /usr/bin/xenstore-read
+ - /usr/bin/xenstore-rm
+ - /usr/bin/xenstore-write
+
+
+###Activation
+Once xe-guest-utilities-git is installed, the service can be started (as root):
+```
+systemctl start xe-guest-utilities.service
+```
+
+The service can be enabled so it will start on subsequent boots:
+```
+systemctl enable xe-guest-utilities.service
+```
+
+References:
+1. https://github.com/xcp-ng/xcp/wiki/Guest-Tools
+2. https://github.com/xcp-ng/xe-guest-utilities
+3. https://xen-orchestra.com/blog/install-xenserver-tools-in-your-vm/
+4. Older version of utilities: https://aur.archlinux.org/packages/xe-guest-utilities/
+