README.md in beaker-1.0.1 vs README.md in beaker-1.1.0
- old
+ new
@@ -80,11 +80,56 @@
In this case, the host 'ubuntu-1004-32' is now the Puppet Master, while 'ubuntu-1004-64' is the
Puppet Dashboard host, resulting in a split Master/Dashboard install. Systest will automagically
prepare an appropriate answers file for use with the PE Installer.
+## Required Host Settings ##
+To properly define a host you must provide:
+* name
+ * The string identifying this host
+* platform
+ * One of the Beaker supported platforms
+
+## Optional Host Settings ##
+Additionaly, Beaker supports the following host options:
+
+* ip
+ * the IP address of the SUT
+* hypervisor
+ * one of `solaris`, `blimpy`, `vsphere`, `fusion`, `aix`, `vcloud` or `vagrant`
+ * additional settings may be required depending on the selected hypervisor (ie, template, box, box_url, etc). Check the documentation below for your hypervisor for details
+* snapshot
+ * the name of the snapshot to revert to before testing
+* roles
+ * the 'job' of this host, an array of `master`, `agent`, `dashboard`, `database`, `default` or any user-defined string
+* pe_dir
+ * the directory where PE builds are located, may be local directory or a URL
+* pe_ver
+ * the version number of PE to install
+
+
+## Supported Platforms ##
+Beaker depends upon each host in the configuration file having a platform type that is correctly formatted and supported. The platform is used to determine how various operations are carried out internally (such as installing packages using the correct package manager for the given operating system).
+
+The platform's format is `/^OSFAMILY-VERSION-ARCH.*$/` where `OSFAMILY` is one of:
+
+* centos
+* fedora
+* debian
+* oracle
+* redhat
+* scientific
+* sles
+* ubuntu
+* windows
+* solaris
+* aix
+* el
+
+`VERSION`'s format is not enforced, but should reflect the `OSFAMILY` selected (ie, ubuntu-1204-i386-master, scientific-6-i386-agent, etc). `ARCH`'s format is also not enforced, but should be appropriate to the `OSFAMILY` selected (ie, ubuntu-1204-i386-master, sles-11-x86_64-master, debian-7-amd64-master, etc).
+
# Provisioning #
Systest has built in capabilites for managing VMs and provisioning SUTs:
* VMWare vSphere via the RbVmomi gem
* VMWare Fusion via the Fission gem
@@ -248,9 +293,17 @@
box: ubuntu-server-10044-x64-vbox4210
box_url: http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-10044-x64-vbox4210.box
CONFIG:
nfs_server: none
consoleport: 443
+
+VagrantFiles are created per host configuration file. They can be found in the `.vagrant/beaker_vagrant_files` directory of the current working directory in a subdirectory named after the host configuration file.
+
+ > beaker --hosts sample.cfg
+ > cd .vagrant/beaker_vagrant_files; ls
+ sample.cfg
+ > cd sample.cfg; ls
+ VagrantFile
# Putting it all together #
## Running FOSS tests ##
Puppet FOSS Acceptance tests are stored in their respective Puppet repository, so