Commit Graph
41 Commits
Author SHA1 Message Date
Keir Fraser 41af6f38d9 xend: Make hotplug script timeouts configurable
In some configurations, when dom0 is busy with I/O, it may take
several minutes to complete all hotplug scripts required when a new
domain is being created. As device create timeout is set to 100
seconds, users get "hotplug scripts not working" error instead of a
new domain.

This patch makes both DEVICE_CREATE_TIMEOUT and DEVICE_DESTROY_TIMEOUT
configurable in xend-config.sxp to allow users to easily adapt hotplug
timeouts to their environment.

Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
2009-05-19 02:18:48 +01:00
Keir Fraser 2450e3575f docs: Add detach console note to xm man page
I've been asked too many times about a hint in xm man page on how to
'detach' from a guest console - aka Ctrl+]

Signed-off-by: Jim Fehlig <jfehlig@novell.com>
2009-02-04 11:57:47 +00:00
Keir Fraser d2e81c31f8 xm docs: Added new,delete,dump-core,resume,suspend,uptime and fixed others
Signed-off-by: Bill Rieske <brieske@novell.com>
2008-09-24 10:17:18 +01:00
Keir Fraser e63b739dff Add 'coredump-destroy' and 'coredump-restart' actions for crashed domains.
Xen-API already specifies these actions for the 'on_crash' domain exit
event. This patch makes them available for use in traditional domU
config files and through the xm tool as well.

Signed-off-by: Jim Fehlig <jfehlig@novell.com>
2008-02-07 09:28:55 +00:00
Keir Fraser 2c7a4f62dc Clarify 'xm mem-set' and 'xm vcpu-set' requirements in documentation.
From: Richard W.M. Jones <rjones@redhat.com>
Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
2008-01-18 13:43:26 +00:00
Keir Fraser 653ceb13b7 Minor correction in xm man page for 'xm create'.
From: Richard W.M. Jones <rjones@redhat.com>
Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
2008-01-17 15:21:35 +00:00
Keir Fraser aac518b954 tools/docs: Fix example and default IP addresses.
In various places in documentation and code, IP addresses are provided
as examples, defaults, or dummy configuration.  In general the
specific IP addresses used in Xen are not always appropriate.  (For
example, 1.2.3.4 is used in a few places!)

The following addresses should be used:
 * For examples and documentation, 192.0.2.0/24.  (See RFC3330.)
 * For defaults for private networks, a random network from RFC1918.
   I have randomly selected 172.30.206.0/24 for this purpose and
   documented this in at the only registry I know of,
   www.ucam.org/cam-grin.  This network should henceforth be used for
   default configurations of local bridges, test networks, etc. in
   Xen tools.

The following addresses should NOT be used:
 * 10.0.*.*, 10.1.*.*, 192.168.0.*, 192.168.1.*, etc.  Using these
   addresses gives greatly increased likelihood of collision, as
   ignorant network administrators and reckless middlebox vendors
   often pick networks from the bottom of 10/8 and 192.168/16.
 * 169.254.*.*.  These are reserved for zeroconf (ad-hoc networking)
   and should not be used for Xen private networks, bridges, etc.,
   etc.  Use of these addresses by Xen scripts causes trouble on hosts
   (eg laptops) which find themselves in ad-hoc networking
   environments.  I think this is not hypothetical (!) since at least
   one Linux distribution have specific code to detect this case and
   cause Xen startup to fail iff the host already has an external
   zeroconf address.
 * 1.2.3.4.  WTF !?

I have also used 127.0.255.255 in one place where apparently a dummy
address is needed (some Linux kernels won't accept a lack of an NFS
server address).  If 127.0.255.255 is mistakenly used it is unlikely
to do any damage to real traffic even if it does escape into the
network at large.

Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
2008-01-17 15:13:40 +00:00
Keir Fraser 0ea4d2fb34 Implement legacy XML-RPC interface for ACM commands.
This patch implements a (non Xen-API) legacy XML-RPC interface for the
ACM commands and funnels the calls into code introduced by the Xen-API
support for ACM security management. Since some of the functionality
has changed, also the xm applications have changed. In particular the
following old commands have been removed along with some tools the
have become obsolete now:

- loadpolicy    (included in: setpolicy)
- makepolicy    (included in: setpolicy)
- cfgbootpolicy (included in: setpolicy)

