vagrant-digitalocean 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef5c3f904718ef36fb85e42b715de9a9d5c5bdd6
-  data.tar.gz: bca0e6246c88e22102e4889c2d8eef34fee0a907
+  metadata.gz: 2d25d71a7736e890b2690c5f6da785e9ba9002de
+  data.tar.gz: 645d770371e722a0037bac2d3ef29860b7c9f6c7
 SHA512:
-  metadata.gz: faa1625fadc559371b3a3897caafa27e38f25ee37e0a44ff89dc6723fe90c08a35d37d759109b224cb8345dcfb954609be0bfe76db58db59d3e749b3a9ec1dac
-  data.tar.gz: 16396c4e94a5fac78991ef6fc610cd8a12aa7f9c00437a88629d5d567c023b4d2db00e0338d99862dc061c2e60343a1853e23e9b46e0d10e388b43256e26330a
+  metadata.gz: 879e4bb295023cc2fa52b8bda80f9b1ee774c62c6edfd5817a1fca8c24fa0ce538a603ad9f8a65ee43d0e620cf77f33315e153b6de32f2d2a31f929e4b3b2747
+  data.tar.gz: 9e6b1d61b080d828c2c593126a36ef3f3deea301e35de718f6e3b79ba89f6f2ab8ebdc5a0be68f2dca6090da53b20aeb227ae11507cc33d6ab743ec7ce4d9bf6

data/README.md

@@ -1,54 +1,28 @@
 Digital Ocean Vagrant Provider
 ==============================
