README.md in landrush-0.4.0 vs README.md in landrush-0.4.1

- old
+ new

@@ -14,42 +14,49 @@ $ vagrant plugin install landrush ## Usage +### Get started + Enable the plugin in your `Vagrantfile`: config.landrush.enable -Bring up a machine that has a private network IP address and a hostname (see the `Vagrantfile` for an example) +Bring up a machine that has a private network IP address and a hostname (see the `Vagrantfile` for an example) $ vagrant up And you should be able to get your hostname from your host: $ dig -p 10053 @localhost myhost.vagrant.dev - + If you shut down your guest, the entries associated with it will be removed. + +### Static entries + You can add static host entries to the DNS server in your `Vagrantfile` like so: config.landrush.host 'myhost.example.com', '1.2.3.4' +This is great for overriding production services for nodes you might be testing locally. For example, perhaps you might want to override the hostname of your puppetmaster to point to a local vagrant box instead. + +### Unmatched Queries + Any DNS queries that do not match will be passed through to an upstream DNS server, so this will be able to serve as the one-stop shop for your guests' DNS needs. ### Visibility on the Guest Linux guests using iptables should automatically have their DNS traffic redirected properly to our DNS server. File an issue if this does not work for you. ### Visibility on the Host -I'm currently developing this on OS X 10.8, and there's a nice trick you can pull to unobtrusibly add a secondary DNS server only for specific domains. +If you're on an OS X host, we can use a nice trick to unobtrusibly add a secondary DNS server only for specific domains. -All you do is drop a file in `/etc/resolver/$DOMAIN` with information on how to connect to the DNS server you'd like to use for that domain. +If you name all of my vagrant servers with the pattern `$host.vagrant.dev` and then drop a file called `/etc/resolver/vagrant.dev` with these contents: -So what I do is name all of my vagrant servers with the pattern `$host.vagrant.dev` and then drop a file called `/etc/resolver/vagrant.dev` with these contents: - ``` # Use landrush server for this domain nameserver 127.0.0.1 port 10053 ``` @@ -60,17 +67,25 @@ domain : vagrant.dev nameserver[0] : 127.0.0.1 port : 10053 ``` - This gives us automatic access to the landrush hosts without having to worry about it getting in the way of our normal DNS config. +There's also a handy command to automate the creation of this file: + +``` +vagrant landrush install +``` + +### Additional CLI commands + +Check out `vagrant landrush` for additional commands to monitor the DNS server daemon. + ## Work in Progress - Lots to do! * The guest visibility strategy assumes iptables-based firewall. * Lots of static values that need configurin' - config location, ports, etc. -* VirtualBox only right now, need to support VMWare * Tests tests tests. ## Contributing 1. Fork it