Added COPYING and README files.
[virt-mem.git] / README
1 virt-mem tools
2 Copyright (C) 2008 Red Hat Inc.
3 ----------------------------------------------------------------------
4
5 These are a collection of monitoring and management tools for virtual
6 machines.
7
8 Commands we support at the moment include:
9
10   virt-uname      'uname' command, shows OS version, architecture, etc.
11   virt-dmesg      'dmesg' command, shows kernel messages
12   virt-ps         'ps' command, shows process list
13
14 The general idea is that they allow you to monitor virtual machines
15 without needing to log in to the machine itself or install any extra
16 software inside the virtual machine.  At the moment we only support
17 virtual machines running Linux kernel >= 2.6, but we expect to support
18 other operating systems in the future.
19
20 Most of the commands also offer a CSV (comma-separated values) output
21 format ('virt-xx --csv'), allowing usage from scripts to update
22 spreadsheets, databases or integrate with existing monitoring systems
23 like Nagios.
24
25 The commands use libvirt to access the underlying virtualization
26 system, so we support a variety of different systems such as Xen, QEMU
27 and KVM, and more can be added just by adding support to libvirt.
28
29
30 Website
31 ----------------------------------------------------------------------
32
33 http://et.redhat.com/~rjones/virt-mem/
34
35 We supply the latest source and binaries at the above site.
36
37
38 Building from source
39 ----------------------------------------------------------------------
40
41 Run ./configure and look at the output for any missing packages.
42
43 Then:
44
45   make
46   make -C po     # if you want to rebuild the locales
47
48 The binaries are called things like 'virt-dmesg.opt' and located in
49 the respective directories, so you could run them by doing:
50
51   dmesg/virt-dmesg.opt
52
53 All the binaries understand the --help option to provide a summary of
54 options.  All require virtual machines to run against, but most also
55 offer a test mode (-t option).
56
57 To install the binaries, man pages and locales, do this as root:
58
59   make install
60   make -C po install