vagrant-vsphere-ddns 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a19f218ad9a80e8502c8d0055e560c146407609
+  data.tar.gz: ad1b4de8e83023895691897eb3c7782c61e676dd
+SHA512:
+  metadata.gz: 39df719870d78d8202eee4bdd13d6d20eeaacfaeeb49e568007314842112f5f47860e629dbb62e520ee45c96640dd75e54c49250f5f8a9af023fa970c8c11c34
+  data.tar.gz: ff5755841aa2075b885784d2b47c835809cfb333f01c73cf08aba2ce3cb28e63f0d78d13245eb3482620fc57fef14d8e8ffcdd1bbf69dcaeee37e62265fa1388

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+.vagrant/*
+Vagrantfile
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-vsphere-ddns", path: "."
+end

data/README.md

@@ -0,0 +1,91 @@
+# Vagrant vSphere DDNS plugin
+
+This is a PoC [Vagrant](http://www.vagrantup.com) plugin that enables Vagrant to connect to vSphere VMs via dynamic domain names based on MAC addresses. 
+This trivial plugin enables SSH connection to VMs that do not have guest tools installed. 
+
+This plugin does not work out of the box and requires custom DHCP and DNS settings. 
+This configuration is however not implemented in the plugin itself and has to be performed manually in advance. 
+
+## Requirements
+
+* Vagrant
+* vagrant-vsphere plugin
+
+## Usage
+
+Plugin can be configured by following settings:
+ * `ddns.host`
+   * Hostname that will be used for SSH connections instead of guest IP address
+   * Patterns mac0, mac1, ... will be replaced by VMs MAC address
+ * `ddns.timeout`
+   * Defines how long the plugin will wait for successfull DNS resolution (default is 120 seconds)
+   
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = 'dummy-vsphere-box'
+  
+  config.ddns.host = "%{mac0}.local"
+  config.ddns.timeout = 120
+  
+  config.vm.provider :vsphere do |vsphere|
+    vsphere.host = 'HOST NAME OF YOUR VSPHERE INSTANCE'
+    vsphere.compute_resource_name = 'YOUR COMPUTE RESOURCE'
+    vsphere.resource_pool_name = 'YOUR RESOURCE POOL'
+    vsphere.template_name = '/PATH/TO/YOUR VM TEMPLATE'
+    vsphere.name = 'NEW VM NAME'
+    vsphere.user = 'YOUR VMWARE USER'
+    vsphere.password = 'YOUR VMWARE PASSWORD'
+  end
+end
+```
+
+After running `vagrant up --provider=vsphere` Vagrant will attempt to reach VM using specified domain name
+(e.g. `005056a44d89.local`) and fail if this it can not be resolved for 2 minutes. 
+
+## DHCP and DNS settings
+
+ * Allow dynamic DNS updates in Bind in `/etc/bind/named.conf.local`
+```bash
+...
+include "/etc/bind/ddns.key";
+
+zone ".local" {
+    type master;
+    forwarders {};
+	file "/var/lib/bind/db.local";
+    allow-update { key dhcpupdate; };
+};
+...
+```
+ * Execute [custom script](./scripts/dns_update.py) on DHCP events in `/etc/dhcp/dhcpd.conf`
+```bash
+...
+on commit {
+    execute("/etc/dhcp/dns_update.py", 
+        "--action", "commit", 
+        "--ip", binary-to-ascii(10, 8, ".", leased-address),
+        "--mac", binary-to-ascii(16, 8, ":", substring(hardware, 1, 6)),
+        "--zone", config-option domain-name,
+        "--key_file", "/etc/dhcp/ddns.key"
+    );
+}
+on release {
+    execute("/etc/dhcp/dns_update.py",
+        "--action", "release", 
+        "--ip", binary-to-ascii(10, 8, ".", leased-address),
+        "--mac", binary-to-ascii(16, 8, ":", substring(hardware, 1, 6)),
+        "--zone", config-option domain-name,
+        "--key_file", "/etc/dhcp/ddns.key"
+    );
+}
+on expiry {
+    execute("/etc/dhcp/dns_update.py", 
+        "--action", "expiry", 
+        "--ip", binary-to-ascii(10, 8, ".", leased-address),
+        "--mac", binary-to-ascii(16, 8, ":", substring(hardware, 1, 6)),
+        "--zone", config-option domain-name,
+        "--key_file", "/etc/dhcp/ddns.key"
+    );
+}
+...
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant-vsphere-ddns/action/get_ssh_info.rb

@@ -0,0 +1,46 @@
+require 'rbvmomi'
+require 'vSphere/util/vim_helpers'
+
+module VagrantPlugins
+    module VSphereDDNS
+        module Action
+            class GetSshInfo
+                include VagrantPlugins::VSphere::Util::VimHelpers
+
+                def initialize(app, env)
+                    @app = app
+                    @logger = Log4r::Logger.new("vagrant::vsphere-ddns::get_ssh_info")
+                end
+
+                def call(env)
+                    env[:machine_ssh_info] = get_ssh_info(env[:vSphere_connection], env[:machine])
+                    if !env[:machine_ssh_info].nil?
+                        @logger.info("SSH info: %s:%s" % [env[:machine_ssh_info][:host], env[:machine_ssh_info][:port]])
+                    end
+                    @app.call env
+                end
+                
+                private
+                
+                def get_ssh_info(connection, machine)
+                    return nil if machine.config.ddns.host.nil?
+                    return nil if machine.id.nil?                    
+                    vm = get_vm_by_uuid connection, machine
+                    return nil if vm.nil?
+                    
+                    format_data = {}
+                    vm.config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).each_with_index do |card, id| 
+                        break if card.nil?
+                        format_data["mac#{id}".to_sym] = (card.macAddress.scan /[a-f0-9]/).join
+                    end
+                    
+                    {
+                        host: machine.config.ddns.host % format_data,
+                        port: (machine.config.ssh.port.nil? ? 22 : machine.config.ssh.port)
+                    }
+                end
+                
+            end
+        end
+    end
+end

data/lib/vagrant-vsphere-ddns/action/wait_for_ip_address.rb

@@ -0,0 +1,43 @@
+require 'timeout'
+require 'log4r'
+require 'resolv'
+
+module VagrantPlugins
+    module VSphereDDNS
+        module Action
+            class WaitForIPAddress
+                def initialize(app, env)
+                    @app = app
+                    @logger = Log4r::Logger.new("vagrant::vsphere-ddns::wait_for_ip_address")
+                end
+
+                def call(env)
+                    timeout = env[:machine].config.ddns.ssh_timeout                        
+                    @logger.info("Trying to resolve #{env[:machine_ssh_info][:host]} (timeout #{timeout} seconds)")
+                    
+                    Timeout.timeout(timeout) do
+                        while true
+                            # If a ctrl-c came through, break out
+                            return if env[:interrupted]
+
+                            begin
+                                ip_address = Resolv.getaddress(env[:machine_ssh_info][:host])
+                                @logger.info("Host #{env[:machine_ssh_info][:host]} resolved to #{ip_address}")
+                                break
+                            rescue Resolv::ResolvError
+                                @logger.warn("Could not resolve: #{env[:machine_ssh_info][:host]}")
+                            end
+                            sleep 1
+                        end
+                    end
+                    return if env[:interrupted]
+                    @app.call(env)
+                    
+                rescue Timeout::Error
+                    raise Errors::IPAddrTimeout
+                end
+                
+            end
+        end
+    end
+end

data/lib/vagrant-vsphere-ddns/action.rb

@@ -0,0 +1,22 @@
+require 'vagrant'
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module VSphereDDNS
+    module Action
+      include Vagrant::Action::Builtin
+
+      def self.action_get_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use GetSshInfo
+          b.use WaitForIPAddress
+        end
+      end
+      
+      # autoload
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :GetSshInfo, action_root.join('get_ssh_info')
+      autoload :WaitForIPAddress, action_root.join("wait_for_ip_address")
+    end
+  end
+end

data/lib/vagrant-vsphere-ddns/config.rb

@@ -0,0 +1,24 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module VSphereDDNS
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :host
+      attr_accessor :ssh_timeout
+
+      def initialize
+        @host = UNSET_VALUE
+        @ssh_timeout = UNSET_VALUE
+      end
+      
+      def finalize!
+        @ssh_timeout = 120 if @ssh_timeout == UNSET_VALUE
+      end
+      
+      def validate(machine)
+        errors = _detected_errors
+        { 'vagrant-vsphere-ddns' => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-vsphere-ddns/errors.rb

@@ -0,0 +1,15 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module VSphereDNS
+    module Errors
+      class VSphereDDNSError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant-vsphere-ddns.errors")
+      end
+
+      class IPAddrTimeout < VSphereDDNSError
+        error_key(:ip_addr_timeout)
+      end
+    end
+  end
+end

data/lib/vagrant-vsphere-ddns/plugin.rb

@@ -0,0 +1,35 @@
+begin
+    require 'vagrant'
+rescue LoadError
+    raise 'The plugin must be run within Vagrant.'
+end
+
+module VagrantPlugins
+    module VSphereDDNS
+        class Plugin < Vagrant.plugin('2')
+            name 'vsphere-ddns'
+            description 'Enables Vagrant to connect to vSphere VMs via dynamic domain names based on MAC addresses'
+            
+            config(:ddns) do
+                require_relative 'config'
+                init!
+                Config
+            end
+            
+            action_hook :get_ssh_info, :machine_action_get_ssh_info do |hook|
+                require_relative 'action'
+                hook.after VagrantPlugins::VSphere::Action::GetSshInfo, VagrantPlugins::VSphereDDNS::Action::action_get_ssh_info
+            end
+            
+            protected
+            
+            def self.init!
+                return if defined?(@_init)
+                I18n.load_path << File.expand_path('locales/en.yml', VagrantPlugins::VSphereDDNS.source_root)
+                I18n.reload!
+                @_init = true
+            end
+            
+        end
+    end
+end

data/lib/vagrant-vsphere-ddns/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module VSphereDDNS
+    VERSION = '0.0.1'
+  end
+end

data/lib/vagrant-vsphere-ddns.rb

@@ -0,0 +1,17 @@
+require 'pathname'
+require 'vagrant-vsphere-ddns/plugin'
+
+module VagrantPlugins
+  module VSphereDDNS
+    lib_path = Pathname.new(File.expand_path('../vagrant-vsphere-ddns', __FILE__))
+    autoload :Action, lib_path.join('action')
+    autoload :Errors, lib_path.join('errors')
+    
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  vagrant-vsphere-ddns:
+    errors:
+      ip_addr_timeout: |-
+        Could not resolve host within timeout

data/scripts/dns_update.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import sys
+import argparse
+import logging
+import subprocess
+
+if __name__=='__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-d', '--debug', action='store_true', default=False)
+    parser.add_argument('-a','--action',  choices=('commit', 'release', 'expiry'), required=True)
+    parser.add_argument('-i','--ip',  required=True)
+    parser.add_argument('-m','--mac',  required=True)
+    parser.add_argument('--key_file',  required=True)
+    parser.add_argument('--server',  default='127.0.0.1')
+    parser.add_argument('--ttl', type=int, default=600)
+    parser.add_argument('--zone',  required=True)
+    
+    args = parser.parse_args()
+    logging.basicConfig(level=(logging.DEBUG if args.debug else logging.INFO), format='%(asctime)s %(levelname)-5.5s [%(name)s] %(message)s')    
+    logging.debug('arguments: %s' % sys.argv)
+        
+    mac = ''.join([format(int(x, 16), '02x') for x in args.mac.replace('-',':').split(':')])
+    
+    params = "server %s\nzone %s\n" % (args.server, args.zone)
+    if args.action == 'commit':        
+        params += "update add %s.%s %d IN A %s\n" % (mac, args.zone, args.ttl, args.ip)
+    else:
+        params += "update delete %s.%s. A\n" % (mac, args.zone)
+    if args.debug:
+        params += "show\n"
+    params += "send\n"
+    
+    logging.debug('nsupdate params: %s' % params)
+    ret = subprocess.call('/usr/bin/nsupdate -k %s -v << EOF\n%s\nEOF' % (args.key_file, params), shell=True)
+    logging.debug('nsupdate returned %d' % (ret))
+    sys.exit(ret)

data/vagrant-vsphere-ddns.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'vagrant-vsphere-ddns/version'
+
+Gem::Specification.new do |s|
+    s.name = 'vagrant-vsphere-ddns'
+    s.version = VagrantPlugins::VSphereDDNS::VERSION
+    s.authors = ['Tobias']
+    s.email = ['tsmolka@gmail.com']
+    s.homepage = 'https://github.com/tsmolka/vagrant-vsphere-ddns'
+    s.license = 'GPL-2.0'
+    s.summary = 'VMWare vSphere DDNS plugin'
+    s.description = 'Enables Vagrant to connect to vSphere VMs via dynamic domain names based on MAC addresses'
+    root_path      = File.dirname(__FILE__)
+    s.add_dependency 'vagrant-vsphere', '~> 1.9'
+
+    s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+    s.executables = s.files.grep(/^bin\//) { |f| File.basename(f) }
+    s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-vsphere-ddns
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tobias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vagrant-vsphere
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Enables Vagrant to connect to vSphere VMs via dynamic domain names based
+  on MAC addresses
+email:
+- tsmolka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/vagrant-vsphere-ddns.rb
+- lib/vagrant-vsphere-ddns/action.rb
+- lib/vagrant-vsphere-ddns/action/get_ssh_info.rb
+- lib/vagrant-vsphere-ddns/action/wait_for_ip_address.rb
+- lib/vagrant-vsphere-ddns/config.rb
+- lib/vagrant-vsphere-ddns/errors.rb
+- lib/vagrant-vsphere-ddns/plugin.rb
+- lib/vagrant-vsphere-ddns/version.rb
+- locales/en.yml
+- scripts/dns_update.py
+- vagrant-vsphere-ddns.gemspec
+homepage: https://github.com/tsmolka/vagrant-vsphere-ddns
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: VMWare vSphere DDNS plugin
+test_files: []