Skip to content

Latest commit

 

History

History
157 lines (96 loc) · 7.51 KB

README.md

File metadata and controls

157 lines (96 loc) · 7.51 KB
Raw

Kitchen::Opennebula

A Test Kitchen Driver for Opennebula.

Requirements

This driver depends on BlackBerry patches to Fog (https://github.com/fog/fog) for better support for OpenNebula. These patches can be found at https://github.com/blackberry/fog until they are merged to upstream.

Installation and Setup

Please read the Driver usage page for more details.

Virtual Machine Requirements

This driver requires an OpenNebula OS image that conforms to a number of requirements

  • The VM puts the ssh key defined in the SSH_PUBLIC_KEY context variable into $HOME/.ssh/authorized_keys
  • The VM ensures the user has passwordless sudo access

Configuration

opennebula_endpoint

URL where the OpenNebula daemon is listening.
The default value is taken from the ONE_XMLRPC environment variable, or http://127.0.0.1:2633/RPC2 if unset.

oneauth_file

Path to the file containing OpenNebula authentication information. It should contain a single line stating "username:password". The default value is taken from the ONE_AUTH environment variable, or $HOME/.one/one_auth if unset.

template_name

Name of the VM definition file (OpenNebula template) registered with OpenNebula. Can be used with template_uname or template_uid to further restrict which template to use if multiple users have the same template name. Only one of template_name or template_id must be specified in the .kitchen.yml file. The default value is unset, or nil.

template_id

ID of the VM definition file (OpenNebula template) registered with OpenNebula. Only one of template_name or template_id must be specified in the .kitchen.yml file. The default value is unset, or nil.

template_uname

Username who owns the VM definition file (OpenNebula template). Can be used with template_name to address naming conflicts where multiple users have the same template name. The default value is unset, or nil.

template_uid

UID of the user who owns the VM definition file (OpenNebula template). Can be used with template_name to address naming conflicts where multiple users have the same template name. The default value is unset, or nil.

vm_hostname

Hostname to set for the newly created VM. The default value is driver.instance.name

public_key_path

Path to SSH public key to pass to the VM, to use to authenticate with username when logging in or converging a node. The default value is ~/.ssh/id_rsa.pub, ~/.ssh/id_dsa.pub, ~/.ssh/identity.pub, or ~/.ssh/id_ecdsa.pub, whichever is present on the filesystem.

username

This is the username used for SSH authentication to the new VM. The default value is local.

memory

The amount of memory to provision for the new VM. This parameter will override the memory settings provided in the VM template. The default value is 512MB.

user_variables

A hash of variables to pass into the "user template" section of the VM, to customize the virtual machine. The default value is {}.

context_variables

A hash of variables to pass into the "CONTEXT" section of the VM, to further customize the virtual machine. These variables override any existing context variables that are provided as part of the specified VM template. The default value is {}.

require_chef_omnibus

Determines whether or not a Chef Omnibus package will be installed. There are several different behaviors available:

  • true - the latest release will be installed. Subsequent converges will skip re-installing if chef is present.
  • latest - the latest release will be installed. Subsequent converges will always re-install even if chef is present.
  • <VERSION_STRING> (ex: 10.24.0) - the desired version string will be passed the the install.sh script. Subsequent converges will skip if the installed version and the desired version match.
  • false or nil - no chef is installed.

The default value is unset, or nil.

wait_for

This variable is used to override timeout for Fog's common wait_for method which states that it "takes a block and waits for either the block to return true for the object or for a timeout (defaults to 10 minutes)".

no_ssh_tcp_check

To avoid test-kitchen's ssh tcp check in the create phase you can set no_ssh_tcp_check to true and do single sleep instead. Sleep period is configured by no_ssh_tcp_check_sleep. The default for no_ssh_tcp_check is set to false.

no_ssh_tcp_check_sleep

This variable configures a single sleep used when no_ssh_tcp_check is set to true. The default for no_ssh_tcp_check is 2 minutes.

no_passwordless_sudo_check

To avoid test-kitchen's passwordless sudo check in the create phase you can set no_passwordless_sudo_check to true and do single sleep instead. Sleep period is configured by no_passwordless_sudo_sleep. The default for no_passwordless_sudo_check is set to false.

no_passwordless_sudo_sleep

This variable configures a single sleep used when no_passwordless_sudo_check is set to true. The default for no_passwordless_sudo_sleep is 2 minutes.

passwordless_sudo_timeout

This variable configures the max timeout will wait in the create phase for passwordless sudo to be setup. The variable is used when no_passwordless_sudo_check is set to false. The default for passwordless_sudo_timeout is 5 minutes.

passwordless_sudo_retry_interval

This variable configures retry interval in the create phase to periodically check that passwordless sudo is setup. It does this until max timeout (set by passwordless_sudo_timeout) is reached. The variable is used when no_passwordless_sudo_check is set to false. The default for passwordless_sudo_retry_interval is 10 seconds.

Development

Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Authors

Created and maintained by Andrew Brown (anbrown@blackberry.com)

License

Apache 2.0 (see LICENSE)