Home | History | Annotate | Download | only in virt-install
      1 #
      2 # CDDL HEADER START
      3 #
      4 # The contents of this file are subject to the terms of the
      5 # Common Development and Distribution License (the "License").
      6 # You may not use this file except in compliance with the License.
      7 #
      8 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9 # or http://www.opensolaris.org/os/licensing.
     10 # See the License for the specific language governing permissions
     11 # and limitations under the License.
     12 #
     13 # When distributing Covered Code, include this CDDL HEADER in each
     14 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15 # If applicable, add the following below this CDDL HEADER, with the
     16 # fields enclosed by brackets "[]" replaced with your own identifying
     17 # information: Portions Copyright [yyyy] [name of copyright owner]
     18 #
     19 # CDDL HEADER END
     20 #
     21 
     22 #
     23 # Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
     24 # Use is subject to license terms.
     25 #
     26 # ident	"@(#)README	1.4	09/09/18 SMI"
     27 #
     28 
     29 DESCRIPTION:
     30 ===========
     31 This test suite is designed to test the functionality of the
     32 virt-install xVM guest installation utility.
     33 
     34 PREREQUISITES:
     35 =============
     36 1.  The system must be booted into the Xen kernel.  Uname -a output must
     37 show i86xpv.
     38 
     39 2.  For the pxe test case, the dom0 must be capable of installation of HVM 
     40 guests.  To check, run the following:
     41 
     42     # virsh capabilities
     43 
     44 and look for the <features> tagname.  Intel based dom0s will have the
     45 "<vmx/>" tag inside the <features> tag.  AMD based dom0s will have the
     46 "<svm/>" inside the <features> tag.
     47 
     48 Ex:
     49 (intel dom0)
     50 # virsh capabilities
     51 <capabilities>
     52   <host>
     53     <cpu>
     54       <arch>i86pc</arch>
     55       <features>
     56         <vmx/>     <-- HVM enabled
     57         <pae/>
     58       </features>
     59   <.....>
     60 
     61 3.  A valid test_config file.  See README.CONFIG for more information.
     62 
     63 4.  The cti-tet test harness lite package is required to be installed.
     64 
     65 	As root, do the following:
     66 
     67 	# pkgadd -d <package location> SUNWstc-tetlite 
     68 	(e.g. the name of the tet lite package)
     69 
     70 TEST SUITE INSTALLATION:
     71 =======================
     72 
     73 In the majority of cases, the test suite can be installed from packages. The
     74 package is called SUNWstc-xvm-virt-install and installs into "/opt" by default.
     75 Installation is via the standard Solaris package installation tool pkgadd(1m).
     76 To install SUNWstc-xvm-virt-install simply enter the following command line:
     77 
     78     root# pkgadd -d <package-location>  SUNWstc-xvm-virt-install
     79 
     80 Where <package-location> refers to the path of the SUNWstc-xvm-virt-install 
     81 package directory.
     82 
     83 ALTERNATIVELY, the test suite source can be installed, binaries built from 
     84 the source tree, and run from that location.
     85 
     86 As any (non-root) user do the following after installing the test suite 
     87 source:
     88 
     89 1. TET_ROOT=<Installation root of tet>
     90 2. export TET_ROOT
     91 3. CTI_ROOT=$TET_ROOT/contrib/ctitools
     92 4. export CTI_ROOT
     93 5. cd $TET_SUITE_ROOT/virt-install
     94 6. /usr/ccs/bin/make
     95 
     96 The build can also install into a proto directory below the workspace 
     97 root directory.  The workspace root (also referred to here as WS_ROOT)
     98 is the directory below which the usr/src/suites directory is found.
     99 To build the test suite code and install it under <WS_ROOT>/proto, do:
    100 
    101 7. /usr/ccs/bin/make install
    102 
    103 In addition, test suite packages can be built using the proto directory,
    104 using 
    105 
    106 8. /usr/ccs/bin/make package
    107 
    108 Packages built this way will be stored under the package directory
    109 which corresponds to the build machine's system architecture.  For
    110 example, if the build is performed on an x64 system, the packages
    111 will be placed under <WS_ROOT>/packages/i386.
    112 
    113 
    114 TEST SUITE CONFIGURATION / EXECUTION:
    115 ====================================
    116 As root do the following:
    117 
    118 1.  Set the following environment variables:
    119 
    120 export TET_ROOT=<Installation root of tet>
    121 export CTI_ROOT=$TET_ROOT/contrib/ctitools
    122 export TET_SUITE_ROOT=/opt/SUNWstc-xvm-virt-install (installation path of suite)
    123 export PATH=$PATH:$TET_ROOT/bin:$CTI_ROOT/bin
    124 
    125 2.  Create a configuration file to use for the suite.  See
    126 README.CONFIG for more information.
    127 
    128 3.  Run the test suite:
    129 
    130 To run the entire suite do the following:
    131 # run_test -F /path/to/your/configuration/file virt-install
    132 
    133 The following is the syntax of the command line usage :
    134 
    135 # run_test virt-install [<scenario>|tc_dir:[tp_list]]
    136 
    137 additional examples using optional arguments :
    138 
    139 run the zvol test case
    140 # run_test virt-install zvol
    141 
    142 run test purpose 3 of the zvol test case
    143 # run_test virt-install zvol:3
    144 
    145 TEST SUITE UNCONFIGURE:
    146 ======================
    147 There is no need for any unconfigure to be run after the test suite
    148 executes.  It is designed to restore the system to the condition it
    149 was in before the suite was run.
    150 
    151 IMPORTANT NOTE:
    152 ===============
    153 All of the jumpstart files (found in $TET_SUITE_ROOT/virt-install/etc)
    154 default to use within the BRM5 network.  If this suite is being
    155 executed on another network, you will need to specify your own sysidcfg
    156 file in the configuration file.
    157 
    158 PXE CONFIGURATION (HVM guests ONLY):
    159 =================
    160 To configure the test suite to execute the pxe test case, you will
    161 need to perform the following steps:
    162 
    163 	- Find (or create) the mac address the domU will use
    164 	- Set up your install server to listen for rarp/dhcp requests from
    165 	  that mac address.  
    166 	- Set up a jumpstart directory which uses
    167 	  $TET_SUITE_ROOT/virt-install/etc/zfs.SUNWCreq as the
    168 	  profile, default.sysidcfg as the sysidcfg (configured for your
    169 	  install server), and default.finish as the finish script.
    170 	- Set the PXE argument to 1
    171