jedi4ever/veewee — an open-source project — sits at 4.3k GitHub stars. Easing the building of vagrant boxes
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Veewee is a tool for easily (and repeatedly) building custom Vagrant base boxes, KVMs, and virtual machine images.
About Vagrant
Vagrant is a great tool for creating and configuring lightweight, reproducible, portable virtual machine environments - often used with the addition of automation tools such as Chef or Puppet.
The first step to build a new virtual machine is to download an existing 'base box'. I believe this scares a lot of people as they don't know how these unverified boxes were built. Therefore a lot of people end up building their own base box which is often time consuming and cumbersome. Veewee aims to automate all the steps for building base boxes and to collect best practices in a transparent way.
Veewee's Supported VM Providers
Veewee isn't only for Vagrant. It currently supports exporting VM images for the following providers:
VirtualBox - exports to OVF filetype
VMware (Fusion) - exports to OVA filetype
KVM - exports to IMG filetype
Parallels - none yet, but can export to parallels format (provided by vagrant-parallels)
Getting Started
Before you start, we recommend reading through these pages:
Requirements that must be met before installing Veewee
Veewee Installation instructions
Command Options highlights various approaches for executing Veewee on the command line
Customizing Definitions helps you fine tune each box definition to meet your exact needs
Veeweefile can be used to define your own paths
Then depending on how you want to use Veewee, we suggest to read through one of the following guides:
Guide for Vagrant
Guide for VirtualBox
Guide for VMware Fusion
Guide for KVM
Guide for Parallels Desktop
Major noteworthy changes between versions can be found here:
Changes between versions
A complete list of all docs can be found by viewing the doc directory.
Veewee Commands
Below is an overview of the veewee command options:
$ bundle exec veewee
# Commands:
# veewee add_share # Adds a Share to the Guest
# veewee fusion # Subcommand for Vmware fusion
# veewee help [COMMAND] # Describe available commands or one specific command
# veewee kvm # Subcommand for KVM
# veewee parallels # Subcommand for Parallels
# veewee vbox # Subcommand for VirtualBox
# veewee version # Prints the Veewee version information
Learn how to avoid typing bundle exec by visiting the Commands doc.
Veewee Provider Subcommands
Below is an overview of the veewee provider subcommand options:
$ bundle exec veewee <provider>
# Commands:
# veewee <provider> build [BOX_NAME] # Build box
# veewee <provider> copy [BOXNAME] [SRC] [DST] # Copy a file to the VM
# veewee <provider> define [BOXNAME] [TEMPLATE] # Define a new basebox starting from a template
# veewee <provider> destroy [BOXNAME] # Destroys the basebox that was built
# veewee <provider> halt [BOXNAME] # Activates a shutdown on the basebox
# veewee <provider> help [COMMAND] # Describe subcommands or one specific subcommand
# veewee <provider> list # Lists all defined boxes
# veewee <provider> ostypes # List the available Operating System types
# veewee <provider> screenshot [NAME] [PNGFILENAME] # Takes a screenshot of the box
# veewee <provider> ssh [BOXNAME] [COMMAND] # Interactive ssh login
# veewee <provider> templates # List the currently available templates
# veewee <provider> undefine [BOXNAME] # Removes the definition of a basebox
# veewee <provider> up [BOXNAME] # Starts a Box
# veewee <provider> validate [NAME] # Validates a box against vagrant compliancy rules
# veewee <provider> winrm [BOXNAME] [COMMAND] # Execute command via winrm
Contribute
People have reported good experiences, why don't you give it a try?
If you have a setup working, share your 'definition' with me. That would be fun!
Yes — jedi4ever/veewee ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/jedi4ever/veewee.
What is jedi4ever/veewee?
jedi4ever/veewee (jedi4ever/veewee) is a Shell project on GitHub. From the project's own README: Easing the building of vagrant boxes
Where do I read more about jedi4ever/veewee?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/jedi4ever/veewee is the definitive source.
Read full README in the tab above.
Still deciding about veewee?
One click hands the question to an AI along with this page — see what it says about veewee.