mirror of
https://github.com/puppetlabs/vmpooler.git
synced 2026-01-26 01:58:41 -05:00
11dd15c7a8
This commit adds documentation for how to setup a development environment for VM Pooler. This commit also moves the API under the new docs directory and modifies the README appropriately.
107 lines
4 KiB
Markdown
107 lines
4 KiB
Markdown
|
|
|
|
# vmpooler
|
|
|
|
vmpooler provides configurable 'pools' of instantly-available (running) virtual machines.
|
|
|
|
|
|
## Usage
|
|
|
|
At [Puppet, Inc.](http://puppet.com) 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:
|
|
|
|
- [json](http://rubygems.org/gems/json)
|
|
- [rbvmomi](http://rubygems.org/gems/rbvmomi)
|
|
- [redis](http://rubygems.org/gems/redis)
|
|
- [sinatra](http://rubygems.org/gems/sinatra)
|
|
|
|
It also requires that a [Redis](http://redis.io/) 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:
|
|
|
|
```
|
|
---
|
|
:providers:
|
|
: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
|
|
provider: vsphere
|
|
- 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
|
|
provider: vsphere
|
|
```
|
|
|
|
See the provided YAML configuration example, [vmpooler.yaml.example](vmpooler.yaml.example), for additional configuration options and parameters.
|
|
|
|
### Running via Docker
|
|
|
|
A [Dockerfile](Dockerfile) is included in this repository to allow running vmpooler inside a Docker container. A `vmpooler.yaml` configuration file can be embedded in the current working directory, or specified inline in a `VMPOOLER_CONFIG` environment variable. To build and run:
|
|
|
|
```
|
|
docker build -t vmpooler . && docker run -e VMPOOLER_CONFIG -p 80:4567 -it vmpooler
|
|
```
|
|
|
|
## API and Dashboard
|
|
|
|
vmpooler provides an API and web front-end (dashboard) on port `:4567`. See the provided YAML configuration example, [vmpooler.yaml.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](docs/API.md) for more information.
|
|
|
|
### Dashboard
|
|
|
|
A dashboard is provided to offer real-time statistics and historical graphs. It looks like this:
|
|
|
|
|
|
|
|
[Graphite](http://graphite.wikidot.com/) is required for historical data retrieval. See the provided YAML configuration example, [vmpooler.yaml.example](vmpooler.yaml.example), for details.
|
|
|
|
## Command-line Utility
|
|
|
|
- The [vmpooler_client.py](https://github.com/puppetlabs/vmpooler-client) CLI utility provides easy access to the vmpooler service. The tool is cross-platform and written in Python.
|
|
- [vmfloaty](https://github.com/briancain/vmfloaty) is a ruby based CLI tool and scripting library written in ruby.
|
|
|
|
## Vagrant plugin
|
|
|
|
- [vagrant-vmpooler](https://github.com/briancain/vagrant-vmpooler) Use Vagrant to create and manage your vmpooler instances.
|
|
|
|
## Development and further documentation
|
|
|
|
For more information about setting up a development instance of vmpooler or other subjects, see the [docs/](docs) directory.
|
|
|
|
## Build status
|
|
|
|
[](https://travis-ci.org/puppetlabs/vmpooler)
|
|
|
|
|
|
## License
|
|
|
|
vmpooler is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). See the [LICENSE](LICENSE) file for more details.
|