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.CONFIG	1.3	09/09/18 SMI"
     27 #
     28 
     29 The purpose of this README file is to give instructions on how to set
     30 up a valid test_config file for the virt-install test suite.  There 
     31 are example test_config files in $TET_SUITE_ROOT/virt-install/config 
     32 which are configured specifically for the BRM05 internal network.
     33 
     34 REQUIREMENTS:
     35 ------------
     36 - At least one UFS slice of at least 15gb.  For the maxflags test
     37   case, 20gb is required
     38 - At least one plumbed network interface.
     39 - A valid network name for the domU to use with a valid IP address.
     40   This network name/IP also needs a valid mac address.  In order to
     41   run the Linux and PXE test cases, the local DHCP server will need to
     42   know about the IP/mac address.
     43 - A valid Nevada ISO file accessible to the dom0 either local to the
     44   system or across the network.
     45 
     46 EXAMPLES:
     47 --------
     48 test_config.template - template file to use for new sites
     49 
     50 test_config.fullrun - config file which will run all test cases in the
     51 suite.  Configured for linux, pxe, nfs and simultaneous test cases.
     52  
     53 SECTIONS:
     54 --------
     55 The configuration template is split into 4 sections:
     56 - test suite execution (DO NOT CHANGE ANYTHING THERE)
     57 - required arguments
     58 - optional arguments
     59 - maximums arguments
     60 
     61 # -----------------------------------------------------------------------------
     62 # TEST SUITE EXECUTION ARGUMENTS
     63 # -----------------------------------------------------------------------------
     64 #
     65 # DO NOT CHANGE ANYTHING IN THIS SECTION.  PYTHONPATH MUST BE SET OR
     66 # PYTHON TET SCRIPTS WILL NOT RUN.
     67 #
     68 PYTHONPATH=${CTI_ROOT}/lib:${TET_SUITE_ROOT}/virt-install/lib
     69 TET_CODE=${TET_ROOT}/tet_code
     70 
     71 # -----------------------------------------------------------------------------
     72 # REQUIRED ARGUMENTS
     73 # -----------------------------------------------------------------------------
     74 
     75 # SOLARISISO is the path to a valid Nevada ISO.
     76 SOLARISISO=
     77 
     78 # DOMUNAMES is a comma-seperated list of valid static network names.
     79 # Do not add any spaces around the slices or commas
     80 # Syntax is DOMUNAMES=host1,host2,host3,.... 
     81 DOMUNAMES=
     82 
     83 # DISKS is a comma-seperate list of valid ufs slices.  The slices need
     84 # to be unmounted.  Do not specify the full path.  Do not add any
     85 # spaces around the slices or commas.
     86 # Syntax is DISKS=c#t#d#s#[,c#t#d#s#,.....]
     87 DISKS=
     88 
     89 # DOMUMACADDRS is the domU's mac address.  The local DHCP server will
     90 # need to know about this mac address in order to run the PXE and
     91 # Linux test cases.  See the README file for information on setting up
     92 # the DHCP server.
     93 # Syntax is DOMUMACADDRS=<mac address 1>[:<mac address2>:...]
     94 DOMUMACADDRS=
     95 
     96 # -----------------------------------------------------------------------------
     97 # OPTIONAL ARGUMENTS
     98 # -----------------------------------------------------------------------------
     99 
    100 # SYSIDCFG is the full path to a valid sysidcfg for the network the
    101 # dom0 is on.  If omitted, the test suite will use
    102 # etc/default.sysidcfg which is specific for the BRM network.  Please
    103 # see the main README file for setting up a sysidcfg for your network.
    104 # SYSIDCFG=
    105 
    106 # LINUXISO is the path to a valid RHEL 5.0 (or newer) ISO image.  It
    107 # can be either 32 or 64 bit.  If this argument is commented out, the
    108 # linux test case will not run.
    109 # LINUXISO=
    110 
    111 # PROFILE is which profile the guests should use when installing.
    112 # Valid
    113 # options are SUNWCXall and SUNWCreq.  If omitted, the suite will
    114 # default to SUNWCreq for speed improvements.
    115 # PROFILE=
    116 
    117 # PXE=1 configures the pxe test case to run and requires specific
    118 # actions to take on the local install server.  Please see the README
    119 # for
    120 # explanation of steps required.
    121 # PXE=
    122 
    123 # IFACE is the primary interface the test suite will use for guests.
    124 # If omitted, the suite will select an "UP" interface from dladm
    125 # show-link.
    126 # IFACE=
    127 
    128 # NFSROOT is the path to a directory on a remote server owned by the
    129 # xvm user.
    130 # Syntax is NFSROOT=/net/<remote machine>/<path>
    131 # NFSROOT=
    132 
    133 # NFSVDISKTYPE is the type of vdisk to create in the NFSROOT.
    134 # NFSVDISKTYPE can be any one of vmdk, vdi, or vhd
    135 # Syntax is NFSVDISKTYPE=[vmdk,vdi,vhd]
    136 # NFSVDISKTYPE=
    137 
    138 # NFSVDISKSPARSE is a boolean flag to create either a sparse or flat
    139 # vdisk file of type NFSVDISKTYPE in NFSROOT.  NFSVDISKSPARSE can be
    140 # either true (sparse) or false (flat).
    141 # Syntax is NFSVDISKSPARSE=[true,false]
    142 # NFSVDISKSPARSE=
    143 
    144 # -----------------------------------------------------------------------------
    145 # MAXIMUM ARGUMENTS
    146 # -----------------------------------------------------------------------------
    147 
    148 # Each MAX argument is the threshhold the system needs to have to
    149 # execute the maxflags test case.  Lowering these values, allows the
    150 # maxflags test case to run on a system with less resources than would
    151 # normally be allowed (25gb of disk, 32gb of ram and 16 cpus is the
    152 # default setting)
    153 
    154 # MAXDISK is the overrideable amount of disk the dom0 needs to have
    155 # (in MB).  NOTE:  This value has a lower bound of 20000.0 (20 gb)
    156 # MAXDISK=
    157 
    158 # MAXRAM is the overrideable amount of memory the dom0 needs to have
    159 # (in MB).  NOTE:  This value has a lower bound of 4000 (4gb)
    160 # MAXRAM=
    161 
    162 # MAXVCPU is the overrideable number of cpus the dom0 needs to have.
    163 # NOTE:  This value has a lower bound of 2 cpus
    164 # MAXVCPU=
    165 # -----------------------------------------------------------------------------
    166