and the following commands been introduced:

- setpolicy
- getpolicy
- resetpolicy

All tools have been adapted to work in Xen-API and legacy XML-RPC
mode. Both modes support the same functionality.

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2007-12-05 09:44:20 +00:00
Keir Fraser 07f557cb63 Replace sysctl.physinfo.sockets_per_node with more directly useful
sysctl.physinfo.nr_cpus. This also avoids miscalculation of
sockets_per_node by Xen where the number of CPUs in the system is
clipped.
From: Elizabeth Kon <eak@us.ibm.com>
Signed-off-by: Keir Fraser <keir@xensource.com>
2007-10-19 18:00:10 +01:00
kfraser@localhost.localdomain 3eb4247336 [MAN] Explanation of recent extensions to xm security subcommands
Signed-off-by: Stefan Berger <stefanb@usa.ibm.com>
2007-07-19 17:18:20 +01:00
kfraser@localhost.localdomain 49562f1285 docs: update xm man page
- Fixed description of "Mem" column in "xm list" output.
- Added a bit of text for the credit scheduler.
- Described the --force option to block-detach.
- Made formatting and spelling more consistent.
- etc...

Signed-off-by:  Charles Coffing <ccoffing@novell.com>
2007-07-06 14:45:02 +01:00
kfraser@localhost.localdomain e101034b6c Remove non-ASCII chars in man page.
Signed-off-by: Charles Coffing <ccoffing@novell.com>
2007-04-26 09:52:34 +01:00
kfraser@localhost.localdomain dce5dbf051 Simple fix to the man page for xm block-attach.
It currently says to use "ro" or "rw" for the mode, when it seems,
empirically, to take "r" or "w" for the mode, respectively.  Update
the man page to reflect that.

Signed-off-by: Chris Lalancette <clalance@redhat.com>
2007-03-10 16:59:57 +00:00
kfraser@localhost.localdomain edf5361fb2 Add scheduler name to 'xm info' output.
Signed-off-by: Masaki Kanno <kanno.masaki@jp.fujitsu.com>
2007-01-17 14:54:06 +00:00
kfraser@localhost.localdomain 671248b38b Document vfb configuration.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2007-01-17 14:03:12 +00:00
kfraser@localhost.localdomain a75c9af600 Use the name of the title of the system to boot into (instead of the
kernel version) to determine where to make the entry into the grub
configuration file.

Signed-off-by: Reiner Sailer <sailer@us.ibm.com>
Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2006-10-20 09:32:16 +01:00
Emmanuel Ackaouy 7ccdaed2ed Adds support for the keyword 'all' to the vcpu-pin operation.
Using 'all' in place of a specific vcpu will apply the cpumask
to all vcpus in the domain.
Signed-off-by: Ryan Harper <ryanh@us.ibm.com>
2006-09-26 12:17:51 +01:00
Ewan Mellor 9ad71b6de8 This patch intends for updating "man xm" about xm info description.
For example item:system is removed from xm info.

Signed-off-by: shaocyou <shaocyou@jp.fujitsu.com>
2006-09-05 16:48:21 +01:00
kaf24@localhost.localdomain b643712258 [XEND] Move all of the various log files created by xen to
be under /var/log/xen instead of under /var/log directly.  This has
the advantage of cleaning things up a little and also can make it
easier to restrict the permissions needed by xend.

Signed-off-by: Jeremy Katz <katzj@redhat.com>
2006-08-28 13:05:00 +01:00
kfraser@localhost.localdomain db51cd09d3 Remove all traces of the obsolete BVT scheduler.
Signed-off-by: Keir Fraser <keir@xensource.com>
2006-08-23 17:14:38 +01:00
emellor@leeni.uk.xensource.com bc6220c199 This patch adds new xm subcommands to support working with resource
labels.  The new subcommands are 'xm resources', 'xm rmlabel', 'xm
getlabel' and 'xm dry-run'.  In addition, the 'xm addlabel' subcommand
now uses an updated syntax to support labeling both domains and
resources.  See the xm man page for details on each subcommand.

Beyond the new subcommands, this patch allows users to immediately see
when security checks will fail by pushing some basic security checking
into the beginning of 'xm create' and 'xm block-attach'.  ACM security
attributes for block devices are added to XenStore in order to support
the final security enforcement, which will be performed in the kernel
and included in a separate patch.

