puppetlabs/vmpooler
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmpooler.git synced 2026-01-26 18:08:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation for new parameters to env config and file based config docs

Browse source
This commit is contained in:
kirby@puppetlabs.com 2020-05-12 08:38:14 -07:00
parent 141e972526
commit d936e20747
5 changed files with 84 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/dev-setup.md
View file

@ -1,13 +1,15 @@
# Setting up a vmpooler development environment
## Requirements
## Docker is the preferred development environment
The docker compose file is the easiest way to get vmpooler running with any local code changes. The docker compose file expects to find a vmpooler.yaml configuration file in the root vmpooler directory. The file is mapped into the running container for the vmpooler application. This file primarily contains the pools configuration. Nearly all other configuration can be supplied with environment variables.
## Requirements for local installation directly on your system (not recommended)
* Supported on OSX, Windows and Linux
* Ruby or JRuby
Note - Ruby 1.x support will be removed so it is best to use more modern ruby versions
Note - It is recommended to user Bundler instead of installing gems into the system repository
* A local Redis server