Provide configurable 'pools' of instantly-available (running) virtual machines
Find a file
kirby@puppetlabs.com 4faeb6a9ba (POOLER-44) Fix vmpooler.migrate reference
This commit updates vmpooler.migrate metric to send the pool name. Without this change the VM name is sent. Additionally, counts are added for migrate_from_#host and migrate_to_#host in order to allow tracking host migrations, and correlating them with CPU ready time changes.
2016-11-22 15:05:16 -08:00
lib (POOLER-44) Fix vmpooler.migrate reference 2016-11-22 15:05:16 -08:00
scripts Updated YAML config variables 2016-01-05 13:59:05 -06:00
spec (POOLER-26) Fix lost VMs getting stuck in pending 2016-11-22 10:23:16 -08:00
.gitignore Improved tests for vmpooler (#152) 2016-06-07 16:13:39 -05:00
.travis.yml (maint) Add a temporary shim to fix jruby travis build 2016-09-14 15:45:36 -07:00
API.md Merge CI.next into Master (#161) 2016-07-25 10:43:32 -05:00
Gemfile Update migration spec to call pool manager and validate results 2016-11-22 10:23:13 -08:00
LICENSE (maint) update README.md and LICENSE to reflect rebranding 2016-07-07 23:08:38 +00:00
Rakefile Show test contexts and names 2015-07-06 15:40:02 -07:00
README.md Add vagrant-vmpooler plugin to readme 2016-11-04 13:23:10 -07:00
vmpooler Merge CI.next into Master (#161) 2016-07-25 10:43:32 -05:00
vmpooler.yaml.example Add support for migrating VMs to pool_manager. 2016-11-08 16:32:10 -08:00

vmpooler

vmpooler

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

Usage

At Puppet, Inc. 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:

dashboard

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

Command-line Utility

  • The vmpooler_client.py CLI utility provides easy access to the vmpooler service. The tool is cross-platform and written in Python.
  • vmfloaty is a ruby based CLI tool and scripting library written in ruby.

Vagrant plugin

Build status

Build Status

License

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