Signed-off-by: Bryan D. Payne <bdpayne@us.ibm.com>
Signed-off-by: Reiner Sailer <sailer@us.ibm.com>
2006-06-28 16:05:27 +01:00
kaf24@firebug.cl.cam.ac.uk c60d2bbfac Fix spelling errors in man pages.
Signed-off-by: Charles Coffing <ccoffing@novell.com>
2006-05-15 07:51:07 +01:00
smh22@firebug.cl.cam.ac.uk 655ead6573 This patch updates the documentation and extends the 'xm' man page with
the integrated access control management commands. The man page is a 
good place to start exploring these commands.

Signed-off by: Reiner Sailer <sailer@us.ibm.com>
2006-04-24 10:59:57 +01:00
emellor@leeni.uk.xensource.com eb0cb70c38 This patch adds an entry to the xend-config.sxp man page about the
external device migration entry.

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2006-04-21 11:58:25 +01:00
kaf24@firebug.cl.cam.ac.uk 840ac8df5a Changed deprecated "set-vcpus" to "vcpu-set" in the xm man page.
Signed-off-by:  Charles Coffing <ccoffing@novell.com>
2006-04-01 10:50:58 +01:00
emellor@leeni.uk.xensource.com dd3606b160 Attached patch updates the xm man page for the listing of
block/network/vtpm devices.

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2006-02-17 23:00:05 +01:00
maf46@burn.cl.cam.ac.uk 232f69bfdd Minor documentation fix 2006-01-17 16:06:03 +01:00
emellor@leeni.uk.xensource.com 9b08b0371d This patch adds a new domain config option, 'cpus' which is a list of
CPUs a domains' vcpus can use.  The older 'cpu' config option is
prepended to the list of cpus to use and will keep the behavior of
pinning VCPU0.

The cpus option supports ranges and negation, so:

cpus = "0-3,5,^1" produces -> [0,2,3,5]

The list is circular, so in a domain with the following config:

vcpus = 4
cpus  = "0,3,7"  # Use any of 0, 3, 7 for this domain.

would see vcpus 0-3 pinned to cpus 0,3,7,0 respectively.

Also, the pin operation is moved before the memory reservation as vcpu
to cpu mapping will be helpful for future NUMA work when trying to
allocate pages close to the physical cpus being used.

An update to the display of cpumap was needed to normalize the cpumap
values to the range of possible cpus.

I've also included some text for the xmdomain.cfg(5) man page.

Signed-off-by: Ryan Harper <ryanh@us.ibm.com>
2005-12-02 15:52:47 +00:00
dan@localhost.localdomain 26937cc111 First stab at a xend-config.sxp man page. 2005-11-20 15:01:15 +01:00
sean@dague.net 1443ca6d8c updates to xmdomain.cfg.5 man page to document most used options, and
provide a basic template for examples
2005-11-18 13:01:30 +01:00
sean@dague.net 829e31bad5 added block device content, including finding a few more bugs in xen 2005-11-18 12:58:16 +01:00
emellor@leeni.uk.xensource.com 8add0c9fed This patch explains network-* options in xm.1, including the bits that are
currently not really working.

