Vagrant plugin for automagically managing guest DNS
Ruby Shell
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test/example
Gemfile
LICENSE
NOTICE
README.md
Rakefile
vagrant-autodns.gemspec

README.md

Vagrant::Autodns

Vagrant plugin for automagically managing guest DNS. It uses a local DNS daemon (RubyDNS) that stores DNS entries in a SQLite database.

It has been designed not to run as root. To be able to do that, Vagrant::AutoDNS creates an iptable rule on your guest machine to do DNS request forwardng between the 53 privileged port to the hosts 15353 unprivileged port.

##License

© 2014 LinkedIn Corp. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

##Requirements

You need sqlite3 gem and ruby 1.9.2 minimum to use this plugin

Installation

###Simple Install:

    $ vagrant plugin install vagrant-autodns

###Bundler Install: Add this to your application's Gemfile:

    $ cat > Gemfile <<EO_GEMFILE
    source 'https://rubygems.org'

    group :development do
      gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
    end

    group :plugins do
      gem 'vagrant-autodns'
    end
    EO_GEMFILE

And then execute:

    $ bundle install

###Development install: Or fork the vagrant-autodns code from: https://github.com/linkedin/vagrant-autodns

    $ git clone https://github.com/linkedin/vagrant-autodns
    $ cd autodns
    $ bundle install
    $ bundle exec gem build vagrant-autodns.gemspec
    $ sudo gem install --local vagrant-autodns-*.gem
    $ vagrant plugin install vagrant-autodns
    $ vagrant plugin list

Usage

Vagrant::AutoDNS runs automatically at machines creation. It starts the daemon if not started and adds a record to the DNS database.

Configuration

AutoDNS usage is configured in your Vagrantfile :

    # Require the plugin for this Vagrant instance
    Vagrant.require_plugin 'vagrant-autodns'

    Vagrant.configure(2) do |config|
      # Enable the plugin for this config
      # Internal DNS
      config.autodns.enable
      config.vm.network 'private_network', :type => :dhcp
    end

CLI

Display help :

    $ vagrant autodns help
    Usage: vagrant autodns <command> [<args>]

    Available subcommands:
         add
         clear
         delete
         list
         reload_all
         restart
         start
         status
         stop

    For help on any individual command run `vagrant autodns COMMAND -h`

Daemon management :

    $ vagrant autodns {start|stop|restart|status}

Add a record manually :

    $ vagrant autodns add <hostname> <ip> [vagrant_id]
    $ vagrant autodns add test.vagrant.dev 1.2.3.4

List all DNS entries :

    $ vagrant autodns list

Clear the DNS entries :

    $ vagrant autodns clear

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request