949df52a26
Wrap plugin specific configs into has_plugin checks to avoid breakage when Vagrantfile is shared and/or plugin is removed (for testing/development).
105 lines
3.2 KiB
Markdown
105 lines
3.2 KiB
Markdown
# Usage
|
|
|
|
## Auto detect supported cache buckets
|
|
|
|
This is the easiest way to get started with plugin. By adding the code below to
|
|
your `Vagrantfile` you can enable automatic detection of supported cache _buckets_.
|
|
It is a good practise to wrap plugin specific configuration with `has_plugin?` checks
|
|
so the user's Vagrantfiles do not break if plugin is uninstalled or Vagrantfile shared
|
|
with people not having the plugin installed.
|
|
|
|
```ruby
|
|
Vagrant.configure("2") do |config|
|
|
# ...
|
|
if Vagrant.has_plugin?("vagrant-cachier")
|
|
config.cache.auto_detect = true
|
|
end
|
|
end
|
|
```
|
|
|
|
This will make vagrant-cachier do its best to find out what is supported on the
|
|
guest machine and will set buckets accordingly.
|
|
|
|
## Enable buckets as needed
|
|
|
|
If for whatever reason you need to have a fined grained control over what buckets
|
|
are configured, you can do so by "cherry picking" them on your `Vagrantfile`:
|
|
|
|
```ruby
|
|
Vagrant.configure("2") do |config|
|
|
config.cache.enable :apt
|
|
config.cache.enable :gem
|
|
end
|
|
```
|
|
|
|
_Please refer to the "Available Buckets" menu above to find out which buckets
|
|
are supported._
|
|
|
|
## Cache scope
|
|
|
|
By default downloaded packages will get stored on a folder scoped to base boxes
|
|
under your `$HOME/.vagrant.d/cache`. The idea is to leverage the cache by allowing
|
|
downloaded packages to be reused across projects. So, if your `Vagrantfile` has
|
|
something like:
|
|
|
|
```ruby
|
|
Vagrant.configure("2") do |config|
|
|
config.vm.box = 'some-box'
|
|
config.cache.auto_detect = true
|
|
end
|
|
```
|
|
|
|
The cached files will be stored under `$HOME/.vagrant.d/cache/some-box`.
|
|
|
|
If you are on a [multi VM environment](http://docs.vagrantup.com/v2/multi-machine/index.html),
|
|
there is a huge chance that you'll end up having issues by sharing the same bucket
|
|
across different machines. For example, if you `apt-get install` from two machines
|
|
at "almost the same time" you are probably going to hit a _"SystemError: Failed to
|
|
lock /var/cache/apt/archives/lock"_. To work around that, you can set the scope
|
|
to be based on machines:
|
|
|
|
```ruby
|
|
Vagrant.configure("2") do |config|
|
|
config.vm.box = 'some-box'
|
|
config.cache.scope = :machine
|
|
end
|
|
```
|
|
|
|
This will tell vagrant-cachier to download packages to `.vagrant/machines/<machine-name>/cache`
|
|
on your current project directory.
|
|
|
|
|
|
## Finding out disk space used by buckets
|
|
|
|
At some point we might implement a `vagrant cache stats` command that will give you that
|
|
information, but while that does not get implemented you can run the code below
|
|
if you are on a Linux machine:
|
|
|
|
```
|
|
# scope = :box (default)
|
|
$ du -h -d0 $HOME/.vagrant.d/cache
|
|
405M /home/user/.vagrant.d/cache/precise64
|
|
1.1G /home/user/.vagrant.d/cache/raring64
|
|
448M /home/user/.vagrant.d/cache/quantal64
|
|
|
|
# scope = :machine
|
|
$ du -h -d0 .vagrant/machines/*/cache
|
|
16K .vagrant/machines/precise/cache
|
|
90M .vagrant/machines/quantal/cache
|
|
210M .vagrant/machines/raring/cache
|
|
```
|
|
|
|
## Cleaning up cache buckets
|
|
|
|
At some point we might implement a `vagrant cache clean [bucket-name]` command that will
|
|
take care of things for you, but while that does not get implemented you can run
|
|
the code below if you are on a Linux machine:
|
|
|
|
```
|
|
# scope = :box (default)
|
|
$ rm -rf $HOME/.vagrant.d/cache/<box-name>/<optional-bucket-name>
|
|
|
|
# scope = :machine
|
|
$ rm -rf .vagrant/cache/<box-name>/<optional-bucket-name>
|
|
```
|