Properties

Common properties

Name	Description
{my-host-label}.hostname	Hostname. If is not set, overcast will try to create host (For Amazon hosts).

Tunneled properties

Name	Description
{my-host-label}.tunnel.username	Tunnel username
{my-host-label}.tunnel.password	Tunnel password
{my-host-label}.tunnel.ports	Tunnel ports. Comma separated.
{my-host-label}.tunnel.setupTimeout	Attempt to set up the tunnel for this many seconds, default 0.

Amazon EC2 properties

Name	Description
{my-host-label}.amiId	Amazon AMI id. E.g.:ami-c1724eb5
{my-host-label}.amiInstanceType	Instance type. E.g.: m1.small
{my-host-label}.amiSecurityGroup	AMI security group
{my-host-label}.amiKeyName	AMI key name
{my-host-label}.amiBootSeconds	How many seconds max do you expect AMI to boot
{my-host-label}.aws.endpoint	[Endpoint URL] (http://aws.amazon.com/articles/3912)
{my-host-label}.aws.accessKey	Access key
{my-host-label}.aws.secretKey	Secret key

Vagrant host properties

Name	Description
{my-host-label}.vagrantDir	Directory with Vagrantfile
{my-host-label}.vagrantIp	IP address of the Vagrant host
{my-host-label}.vagrantParameters	Additional parameters to pass for vagrant up command.
{my-host-label}.vagrantVm	Name of the Vagrant host
{my-host-label}.vagrantOs	OS type of the Vagrant host (WINDOWS, UNIX)
{my-host-label}.vagrantSnapshotExpirationCmd	Command used to expire the snapshot image of the Vagrant host, it will be executed in the vagrantDir.

For example, to pass additional parameters for vagrant up command, something like vagrant --param1=value1 --param2=value2 up

my-host-label {    vagrantParameters {        param1="value1"        param2="value2"    }}

VirtualBox host properties

Name	Description
{my-host-label}.vboxUuid	UUID of the virtual machine
{my-host-label}.vboxSnapshotUuid	UUID of the snapshot
{my-host-label}.vboxBoxIp	IP address of the virtual machine

Libvirt host properties

Name	Description
{my-host-label}.libvirtURL	URL of libvirt e.g. qemu+ssh://user@linux-box/system
{my-host-label}.libvirtStartTimeout	The libvirt domain must go into running state before this timeout (default: 30)
{my-host-label}.baseDomain	name of the domain to clone
{my-host-label}.network	name of the network device that should be used for IP to MAC lookup. For example br0.
{my-host-label}.ipLookupStrategy	name of a strategy used to figure out the IP of the clone, static or SSH.
{my-host-label}.static.ip	When ipLookupStrategy is static, the static IP the created host is expected to have.
{my-host-label}.SSH.url	URL for overthere to connect to the system that knows about the MAC to IP mapping. For instance: ssh://user@dhcpserver?os=UNIX&connectionType=SFTP&privateKeyFile=/home/user/.ssh/id_rsa&passphrase=bigsecret
{my-host-label}.SSH.command	command to execute on the system to lookup the IP. For example for dnsmasq: ```grep {0} /var/lib/misc/dnsmasq.leases
{my-host-label}.SSH.timeout	number of seconds to try the above command to find the IP.
{my-host-label}.provision.url	URL for overthere to connect to the created system. For instance: ssh://user@{0}?os=UNIX&connectionType=SCP&privateKeyFile="${user.home}"/.ssh/id_rsa&passphrase=bigsecret. {0} will be replaced by the IP the system got.
{my-host-label}.provision.bootDelay	Boot delay to use after the system has been provisioned.
{my-host-label}.provision.startTimeout	After the boot delay the copy and provision commands will be retried until this timeout expires. This allows for more robust startup when startup times vary, without configuring a big bootDelay.
{my-host-label}.provision.copy	Files/directories specified here will be copied to the system before provisioning. If the length of the list is even then files/directories are copied pair wise. If the length is odd then everything is copied into the last entry (which should be a directory).
{my-host-label}.provision.cmd	Command to run to provision the system.
{my-host-label}.provision.expirationTag.cmd	Command to run to determine the expiration tag of a cached provisioning operation. Runs locally in the current directory. If an overthere URL is specified it will run the command remotely.
{my-host-label}.provision.expirationTag.url	URL for overthere to connect to a machine hosting the scripts that were used to provision an image.
{my-host-label}.fsMapping.{target}.hostPath	upon cloning create a Filesystem mapping between hostPath and target in the host.
{my-host-label}.fsMapping.{target}.accessMode	Access mode, one of passthrough, mapped, squash (default: passthrough)
{my-host-label}.fsMapping.{target}.readOnly	Whether the mount will be readOnly (default: true)

Docker container properties

Name	Description
{my-host-label}.dockerHost	The hostname of the Docker Host. (default: http://localhost:2375). It can also be a unix socket: unix:///var/run/docker.sock.
{my-host-label}.certificates	The certificates to use when connecting to a HTTPS secured docker host. The directory must contain ca.pem, cert.pem and key.pem.
{my-host-label}.dockerImage	The Docker image that will be run. (required)
{my-host-label}.name	The name the container will get. Warning: Docker container names must be unique, even when the container is stopped. Use in combination with remove to make sure you can start a container with the same name again. Also not suitable for parallel testing. (default: random name defined by docker)
{my-host-label}.remove	Boolean. If true, the container will be removed during teardown. (default: false)
{my-host-label}.exposedPorts	List of ports to expose. Use in combination with exposeAllPorts. Must include the protocol. Currently only tcp is supported. For example: ["12345/tcp", "23456/tcp"].
{my-host-label}.exposeAllPorts	Boolean. If true, Docker will expose the ports defined by the Docker image (see EXPOSE), and additionally the ports defined in overcast property exposedPorts. (default: false)
{my-host-label}.command	Command to execute within the container. For example: ["/bin/sh", "-c", "while true; do echo hello world; sleep 1; done"]
{my-host-label}.env	Environment variables that will be exported in the container. For example: ["MYVAR1=AAA", "MYVAR2=BBB", "MYVAR3=CCC"].

VM Ware properties

Name	Default Value	Description
{my-host-label}.ignoreBadCertificate	false	This property can be useful during transitional period when on VM host not installed a valid certificate.
{my-host-label}.instanceClone	true	What type of clone to do. It is possible to do usual
{my-host-label}.maxRetries	15	How many times to retry in case of failure. For example when VM is spinning up and trying to get the IP address from it.
{my-host-label}.securityAlgorithm	TLS	It matters only when ignoreBadCertificate=true
{my-host-label}.vmBaseImage	None	The name of the image which will be cloned. The cloned image will have name as {base-imaage-name}-{8 alpha numeric characters}.
{my-host-label}.vmwareApiHost	None	The host where VMWare is running.
{my-host-label}.vmwareStartTimeout	180	Specified in seconds. It's a timeout for a REST client how long to wait for a reply.