Hostinfo day 1: Mainly documentation.
[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 - C compiler
16
17 - APR (Apache Portable Runtime) 1.3
18
19 - Perl
20
21 - pod2man and other perldoc tools
22   * these are usually supplied with Perl
23
24 - libvirt
25
26 - Perl module Sys::Virt
27
28
29
30 Build
31 ----------------------------------------------------------------------
32
33 On the host:
34
35   ./configure
36   make
37   sudo make install
38
39 There is nothing to build or install in the guest.
40
41
42 Host configuration
43 ----------------------------------------------------------------------
44
45 You can edit the text configuration files under /etc/hostinfod by
46 hand.  Please read the hostinfo(8) manual page.
47
48 For graphical configuration, use virt-manager.
49
50 To create new guests with access to host information, use
51 virt-install.
52
53
54 Accessing host information from guests
55 ----------------------------------------------------------------------
56
57 No special software is required inside the guest.  Simply connect to
58 the serial port[1] (eg. /dev/ttyS1 or COM2) using your favorite serial
59 terminal software and send commands.
60
61 The protocol is a simple, line-based, text protocol.  No special
62 libraries are needed to use it from programs or by hand.  The commands
63 that you can send are documented in the hostinfod(8) manual page.
64
65 If you get no response on the serial port at all, check on the host
66 side that the guest is allowed access (see /etc/hostinfod/).  Also
67 check that the serial port has been set up in libvirt:
68
69   virsh dumpxml DOMAIN
70
71 (should show a <serial/> clause)
72
73 Also check that hostinfod (the daemon) is running on the host.
74
75 Note that serial port settings like speed, parity etc. make no
76 difference for these emulated serial ports, so that won't be a factor.
77
78 If you get an answer from the hostinfo daemon, but it indicates a
79 permissions error, check on the host side that the guest is allowed to
80 access the particular resource (see /etc/hostinfod/).
81
82 [1] _Which_ serial port can vary - you need to either try them one by
83 one or ask the host administrator to tell you.  We try to stay on the
84 second serial port (ttyS1 or COM2) but there are some configurations
85 where we get bumped up or down to other serial ports.