Signed off by: Sean Dague <sean@dague.net>
2005-11-17 12:01:13 +01:00
emellor@leeni.uk.xensource.com cb248d6b16 The following patch removes every (hopefully) reference to network-limit.
Upon further investigation it sets Device parameters that don't exist any
longer, thus causing exceptions.  As it looks like this is completely
obsolete, and no one is actively working on it, we should just rip it out to
end the confusion.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-16 11:31:57 +01:00
emellor@leeni.uk.xensource.com 0e9ceb580a This patch is largely stylistic, and gets rid of StuddlyCaps formatting in
all the param variables, make consistant use of bold and italics in the the
man pages to make it easier to read, and adds a few minor content additions.
It makes actually reading the man page a lot easier.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:36:42 +01:00
emellor@leeni.uk.xensource.com 92c71aea0d This patch adds more content around the scheduler portions of the xm.1 man
page.  Most of this content came from the xensource wiki or the sedf doc in
the Xen tree.  It still needs more work, but it is a good first start.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:27:48 +01:00
emellor@leeni.uk.xensource.com c7509dd6cc This patch is another in the continued effort to flesh out the man pages, it
adds pretty reasonable text to most of the code xen domain and host commands
(device and scheduler will come in the future).

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:26:37 +01:00
emellor@leeni.uk.xensource.com aeedebd423 Further changes to xm.1 man page.
Signed-off-by: Sean Dague <sean@dague.net>
2005-11-12 18:52:16 +01:00
emellor@leeni.uk.xensource.com 23b53644ac The following patch is work in progress to add more meat to the xm.1 man
page.  Expect more content to trickle in over time.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-12 18:32:19 +01:00
emellor@leeni.uk.xensource.com 1455bb4870 Added description of the behaviour of rename-restart.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
2005-11-07 15:06:00 +01:00
kaf24@firebug.cl.cam.ac.uk d5dce3e452 The following patch adds a section for SHUTDOWN OPTIONS for the xmdomain.cfg
man page.  It documents the new set of options introduced over the last few
weeks.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-01 10:36:19 +01:00
emellor@leeni.uk.xensource.com 94608ed8f3 --- xen-unstable.hg.copy/docs/Makefile 2005-10-28 18:36:33.000000000 -0700
+++ xen-unstable.hg/docs/Makefile	2005-10-28 14:58:18.000000000 -0700
@@ -1,5 +1,6 @@
 #!/usr/bin/make -f

+VERSION		= xen-unstable
 INSTALL		= install
 INSTALL_DIR	= $(INSTALL) -d -m0755

@@ -9,9 +10,15 @@
 FIG2DEV		:= fig2dev
 LATEX2HTML	:= latex2html
 DOXYGEN		:= doxygen
+POD2MAN		:= pod2man

 pkgdocdir	:= /usr/share/doc/xen
+mandir		:= /usr/share/man

+DOC_MAN5SRC	:= $(wildcard man/*.pod.5)
+DOC_MAN1SRC	:= $(wildcard man/*.pod.1)
+DOC_MAN1	:= $(patsubst man/%.pod.1,man1/%.1,$(DOC_MAN1SRC))
+DOC_MAN5	:= $(patsubst man/%.pod.5,man5/%.5,$(DOC_MAN5SRC))
 DOC_TEX		:= src/user.tex src/interface.tex
 DOC_PS		:= $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
 DOC_PDF		:= $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
@@ -22,7 +29,7 @@
 .PHONY:	all build dev-docs python-dev-docs ps pdf html clean install

 all: build
-build: ps pdf html
+build: ps pdf html man-pages
 	rm -f *.aux *.dvi *.bbl *.blg *.glo *.idx *.ilg *.log *.ind *.toc

 dev-docs: python-dev-docs
@@ -43,17 +50,36 @@
 	$(MAKE) -C api/tools/python/latex ; else                   \
         echo "Doxygen not installed; skipping python-dev-docs."; fi

+man-pages:
+	@if which $(POD2MAN) 1>/dev/null 2>/dev/null; then \
+	$(MAKE) $(DOC_MAN1) $(DOC_MAN5); fi
+
+man1/%.1: man/%.pod.1 Makefile
+	$(INSTALL_DIR) $(@D)
+	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man1.//'| \
+		sed 's/.1//'` -s 1 -c "Xen" $< $@
+
+man5/%.5: man/%.pod.5 Makefile
+	$(INSTALL_DIR) $(@D)
+	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man5.//'| \
+		sed 's/.5//'` -s 5 -c "Xen" $< $@
+
 clean:
 	rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~
 	rm -rf *.ilg *.log *.ind *.toc *.bak core
 	rm -rf $(GFX) ps pdf html
 	rm -rf api
+	rm -rf man5
+	rm -rf man1

 install: all
 	rm -rf $(DESTDIR)$(pkgdocdir)
 	$(INSTALL_DIR) $(DESTDIR)$(pkgdocdir)
 	cp -dR ps $(DESTDIR)$(pkgdocdir)
 	cp -dR pdf $(DESTDIR)$(pkgdocdir)
+	$(INSTALL_DIR) $(DESTDIR)$(mandir)
+	cp -dR man1 $(DESTDIR)$(mandir)
+	cp -dR man5 $(DESTDIR)$(mandir)
 	[ ! -d html ] || cp -dR html $(DESTDIR)$(pkgdocdir)

 pdf/%.pdf: ps/%.ps
2005-10-30 17:20:09 +01:00