How to Create a Simple Vagrant Plugin.
I have been searching all over the Internet to find how to create a vagrant plugin. Vagrant homepage has information on how to create a vagrant plugin, but I would like to give a real world example. The plugin I’m going to create is vagrant-ls which is inspired by vagrant-list.
How do you start
Vagrant that you installed already won’t work with local developing plugin. So, I recommend you to create a new gemset for your plugin. If you haven’t used RVM, I highly recommend you use it now. It’s awesome!.
Once you have RVM installed you can create a gemset using this command rvm gemset create vagrant-ls. Then rvm gemset use vagrant-ls (Just in case). I recommend you do this for each of your ruby project. It helps you separate your gems, and it won’t mess up with different versions of your gems. First thing that you have to install is Bundler gem install bundler. It’s because we will use Bundler to manage all of our dependencies. Then you can create Gemfile.
1 2 3 4 5 6 7 8 9
This is the most basic you would need for your plugin development. If you wonder what is group :plugins . Vagrant plugin has already explained that. This will load your local plugin automatically without doing bundle exec vagrant install plugin vagrant-ls which will not quite work anyway.
Then you can create your gemspec file. I name it vagrant-ls.gemspec
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
Then you crate Rakefile
1 2 3
Then you move on to create your plugin using this pattern.
1 2 3 4 5 6 7 8 9 10 11
I almost forget you need to create VERSION file for gemspec to get your version number
1 2 3 4 5 6
Then you create your plugin class, this will be the place where vagrant finds information about your plugin.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
This is where you will name your command.
1 2 3
Last one, this is where vagrant will know how to execute your plugin
1 2 3 4 5 6 7 8 9 10 11 12
I just run VBoxManage command to list all of the vms. Once you are done, you are ready to test your plugin.
You can run this command
. If everything is correct, it should list all of your vms with the name of your vms, so you know where you are you running all those vms.
Publish your gem
Now, it’s time to spread the love of your gem. You need to build your gem first. Remember the Rakefile? You can just run rake build
It will pack your gem to .pkg folder. Then you can just run
. That’s it you have your gem published. If you look for documentation for publishing your gem.
You can find my repository here. The reason I create this post is that, the plugin might evolve but this blog stays and it will be a good starting point for other people.