https://github.com/jimmycuadra/vagrant-sprinkle

A Sprinkle provisioner for Vagrant.
https://github.com/jimmycuadra/vagrant-sprinkle

sprinkle vagrant vagrant-provisioner

Last synced: 3 months ago
JSON representation

A Sprinkle provisioner for Vagrant.

• Host: GitHub
• URL: https://github.com/jimmycuadra/vagrant-sprinkle
• Owner: jimmycuadra
• Created: 2013-05-25T06:42:12.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-05-21T12:29:39.000Z (over 10 years ago)
• Last Synced: 2024-04-29T13:03:30.615Z (9 months ago)
• Topics: sprinkle, vagrant, vagrant-provisioner
• Language: Ruby
• Size: 164 KB
• Stars: 12
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vagrant-sprinkle

A [Vagrant](http://www.vagrantup.com/) plugin to provision virtual machines with [Sprinkle](https://github.com/sprinkle-tool/sprinkle).

## Installation

```

$ vagrant plugin install vagrant-sprinkle

```

## Usage

### In the Vagrantfile

Use `:sprinkle` as the provisioner in your Vagrantfile:

``` ruby

Vagrant.configure('2') do |config|

  config.vm.provision(:sprinkle) do |sprinkle|

    sprinkle.script = 'sprinkle.rb'

    sprinkle.cloud = true

  end

end

```

The only required option is `script`, which should be a relative path to your Sprinkle install script. An example `Vagrantfile` is provided in the root of the repository.

### In the Sprinkle script

Set the SSH options for deploy in accordance with the details provided by `vagrant ssh-config`:

``` ruby

deployment do

  delivery :capistrano do

    role :vagrant, "127.0.0.1"

    set :user, "vagrant"

    ssh_options[:keys] = ["#{ENV['HOME']}/.vagrant.d/insecure_private_key"]

    ssh_options[:port] = 2222

  end

end

```

An example `sprinkle.rb` is provided in the root of the repository.

## Options

The following options can be set on the `sprinkle` config object (the block parameter).

* **script** (String, required): Relative path to a Sprinkle script to run.

* **only** (String): Only run sprinkle policies for the specified role.

* **test** (Boolean): Process, but don't perform any actions.

* **verbose** (Boolean): Provide verbose output.

* **cloud** (Boolean): Show powder cloud, i.e. package hierarchy and installation order.

* **force** (Boolean): Force installation of all packages, even if already installed.

## License

[MIT](http://opensource.org/licenses/MIT)