Vagrant MOS Provider

Gitter

Gem Version Dependency Status

This is a Vagrant 1.2+ plugin that adds an MOS provider to Vagrant, allowing Vagrant to control and provision machines in MOS.

NOTE: This plugin requires Vagrant 1.2+,

Features

  • Boot MOS instances.
  • SSH into the instances.
  • Provision the instances with any built-in Vagrant provisioner.
  • Minimal synced folder support via rsync.
  • Manage MOS machine's status through vagrant status.

Usage

Install using standard Vagrant 1.2+ plugin installation methods. After installing, vagrant up and specify the mos provider. An example is shown below.

$ vagrant plugin install vagrant-mos
...
$ vagrant up --provider=mos
...

Of course prior to doing this, you'll need to obtain an MOS-compatible box file for Vagrant.

Quick Start

After installing the plugin (instructions above), the quickest way to get started is to actually use a MOS box and specify all the details manually within a config.vm.provider block. So first, add the box using any name you want:

$ vagrant box add mos_box https://github.com/yangcs2009/vagrant-mos/raw/master/mos.box
...

And then make a Vagrantfile that looks like the following, filling in your information where necessary.

Vagrant.configure("2") do |config|
  config.vm.box = "mos_box"

  config.vm.provider :mos do |mos, override|
    mos.access_key_id = "YOUR KEY"
    mos.secret_access_key = "YOUR SECRET KEY"
    mos.secret_access_url = "YOUR MOS ACCESS URL"
    mos.keypair_name = "KEYPAIR NAME"

    mos.ami = "fa1026fe-c082-4ead-8458-802bf65ca64c"

    override.ssh.username = "root"
    override.ssh.private_key_path = "PATH TO YOUR PRIVATE KEY"
  end
end

And then run vagrant up --provider=mos.

This will start an Ubuntu 12.04 instance in the us-east-1 region within your account. And assuming your SSH information was filled in properly within your Vagrantfile, SSH and provisioning will work as well.

Note that normally a lot of this boilerplate is encoded within the box file, but the box file used for the quick start, the "dummy" box, has no preconfigured defaults.

If you have issues with SSH connecting, make sure that the instances are being launched with a security group that allows SSH access.

Box Format

Every provider in Vagrant must introduce a custom box format. This provider introduces mos boxes. You can view an example box in the example_box/ directory. That directory also contains instructions on how to build a box.

The box format is basically just the required metadata.json file along with a Vagrantfile that does default settings for the provider-specific configuration for this provider.

Configuration

This provider exposes quite a few provider-specific configuration options:

  • access_key_id - The access key for accessing MOS
  • ami - The image id to boot, such as "fa1026fe-c082-4ead-8458-802bf65ca64c"
  • instance_ready_timeout - The number of seconds to wait for the instance to become "ready" in MOS. Defaults to 120 seconds.
    • instance_name - The name of instance to be created, such as "ubuntu01". The default value of this if not specified is 'default'.
  • instance_type - The type of instance, such as "C1_M1". The default value of this if not specified is "C1_M2".
  • keypair_name - The name of the keypair to use to bootstrap images which support it.
  • secret_access_url - The accee url for accessing MOS
  • region - The region to start the instance in, such as "us-east-1"
  • secret_access_key - The secret access key for accessing MOS
  • use_iam_profile - If true, will use IAM profiles for credentials.

These can be set like typical provider-specific configuration:

Vagrant.configure("2") do |config|
  # ... other stuff

  config.vm.provider :mos do |mos|
    mos.access_key_id = "your_key"
    mos.secret_access_key = "your_secret"
    mos.secret_access_url = "your_access_url"
  end
end

In addition to the above top-level configs, you can use the region_config method to specify region-specific overrides within your Vagrantfile. Note that the top-level region config must always be specified to choose which region you want to actually use, however. This looks like this:

Vagrant.configure("2") do |config|
  # ... other stuff

  config.vm.provider :mos do |mos|
    mos.access_key_id = "foo"
    mos.secret_access_key = "bar"
    mos.region = "us-east-1"

    # Simple region config
    mos.region_config "us-east-1", :ami => "ami-12345678"

    # More comprehensive region config
    mos.region_config "us-west-2" do |region|
      region.ami = "ami-87654321"
      region.keypair_name = "company-west"
    end
  end
end

The region-specific configurations will override the top-level configurations when that region is used. They otherwise inherit the top-level configurations, as you would probably expect.

Networks

Networking features in the form of config.vm.network are not supported with vagrant-mos, currently. If any of these are specified, Vagrant will emit a warning, but will otherwise boot the MOS machine.

Synced Folders

There is minimal support for synced folders. Upon vagrant up, vagrant reload, and vagrant provision, the MOS provider will use rsync (if available) to uni-directionally sync the folder to the remote machine over SSH.

See Vagrant Synced folders: rsync

Development

To work on the vagrant-mos plugin, clone this repository out, and use Bundler to get the dependencies:

$ bundle

Once you have the dependencies, verify the unit tests pass with rake:

$ bundle exec rake

If those pass, you're ready to start developing the plugin. You can test the plugin without installing it into your Vagrant environment by just creating a Vagrantfile in the top level of this directory (it is gitignored) and add the following line to your Vagrantfile 

Vagrant.require_plugin "vagrant-mos"

Use bundler to execute Vagrant:

$ bundle exec vagrant up --provider=mos