-`vagrant-digitalocean` is a provider plugin for Vagrant that supports the
-management of [Digital Ocean](https://www.digitalocean.com/) droplets
-(instances).
+`vagrant-digitalocean` is a provider plugin for Vagrant that supports the management of [Digital Ocean](https://www.digitalocean.com/) droplets (instances).
 
-**NOTE:** The Chef provisioner is no longer supported by default (as of 0.2.0).
-Please use the `vagrant-omnibus` plugin to install Chef on Vagrant-managed
-machines. This plugin provides control over the specific version of Chef
-to install.
-
-Current features include:
+Features include:
 - create and destroy droplets
 - power on and off droplets
-- rebuild a droplet
-- provision a droplet with the shell or Chef provisioners
+- rebuild a droplet (destroys and ups with same IP address)
+- provision a droplet with shell
 - setup a SSH public key for authentication
 - create a new user account during droplet creation
 
-The provider has been tested with Vagrant 1.1.5+ using Ubuntu 12.04 and
-CentOS 6.3 guest operating systems.
+The provider has been tested with Vagrant 1.1.5+ using Ubuntu 12.04 and CentOS 6.3 guest operating systems.
+
 
 Install
 -------
-Installation of the provider requires two steps:
-
-1. Install the provider plugin using the Vagrant command-line interface:
-
-        $ vagrant plugin install vagrant-digitalocean
-
+Install the provider plugin using the Vagrant command-line interface:
 
-**NOTE:** If you are using a Mac, and this plugin would not work caused by SSL certificate problem,
-You may need to specify certificate path explicitly.  
-You can verify actual certificate path by running:
+`vagrant plugin install vagrant-digitalocean`
 
-```bash
-ruby -ropenssl -e "p OpenSSL::X509::DEFAULT_CERT_FILE"
-```
-
-Then, add the following environment variable to your
-`.bash_profile` script and `source` it:
-
-```bash
-export SSL_CERT_FILE=/usr/local/etc/openssl/cert.pem
-```
 
 Configure
 ---------
-Once the provider has been installed, you will need to configure your project
-to use it. The most basic `Vagrantfile` to create a droplet on Digital Ocean
-is shown below:
+Once the provider has been installed, you will need to configure your project to use it. The most basic `Vagrantfile` to create a droplet on Digital Ocean is shown below:
 
 ```ruby
 Vagrant.configure('2') do |config|
@@ -66,50 +40,35 @@ Vagrant.configure('2') do |config|
 end
 ```
 
-Please note the following:
-- You *must* specify the `override.ssh.private_key_path` to enable authentication
-  with the droplet. The provider will create a new Digital Ocean SSH key using
-  your public key which is assumed to be the `private_key_path` with a *.pub*
-  extension.
-- You *must* specify your Digital Ocean Personal Access Token. This may be
-  found on the control panel within the *Apps & API* section.
+**Configuration Requirements**
+- You *must* specify the `override.ssh.private_key_path` to enable authentication with the droplet. The provider will create a new Digital Ocean SSH key using your public key which is assumed to be the `private_key_path` with a *.pub* extension.
+- You *must* specify your Digital Ocean Personal Access Token at `provider.token`. This may be found on the control panel within the *Apps & API* section.
 
 **Supported Configuration Attributes**
 
 The following attributes are available to further configure the provider:
-- `provider.image` - A string representing the image to use when creating a new
-   droplet. It defaults to `ubuntu-14-04-x64`. List available images with the
-   `digitalocean-list images` command. Like when using the DigitalOcean API
-   directly, [it can be an image ID or slug](https://developers.digitalocean.com/documentation/v2/#create-a-new-droplet).
-- `provider.ipv6` - A boolean flag indicating whether to enable IPv6
-- `provider.region` - A string representing the region to create the new droplet in. It defaults to `nyc2`. List available regions with the `digitalocean-list regions` command.
-- `provider.size` - A string representing the size to use when creating a
-  new droplet (e.g. `1gb`). It defaults to `512mb`. List available sizes with the `digitalocean-list sizes` command.
-- `provider.private_networking` - A boolean flag indicating whether to enable
-  a private network interface (if the region supports private networking). It
-  defaults to `false`.
-- `provider.backups_enabled` - A boolean flag indicating whether to enable backups for
-   the droplet. It defaults to `false`.
-- `provider.ssh_key_name` - A string representing the name to use when creating
-  a Digital Ocean SSH key for droplet authentication. It defaults to `Vagrant`.
-- `provider.setup` - A boolean flag indicating whether to setup a new user
-  account and modify sudo to disable tty requirement. It defaults to `true`.
-  If you are using a tool like [packer](https://packer.io) to create
-  reusable snapshots with user accounts already provisioned, set to `false`.
-
-The provider will create a new user account with the specified SSH key for
-authorization if `config.ssh.username` is set and the `provider.setup`
-attribute is `true`.
-
-### image, region and size slugs
-
-Images, regions and sizes have to be specified with the slug name. You can find the slug names with the `digitalocean-list` commands:
+- `provider.image`
+    * A string representing the image to use when creating a new droplet. It defaults to `ubuntu-14-04-x64`.
+    List available images with the `digitalocean-list images $DIGITAL_OCEAN_TOKEN` command. Like when using the DigitalOcean API directly, [it can be an image ID or slug](https://developers.digitalocean.com/documentation/v2/#create-a-new-droplet).
+- `provider.ipv6`
+    * A boolean flag indicating whether to enable IPv6
+- `provider.region`
+    * A string representing the region to create the new droplet in. It defaults to `nyc2`. List available regions with the `digitalocean-list regions $DIGITAL_OCEAN_TOKEN` command.
+- `provider.size`
+    * A string representing the size to use when creating a new droplet (e.g. `1gb`). It defaults to `512mb`. List available sizes with the `digitalocean-list sizes $DIGITAL_OCEAN_TOKEN` command.
+- `provider.private_networking`
+    * A boolean flag indicating whether to enable a private network interface (if the region supports private networking). It defaults to `false`.
+- `provider.backups_enabled`
+    * A boolean flag indicating whether to enable backups for the droplet. It defaults to `false`.
+- `provider.ssh_key_name`
+    * A string representing the name to use when creating a Digital Ocean SSH key for droplet authentication. It defaults to `Vagrant`.
+- `provider.setup`
+    * A boolean flag indicating whether to setup a new user account and modify sudo to disable tty requirement. It defaults to `true`. If you are using a tool like [Packer](https://packer.io) to create reusable snapshots with user accounts already provisioned, set to `false`.
+- `config.vm.synced_folder`
+    * Supports both rsync__args and rsync__exclude, see the [Vagrant Docs](http://docs.vagrantup.com/v2/synced-folders/rsync.html) for more information. rsync__args default to `["--verbose", "--archive", "--delete", "-z", "--copy-links"]` and rsync__exclude defaults to `[".vagrant/"]`.
+
+The provider will create a new user account with the specified SSH key for authorization if `config.ssh.username` is set and the `provider.setup` attribute is `true`.
 
-```
-vagrant digitalocean-list images $DIGITAL_OCEAN_TOKEN
-vagrant digitalocean-list regions $DIGITAL_OCEAN_TOKEN
-vagrant digitalocean-list sizes $DIGITAL_OCEAN_TOKEN
-```
 
 Run
 ---
@@ -126,28 +85,57 @@ create a new user account, and run the provisioners you have configured.
 
 The provider supports the following Vagrant sub-commands:
 - `vagrant destroy` - Destroys the droplet instance.
-- `vagrant ssh` - Logs into the droplet instance using the configured user
-  account.
+- `vagrant ssh` - Logs into the droplet instance using the configured user account.
 - `vagrant halt` - Powers off the droplet instance.
-- `vagrant provision` - Runs the configured provisioners and rsyncs any
-  specified `config.vm.synced_folder`.
+- `vagrant provision` - Runs the configured provisioners and rsyncs any specified `config.vm.synced_folder`.
 - `vagrant reload` - Reboots the droplet instance.
-- `vagrant rebuild` - Destroys the droplet instance and recreates it with the
-  same IP address which was previously assigned.
-- `vagrant status` - Outputs the status (active, off, not created) for the
-  droplet instance.
+- `vagrant rebuild` - Destroys the droplet instance and recreates it with the same IP address which was previously assigned.
+- `vagrant status` - Outputs the status (active, off, not created) for the droplet instance.
 
-Contribute
-----------
-To contribute, clone the repository, and use [Bundler](http://gembundler.com)
-to install dependencies:
 
-    $ bundle
+Troubleshooting
+---------------
 
-To run the provider's tests:
+* `vagrant plugin install vagrant-digitalocean` 
+    * Installation on OS X may not working due to a SSL certificate problem, and you may need to specify a certificate path explicitly. To do so, run `ruby -ropenssl -e "p OpenSSL::X509::DEFAULT_CERT_FILE"`. Then, add the following environment variable to your `.bash_profile` script and `source` it: `export SSL_CERT_FILE=/usr/local/etc/openssl/cert.pem`.
 
-    $ bundle exec rake test
 
-You can now make modifications. Running `vagrant` within the Bundler
-environment will ensure that plugins installed in your Vagrant
-environment are not loaded.
+FAQ
+---
+
+* The Chef provisioner is no longer supported by default (as of 0.2.0). Please use the `vagrant-omnibus` plugin to install Chef on Vagrant-managed machines. This plugin provides control over the specific version of Chef to install.
+
+
+Contribute
+----------
+To contribute, fork then clone the repository, and then the following:
+
+**Developing**
+
+1. Install [Bundler](http://bundler.io/)
+2. Currently the Bundler version is locked to 1.7.9, please install this version.
+    * `sudo gem install bundler -v '1.7.9'`
+3. Then install vagrant-digitalocean dependancies:
+    * `bundle _1.7.9_ install`
+4. Do your development and run a few commands, one to get started would be:
+    * `bundle _1.7.9_ exec vagrant digitalocean-list images`
+5. You can then run a test:
+    * `bundle _1.7.9_ exec rake test`
+6. Once you are satisfied with your changes, please submit a pull request.
+
+**Releasing**
+
+To release a new version of vagrant-digitalocean you will need to do the following:
+
+*(only contributors of the GitHub repo and owners of the project at RubyGems will have rights to do this)*
+
+1. First, create a tag and push:
+    * `git tag -a v0.7.6 -m 'v0.7.6'`
+2. Then, create a release on Github with the same versioning convention:
+    * https://github.com/smdahlen/vagrant-digitalocean/releases
+3. You will then need to build and push the new gem to RubyGems:
+    * `rake gem:build`
+    * `gem push pkg/vagrant-digitalocean-0.7.6.gem`
+4. Then, when John Doe runs the following, they will receive the updated vagrant-digitalocean plugin:
+    * `vagrant plugin update`
+    * `vagrant plugin update vagrant-digitalocean`

data/lib/vagrant-digitalocean/actions/sync_folders.rb

@@ -52,14 +52,16 @@ module VagrantPlugins
             key = ssh_info[:private_key_path]
             key = key[0] if key.is_a?(Array)
 
-            # build exclude rules
+            # attach to vagrant's default rsync opetions
             # http://docs.vagrantup.com/v2/synced-folders/rsync.html
-            excludes = ['.vagrant/', *Array(data[:rsync_excludes])]
+            args = ["--verbose", "--archive", "--delete", "-z", "--copy-links", *Array(data[:rsync__args])]
+            exclude = [".vagrant/", *Array(data[:rsync__exclude])]
 
             # rsync over to the guest path using the ssh info
             command = [
-              "rsync", "--verbose", "--archive", "--delete", "-z", "--copy-links",
-              *excludes.map{|e|['--exclude', e]}.flatten,
+              "rsync",
+              *args.map{|e|[e]}.flatten,
+              *exclude.map{|e|["--exclude", e]}.flatten,
               "-e", "ssh -p #{ssh_info[:port]} -o StrictHostKeyChecking=no -i '#{key}'",
               hostpath,
               "#{ssh_info[:username]}@#{ssh_info[:host]}:#{guestpath}"]

data/lib/vagrant-digitalocean/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module DigitalOcean
-    VERSION = '0.7.6'
+    VERSION = '0.7.7'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-digitalocean
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - John Bender
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday