#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
# ident	"@(#)README	1.4	09/09/18 SMI"
#

DESCRIPTION:
===========
This test suite is designed to test the functionality of the
virt-install xVM guest installation utility.

PREREQUISITES:
=============
1.  The system must be booted into the Xen kernel.  Uname -a output must
show i86xpv.

2.  For the pxe test case, the dom0 must be capable of installation of HVM 
guests.  To check, run the following:

    # virsh capabilities

and look for the <features> tagname.  Intel based dom0s will have the
"<vmx/>" tag inside the <features> tag.  AMD based dom0s will have the
"<svm/>" inside the <features> tag.

Ex:
(intel dom0)
# virsh capabilities
<capabilities>
  <host>
    <cpu>
      <arch>i86pc</arch>
      <features>
        <vmx/>     <-- HVM enabled
        <pae/>
      </features>
  <.....>

3.  A valid test_config file.  See README.CONFIG for more information.

4.  The cti-tet test harness lite package is required to be installed.

	As root, do the following:

	# pkgadd -d <package location> SUNWstc-tetlite 
	(e.g. the name of the tet lite package)

TEST SUITE INSTALLATION:
=======================

In the majority of cases, the test suite can be installed from packages. The
package is called SUNWstc-xvm-virt-install and installs into "/opt" by default.
Installation is via the standard Solaris package installation tool pkgadd(1m).
To install SUNWstc-xvm-virt-install simply enter the following command line:

    root# pkgadd -d <package-location>  SUNWstc-xvm-virt-install

Where <package-location> refers to the path of the SUNWstc-xvm-virt-install 
package directory.

ALTERNATIVELY, the test suite source can be installed, binaries built from 
the source tree, and run from that location.

As any (non-root) user do the following after installing the test suite 
source:

1. TET_ROOT=<Installation root of tet>
2. export TET_ROOT
3. CTI_ROOT=$TET_ROOT/contrib/ctitools
4. export CTI_ROOT
5. cd $TET_SUITE_ROOT/virt-install
6. /usr/ccs/bin/make

The build can also install into a proto directory below the workspace 
root directory.  The workspace root (also referred to here as WS_ROOT)
is the directory below which the usr/src/suites directory is found.
To build the test suite code and install it under <WS_ROOT>/proto, do:

7. /usr/ccs/bin/make install

In addition, test suite packages can be built using the proto directory,
using 

8. /usr/ccs/bin/make package

Packages built this way will be stored under the package directory
which corresponds to the build machine's system architecture.  For
example, if the build is performed on an x64 system, the packages
will be placed under <WS_ROOT>/packages/i386.


TEST SUITE CONFIGURATION / EXECUTION:
====================================
As root do the following:

1.  Set the following environment variables:

export TET_ROOT=<Installation root of tet>
export CTI_ROOT=$TET_ROOT/contrib/ctitools
export TET_SUITE_ROOT=/opt/SUNWstc-xvm-virt-install (installation path of suite)
export PATH=$PATH:$TET_ROOT/bin:$CTI_ROOT/bin

2.  Create a configuration file to use for the suite.  See
README.CONFIG for more information.

3.  Run the test suite:

To run the entire suite do the following:
# run_test -F /path/to/your/configuration/file virt-install

The following is the syntax of the command line usage :

# run_test virt-install [<scenario>|tc_dir:[tp_list]]

additional examples using optional arguments :

run the zvol test case
# run_test virt-install zvol

run test purpose 3 of the zvol test case
# run_test virt-install zvol:3

TEST SUITE UNCONFIGURE:
======================
There is no need for any unconfigure to be run after the test suite
executes.  It is designed to restore the system to the condition it
was in before the suite was run.

IMPORTANT NOTE:
===============
All of the jumpstart files (found in $TET_SUITE_ROOT/virt-install/etc)
default to use within the BRM5 network.  If this suite is being
executed on another network, you will need to specify your own sysidcfg
file in the configuration file.

PXE CONFIGURATION (HVM guests ONLY):
=================
To configure the test suite to execute the pxe test case, you will
need to perform the following steps:

	- Find (or create) the mac address the domU will use
	- Set up your install server to listen for rarp/dhcp requests from
	  that mac address.  
	- Set up a jumpstart directory which uses
	  $TET_SUITE_ROOT/virt-install/etc/zfs.SUNWCreq as the
	  profile, default.sysidcfg as the sysidcfg (configured for your
	  install server), and default.finish as the finish script.
	- Set the PXE argument to 1

#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
# ident	"@(#)README.CONFIG	1.3	09/09/18 SMI"
#

The purpose of this README file is to give instructions on how to set
up a valid test_config file for the virt-install test suite.  There 
are example test_config files in $TET_SUITE_ROOT/virt-install/config 
which are configured specifically for the BRM05 internal network.

REQUIREMENTS:
------------
- At least one UFS slice of at least 15gb.  For the maxflags test
  case, 20gb is required
- At least one plumbed network interface.
- A valid network name for the domU to use with a valid IP address.
  This network name/IP also needs a valid mac address.  In order to
  run the Linux and PXE test cases, the local DHCP server will need to
  know about the IP/mac address.
