mirror of https://github.com/puppetlabs/vmpooler.git synced 2026-01-26 10:08:40 -05:00

Provide configurable 'pools' of instantly-available (running) virtual machines

Find a file

Scott Schneider 7d0f7254ae Disk-adding functionality for vsphere_helper lib This commit adds the following functions: - `add_disk`: the wrapper function to add a new disk to a VM Usage is: ```` add_disk(vmname, disksize, datastore) ```` `vmname` is the name of the VM to add the disk to, `disksize` is the disk size in MB, and `datastore` is the datastore on which to provision the new disk. `add_disk` required the addition of the following helper functions: - `find_device`: locate a device object in vSphere - `find_disk_controller`: find the disk controller used by a VM - `find_disk_devices`: find the disk devices used by a VM - `find_disk_unit_number`: find a free SCSI ID to assign to a new disk - `find_vmdks`: find names of VMDK disks attached to a VM		2016-01-14 10:35:22 -08:00
lib	Disk-adding functionality for vsphere_helper lib	2016-01-14 10:35:22 -08:00
scripts	Additional utility and reporting scripts	2015-08-07 14:52:24 -07:00
spec	Merge pull request #138 from sschneid/qeng_2807	2015-11-13 09:24:48 -08:00
.travis.yml	Use dep caching and containers	2015-07-07 12:52:55 -07:00
API.md	Don't require username/password authentication for GET /token/:token route	2015-11-04 13:19:15 -08:00
Gemfile	(QENG-2246) Add Travis CI	2015-07-06 11:24:31 -07:00
LICENSE	Update license copyright	2015-08-21 18:07:07 -07:00
Rakefile	Show test contexts and names	2015-07-06 15:40:02 -07:00
README.md	Description tweak	2015-08-19 16:24:58 -07:00
vmpooler	Auto-expire Redis metadata key via Redis EXPIRE	2015-04-07 11:01:37 -07:00
vmpooler.yaml.example	Allow pool 'alias' names	2015-11-05 11:51:53 -08:00

README.md

vmpooler

vmpooler provides configurable 'pools' of instantly-available (running) virtual machines.

Usage

At Puppet Labs we run acceptance tests on thousands of disposable VMs every day. Dynamic cloning of VM templates initially worked fine for this, but added several seconds to each test run and was unable to account for failed clone tasks. By pushing these operations to a backend service, we were able to both speed up tests and eliminate test failures due to underlying infrastructure failures.

Installation

Prerequisites

vmpooler requires the following Ruby gems be installed:

It also requires that a Redis server exists somewhere, as this is the datastore used for vmpooler's inventory and queueing services.

Configuration

The following YAML configuration sets up two pools, debian-7-i386 and debian-7-x86_64, which contain 5 running VMs each:

---
:vsphere:
  server: 'vsphere.company.com'
  username: 'vmpooler'
  password: 'swimsw1msw!m'

:redis:
  server: 'redis.company.com'

:config:
  logfile: '/var/log/vmpooler.log'

:pools:
  - name: 'debian-7-i386'
    template: 'Templates/debian-7-i386'
    folder: 'Pooled VMs/debian-7-i386'
    pool: 'Pooled VMs/debian-7-i386'
    datastore: 'vmstorage'
    size: 5
  - name: 'debian-7-x86_64'
    template: 'Templates/debian-7-x86_64'
    folder: 'Pooled VMs/debian-7-x86_64'
    pool: 'Pooled VMs/debian-7-x86_64'
    datastore: 'vmstorage'
    size: 5

See the provided YAML configuration example, vmpooler.yaml.example, for additional configuration options and parameters.

Template set-up

Template set-up is left as an exercise to the reader. Somehow, either via PXE, embedded bootstrap scripts, or some other method -- clones of VM templates need to be able to set their hostname, register themselves in your DNS, and be resolvable by the vmpooler application after completing the clone task and booting up.

API and Dashboard

vmpooler provides an API and web front-end (dashboard) on port :4567. See the provided YAML configuration example, vmpooler.yaml.example, to specify an alternative port to listen on.

API

vmpooler provides a REST API for VM management. See the API documentation for more information.

Dashboard

A dashboard is provided to offer real-time statistics and historical graphs. It looks like this:

Graphite is required for historical data retrieval. See the provided YAML configuration example, vmpooler.yaml.example, for details.

Build status

License

vmpooler is distributed under the Apache License, Version 2.0. See the LICENSE file for more details.