Start of hostinfo daemon / play with APR.
[virt-hostinfo.git] / README
1 virt-hostinfo
2 Copyright (C) 2009 Red Hat Inc.
3 ----------------------------------------------------------------------
4
5 This is a project designed to allow controlled access to host
6 information from virtual machines.  It is proposed as a new feature
7 for Fedora 12, and you can read more about it on this web page:
8
9 http://fedoraproject.org/wiki/Features/Hostinfo
10
11
12 Requirements
13 ----------------------------------------------------------------------
14
15 - APR (Apache Portable Runtime) 1.3
16
17
18 Build
19 ----------------------------------------------------------------------
20
21 On the host:
22
23   ./configure
24   make
25   sudo make install
26
27 There is nothing to build or install in the guest.
28
29
30 Host configuration
31 ----------------------------------------------------------------------
32
33 You can edit the text configuration files under /etc/hostinfod by
34 hand.  Please read the hostinfod(8) manual page.
35
36 For graphical configuration, use virt-manager.
37
38 To create new guests with access to host information, use
39 virt-install.
40
41
42 Accessing host information from guests
43 ----------------------------------------------------------------------
44
45 No special software is required inside the guest.  Simply connect to
46 the serial port[1] (eg. /dev/ttyS1 or COM2) using your favorite serial
47 terminal software and send commands.
48
49 The protocol is a simple, line-based, text protocol.  No special
50 libraries are needed to use it from programs or by hand.  The commands
51 that you can send are documented in the hostinfod(8) manual page.
52
53 If you get no response on the serial port at all, check on the host
54 side that the guest is allowed access (see /etc/hostinfod/).  Also
55 check that the serial port has been set up in libvirt:
56
57   virsh dumpxml DOMAIN
58
59 (should show a <serial/> clause)
60
61 Also check that hostinfod (the daemon) is running on the host.
62
63 Note that serial port settings like speed, parity etc. make no
64 difference for these emulated serial ports, so that won't be a factor.
65
66 If you get an answer from the hostinfo daemon, but it indicates a
67 permissions error, check on the host side that the guest is allowed to
68 access the particular resource (see /etc/hostinfod/).
69
70 [1] _Which_ serial port can vary - you need to either try them one by
71 one or ask the host administrator to tell you.  We try to stay on the
72 second serial port (ttyS1 or COM2) but there are some configurations
73 where we get bumped up or down to other serial ports.