Plugin Development: Provisioners
This page documents how to add new provisioners to Vagrant, allowing Vagrant to automatically install software and configure software using a custom provisioner. Prior to reading this, you should be familiar with the plugin development basics.
Warning: Advanced Topic! Developing plugins is an advanced topic that only experienced Vagrant users who are reasonably comfortable with Ruby should approach.
Within the context of a plugin definition, new provisioners can be defined like so:
provisioner "custom" do require_relative "provisioner" Provisioner end
Provisioners are defined with the
provisioner method, which takes a
single argument specifying the name of the provisioner. This is the
name that used with
config.vm.provision when configuring and enabling
the provisioner. So in the case above, the provisioner would be enabled
The block argument then lazily loads and returns a class that implements
Vagrant.plugin(2, :provisioner) interface, which is covered next.
The provisioner class should subclass and implement
Vagrant.plugin(2, :provisioner) which is an upgrade-safe way to let
Vagrant return the proper parent class for provisioners.
This class and the methods that need to be implemented are very well documented. The documentation on the class in the comments should be enough to understand what needs to be done.
There are two main methods that need to be implemented: the
configure method and the
configure method is called early in the machine booting process
to allow the provisioner to define new configuration on the machine, such
as sharing folders, defining networks, etc. As an example, the
Chef solo provisioner
uses this to define shared folders.
provision method is called when the machine is booted and ready
for SSH connections. In this method, the provisioner should execute
any commands that need to be executed.