- A valid Nevada ISO file accessible to the dom0 either local to the
  system or across the network.

EXAMPLES:
--------
test_config.template - template file to use for new sites

test_config.fullrun - config file which will run all test cases in the
suite.  Configured for linux, pxe, nfs and simultaneous test cases.
 
SECTIONS:
--------
The configuration template is split into 4 sections:
- test suite execution (DO NOT CHANGE ANYTHING THERE)
- required arguments
- optional arguments
- maximums arguments

# -----------------------------------------------------------------------------
# TEST SUITE EXECUTION ARGUMENTS
# -----------------------------------------------------------------------------
#
# DO NOT CHANGE ANYTHING IN THIS SECTION.  PYTHONPATH MUST BE SET OR
# PYTHON TET SCRIPTS WILL NOT RUN.
#
PYTHONPATH=${CTI_ROOT}/lib:${TET_SUITE_ROOT}/virt-install/lib
TET_CODE=${TET_ROOT}/tet_code

# -----------------------------------------------------------------------------
# REQUIRED ARGUMENTS
# -----------------------------------------------------------------------------

# SOLARISISO is the path to a valid Nevada ISO.
SOLARISISO=

# DOMUNAMES is a comma-seperated list of valid static network names.
# Do not add any spaces around the slices or commas
# Syntax is DOMUNAMES=host1,host2,host3,.... 
DOMUNAMES=

# DISKS is a comma-seperate list of valid ufs slices.  The slices need
# to be unmounted.  Do not specify the full path.  Do not add any
# spaces around the slices or commas.
# Syntax is DISKS=c#t#d#s#[,c#t#d#s#,.....]
DISKS=

# DOMUMACADDRS is the domU's mac address.  The local DHCP server will
# need to know about this mac address in order to run the PXE and
# Linux test cases.  See the README file for information on setting up
# the DHCP server.
# Syntax is DOMUMACADDRS=<mac address 1>[:<mac address2>:...]
DOMUMACADDRS=

# -----------------------------------------------------------------------------
# OPTIONAL ARGUMENTS
# -----------------------------------------------------------------------------

# SYSIDCFG is the full path to a valid sysidcfg for the network the
# dom0 is on.  If omitted, the test suite will use
# etc/default.sysidcfg which is specific for the BRM network.  Please
# see the main README file for setting up a sysidcfg for your network.
# SYSIDCFG=

# LINUXISO is the path to a valid RHEL 5.0 (or newer) ISO image.  It
# can be either 32 or 64 bit.  If this argument is commented out, the
# linux test case will not run.
# LINUXISO=

# PROFILE is which profile the guests should use when installing.
# Valid
# options are SUNWCXall and SUNWCreq.  If omitted, the suite will
# default to SUNWCreq for speed improvements.
# PROFILE=

# PXE=1 configures the pxe test case to run and requires specific
# actions to take on the local install server.  Please see the README
# for
# explanation of steps required.
# PXE=

# IFACE is the primary interface the test suite will use for guests.
# If omitted, the suite will select an "UP" interface from dladm
# show-link.
# IFACE=

# NFSROOT is the path to a directory on a remote server owned by the
# xvm user.
# Syntax is NFSROOT=/net/<remote machine>/<path>
# NFSROOT=

# NFSVDISKTYPE is the type of vdisk to create in the NFSROOT.
# NFSVDISKTYPE can be any one of vmdk, vdi, or vhd
# Syntax is NFSVDISKTYPE=[vmdk,vdi,vhd]
# NFSVDISKTYPE=

# NFSVDISKSPARSE is a boolean flag to create either a sparse or flat
# vdisk file of type NFSVDISKTYPE in NFSROOT.  NFSVDISKSPARSE can be
# either true (sparse) or false (flat).
# Syntax is NFSVDISKSPARSE=[true,false]
# NFSVDISKSPARSE=

# -----------------------------------------------------------------------------
# MAXIMUM ARGUMENTS
# -----------------------------------------------------------------------------

# Each MAX argument is the threshhold the system needs to have to
# execute the maxflags test case.  Lowering these values, allows the
# maxflags test case to run on a system with less resources than would
# normally be allowed (25gb of disk, 32gb of ram and 16 cpus is the
# default setting)

# MAXDISK is the overrideable amount of disk the dom0 needs to have
# (in MB).  NOTE:  This value has a lower bound of 20000.0 (20 gb)
# MAXDISK=

# MAXRAM is the overrideable amount of memory the dom0 needs to have
# (in MB).  NOTE:  This value has a lower bound of 4000 (4gb)
# MAXRAM=

# MAXVCPU is the overrideable number of cpus the dom0 needs to have.
# NOTE:  This value has a lower bound of 2 cpus
# MAXVCPU=
# -----------------------------------------------------------------------------

Indexes created Sun Nov 08 04:09:30 UTC 2009

Terms of Use | Privacy | Trademarks | Copyright Policy | Site Guidelines | Help
Your use of this web site or any of its content or software indicates your agreement to be bound by these Terms of Use.
Copyright © 1995-2008 Sun Microsystems, Inc.