debuggers.hg

changeset 639:4515f4d0701f

bitkeeper revision 1.335 (3f0d61daWuAj1MdY8xaA6enqSDZSEg)

Documentation update.
author rac61@labyrinth.cl.cam.ac.uk
date Thu Jul 10 12:53:46 2003 +0000 (2003-07-10)
parents 75e23848b238
children 7f7fc97be5fd
files .rootkeys tools/control/README-web tools/control/doc/INSTALL-cmdline tools/control/doc/INSTALL-web tools/control/doc/USAGE-cmdline
line diff
     1.1 --- a/.rootkeys	Thu Jul 10 12:32:49 2003 +0000
     1.2 +++ b/.rootkeys	Thu Jul 10 12:53:46 2003 +0000
     1.3 @@ -7,10 +7,12 @@ 3e6377b24eQqYMsDi9XrFkIgTzZ47A tools/bal
     1.4  3e6377d6eiFjF1hHIS6JEIOFk62xSA tools/balloon/README
     1.5  3e6377dbGcgnisKw16DPCaND7oGO3Q tools/balloon/balloon.c
     1.6  3eb781edFwm_pW9FwnQACIe68viLOw tools/control/Makefile
     1.7 -3eca6a96a31IwaKtkEa4jmzwTWlm8Q tools/control/README-web
     1.8  3eb781fceEYkUi1XHKf2V0KX7si2JA tools/control/build-cmdline.xml
     1.9  3ec41f7cWCxQ8pdH8ZWqhhv-38qQ1w tools/control/build-web.xml
    1.10  3ec41f7ca6IBXDSe0HVcMPp3PPloOQ tools/control/build.properties
    1.11 +3f0d61da3O5gkcntbIOdUmN2-RcZbQ tools/control/doc/INSTALL-cmdline
    1.12 +3eca6a96a31IwaKtkEa4jmzwTWlm8Q tools/control/doc/INSTALL-web
    1.13 +3f0d61daCTHGCpQK0Brz3PAp80d_2Q tools/control/doc/USAGE-cmdline
    1.14  3eb781fcabCKRogwxJA3-jJKstw9Vg tools/control/domctl.xml
    1.15  3f042c35FzVap5QW0UBPnZ2ZM0l3QA tools/control/src/org/xenoserver/cmdline/CommandParser.java
    1.16  3eb781fdNQvEJW3tNvovjqoN7GlePA tools/control/src/org/xenoserver/cmdline/Main.java
     2.1 --- a/tools/control/README-web	Thu Jul 10 12:32:49 2003 +0000
     2.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.3 @@ -1,44 +0,0 @@
     2.4 -
     2.5 -some notes on configuring xenctl...
     2.6 -
     2.7 -to build:
     2.8 -
     2.9 - export PATH=/usr/groups/xeno/build_tools/bin:${PATH}
    2.10 - # this next step has already been done.
    2.11 - # cp $CATALINA_HOME/server/lib/catalina-ant.jar $ANT_HOME/lib
    2.12 - cd xeno.bk/tools/control
    2.13 - make
    2.14 - cd xeno.bk/tools/internal
    2.15 - make
    2.16 -
    2.17 -to setup:
    2.18 -
    2.19 - ## expand the jakarta (aka catalina) tree somewhere accessible by dom0
    2.20 - export ROOTDIR=/anfs/scratch/labyrinth/ach61
    2.21 - cd $ROOTDIR
    2.22 - tar zxf /usr/groups/xeno/archive/tomcat-4.1.24.tar.gz 
    2.23 - export CATALINA_HOME=$ROOTDIR/jakarta-tomcat-4.1.24
    2.24 - export JAVA_HOME=/usr/groups/xeno/build_tools/java-1.4.1
    2.25 -
    2.26 - ## edit $CATALINA_HOME/conf/server.xml, change port 8080 to port 80
    2.27 - cp $CATALINA_HOME/conf/server.xml $CATALINA_HOME/conf/server.orig
    2.28 - sed 's/8080/80/g' $CATALINA_HOME/conf/server.orig > $CATALINA_HOME/conf/server.xml 
    2.29 -
    2.30 - ## install the xenctl web archive
    2.31 - cp xeno.bk/tools/control/dist/xenctl-0.1-dev.war $CATALINA_HOME/webapps/xenctl.war
    2.32 - cp xeno.bk/tools/control/domctl.xml /var/lib/xen
    2.33 -
    2.34 - ## either edit xi_tools_dir in domctl.xml or copy the binaries
    2.35 - # find xeno.bk/tools/internal -perm +111 -type f -exec cp {} /usr/local/bin \;
    2.36 -
    2.37 -to run:
    2.38 - $CATALINA_HOME/bin/startup.sh
    2.39 - # point your browser at hostname-0.xeno.cl.cam.ac.uk:80/xenctl
    2.40 -
    2.41 -
    2.42 -for development:
    2.43 - ## edit xeno.bk/tools/control/build.properties
    2.44 - # change manger.url to your xenoserver: mousetrap-0.xeno.cl.cam.ac.uk
    2.45 - ## to "make install-web" in xeno.bk/tools/control  instead of copying the war file
    2.46 - cp $CATALINA_HOME/conf/tomcat-users.xml $CATALINA_HOME/conf/tomcat-users.orig
    2.47 - sed -e 's/<tomcat-users>/<tomcat-users>\
  <role rolename="standard"\/>\
  <role rolename="manager"\/>\
  <user username="hobbes" password="tiger" roles="standard,manager"\/>/' $CATALINA_HOME/conf/tomcat-users.orig > $CATALINA_HOME/conf/tomcat-users.xml
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/tools/control/doc/INSTALL-cmdline	Thu Jul 10 12:53:46 2003 +0000
     3.3 @@ -0,0 +1,11 @@
     3.4 +To install command line interface:
     3.5 +
     3.6 +cd xeno.bk/tools/control
     3.7 +make cmdline
     3.8 +cp xenctl xenctl-cmdline.jar <dom0>/usr/local/bin
     3.9 +cp domctl.xml <dom0>/etc
    3.10 +mkdir <dom0>/var/lib/xen
    3.11 +
    3.12 +First invocation of command line interface will give a warning about not being
    3.13 +able to load the disk state from /var/lib/xen/vdstate.xml. This is ok, it'll
    3.14 +be created the first time you change any state in the virtual disk manager.
    3.15 \ No newline at end of file
     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/tools/control/doc/INSTALL-web	Thu Jul 10 12:53:46 2003 +0000
     4.3 @@ -0,0 +1,50 @@
     4.4 +
     4.5 +some notes on configuring xenctl web interface...
     4.6 +
     4.7 +to build:
     4.8 +
     4.9 + export PATH=/usr/groups/xeno/build_tools/bin:${PATH}
    4.10 + # this next step has already been done.
    4.11 + # cp $CATALINA_HOME/server/lib/catalina-ant.jar $ANT_HOME/lib
    4.12 + cd xeno.bk/tools/control
    4.13 + make web
    4.14 + # You only need to make/install internal if you haven't already
    4.15 + # it's also needed by the cmdline tool
    4.16 + cd xeno.bk/tools/internal
    4.17 + make
    4.18 +
    4.19 +to setup:
    4.20 +
    4.21 + ## expand the jakarta (aka catalina) tree somewhere accessible by dom0
    4.22 + export ROOTDIR=/anfs/scratch/<somewhere>
    4.23 + cd $ROOTDIR
    4.24 + tar zxf /usr/groups/xeno/archive/tomcat-4.1.24.tar.gz 
    4.25 + export CATALINA_HOME=$ROOTDIR/jakarta-tomcat-4.1.24
    4.26 + export JAVA_HOME=/usr/groups/xeno/build_tools/java-1.4.1
    4.27 +
    4.28 + ## edit $CATALINA_HOME/conf/server.xml, change port 8080 to port 80
    4.29 + cp $CATALINA_HOME/conf/server.xml $CATALINA_HOME/conf/server.orig
    4.30 + sed 's/8080/80/g' $CATALINA_HOME/conf/server.orig > $CATALINA_HOME/conf/server.xml 
    4.31 +
    4.32 + ## install the xenctl web archive
    4.33 + cp xeno.bk/tools/control/dist/xenctl-0.1-dev.war $CATALINA_HOME/webapps/xenctl.war
    4.34 + # Only if you have not already copied this file for the command line tool
    4.35 + cp xeno.bk/tools/control/domctl.xml /etc
    4.36 + # If it doesn't exist:
    4.37 + mkdir /var/lib/xen
    4.38 +
    4.39 + ## either edit xi_tools_dir in domctl.xml or copy the binaries
    4.40 + ## unless already installed for the command line tool
    4.41 + # find xeno.bk/tools/internal -perm +111 -type f -exec cp {} /usr/local/bin \;
    4.42 +
    4.43 +to run:
    4.44 + $CATALINA_HOME/bin/startup.sh
    4.45 + # point your browser at hostname-0.xeno.cl.cam.ac.uk:80/xenctl
    4.46 +
    4.47 +
    4.48 +for development:
    4.49 + ## edit xeno.bk/tools/control/build.properties
    4.50 + # change manger.url to your xenoserver: mousetrap-0.xeno.cl.cam.ac.uk
    4.51 + ## to "make install-web" in xeno.bk/tools/control  instead of copying the war file
    4.52 + cp $CATALINA_HOME/conf/tomcat-users.xml $CATALINA_HOME/conf/tomcat-users.orig
    4.53 + sed -e 's/<tomcat-users>/<tomcat-users>\
  <role rolename="standard"\/>\
  <role rolename="manager"\/>\
  <user username="hobbes" password="tiger" roles="standard,manager"\/>/' $CATALINA_HOME/conf/tomcat-users.orig > $CATALINA_HOME/conf/tomcat-users.xml
     5.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     5.2 +++ b/tools/control/doc/USAGE-cmdline	Thu Jul 10 12:53:46 2003 +0000
     5.3 @@ -0,0 +1,77 @@
     5.4 +General
     5.5 +-------
     5.6 +
     5.7 +Invoking xenctl with no arguments, or with 'help' gives general usage
     5.8 +xenctl help command, or xenctl command -?, gives specific command help
     5.9 +
    5.10 +Domain control
    5.11 +--------------
    5.12 +
    5.13 +xenctl's command line interface is based on domctl. Defaults for domain
    5.14 +creation are found in /etc/domctl.xml.
    5.15 +
    5.16 +Creating a domain: xenctl domain new <parameters>
    5.17 +All parameters may be omitted to get defaults from domctl.xml, see help
    5.18 +for ful details of available parameters.
    5.19 +
    5.20 +Starting a domain: xenctl domain start -n<domain_no>
    5.21 +Stopping a domain: xenctl domain stop -n<domain_no>
    5.22 +Destroying a domain: xenctl domain destroy -n<domain_no> (add -f to force
    5.23 +                     destruction of a running domain)
    5.24 +
    5.25 +Listing all domains: xenctl domain list
    5.26 +
    5.27 +Physical disk access management
    5.28 +-------------------------------
    5.29 +
    5.30 +Grant read-only access to a disk or partition:
    5.31 +  xenctl physical grant -n<domain_no> -p<partition_name> (e.g. sda10, sdc..etc)
    5.32 +Grant read-write access to a disk or partition:
    5.33 +  xenctl physical grant -w -n<domain_no> -p<partition_name>
    5.34 +  (if you grant read-write to a domain which already has read for the same
    5.35 +   partition, it will be upgraded quite happily, and vice versa)
    5.36 +Revoke access to a disk or partition:
    5.37 +  xenctl physical revoke -n<domain_no> -p<partition_name>
    5.38 +List access a domain has:
    5.39 +  xenctl physical list -n<domain_no>
    5.40 +   will list all the physical disks/partitions which the given domain may access
    5.41 +   and the rights assigned.
    5.42 +   
    5.43 +Virtual disk management
    5.44 +-----------------------
    5.45 +
    5.46 +Add a disk partition as a XenoPartition (raw space to create VDs on):
    5.47 +  xenctl partitions add -p<partition_name> -c<chunk_size>
    5.48 +    adds the partition, splitting it up into chunks of the size given
    5.49 +    Sizes can all be specified as k, m, g.
    5.50 +Lists partitions:
    5.51 +  xenctl partitions list
    5.52 +    XenoPartitions are shown in [ ]
    5.53 +    
    5.54 +Create a virtual disk:
    5.55 +  xenctl vd create -n<name> -s<size> [-e<expiry>]
    5.56 +    Name is for identification only and need not be unique. Expiry may be none.
    5.57 +    Size can be in k, m, g
    5.58 +    You will be given a 10-digit key for the disk which is its unique identifier.
    5.59 +Delete a virtual disk:
    5.60 +  xenctl vd delete -k<key>
    5.61 +    Virtual disks with VBDs mapped to them may not be deleted.
    5.62 +Refresh the expiry on a disk:
    5.63 +  xenctl vd refresh -k<key> [-e<expiry>]
    5.64 +    Sets a new expiry, may be none.
    5.65 +List virtual disks:
    5.66 +  xenctl vd show
    5.67 +  
    5.68 +List space free:
    5.69 +  xenctl vd free
    5.70 +    Shows how much space has been added with partitions add, but not allocated
    5.71 +    to a virtual disk.
    5.72 +    
    5.73 +Create a virtual block device:
    5.74 +  xenctl vbd create -n<domain> -k<key> -v<vbd_number> [-w]
    5.75 +    Maps the disk with the given key into the domain. -w allows read-write.
    5.76 +    vbd number 0 = /dev/xvda, number 1 = /dev/xvdb, and so on.
    5.77 +Lists virtual block devices:
    5.78 +  xenctl vbd show
    5.79 +  
    5.80 +Virtual block devices are automatically deleted when their domain is destroyed.
    5.81 \ No newline at end of file