Class: Vagrant::Action::VM::NFS

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant/action/vm/nfs.rb

Overview

Enables NFS based shared folders. nfsd must already be installed on the host machine, and NFS client must already be installed on the guest machine.

This is a two part process:

  1. Adds an entry to /etc/exports on the host machine using the host class to export the proper folder to the proper machine.
  2. After boot, runs mount on the guest to mount the shared folder.

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ NFS

Returns a new instance of NFS.



23
24
25
26
27
28
29
 
# File 'lib/vagrant/action/vm/nfs.rb', line 23

def initialize(app,env)
  @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
  @app = app
  @env = env

  verify_settings if nfs_enabled?
end

Instance Method Details

#call(env) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/vagrant/action/vm/nfs.rb', line 31

def call(env)
  @env = env

  extract_folders

  if !folders.empty?
    prepare_folders
    export_folders
  end

  @app.call(env)

  mount_folders if !folders.empty?
end

#export_folders ⇒ Object

Uses the host class to export the folders via NFS. This typically involves adding a line to /etc/exports for this VM, but it is up to the host class to define the specific behavior.



127
128
129
130
 
# File 'lib/vagrant/action/vm/nfs.rb', line 127

def export_folders
  @env[:ui].info I18n.t("vagrant.actions.vm.nfs.exporting")
  @env[:host].nfs_export(@env[:vm].uuid, guest_ip, folders)
end

#extract_folders ⇒ Object

Removes the NFS enabled shared folders from the configuration, so they will no longer be mounted by the actual shared folder task.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/vagrant/action/vm/nfs.rb', line 54

def extract_folders
  # Load the NFS enabled shared folders
  @folders = {}
  @env[:vm].config.vm.shared_folders.each do |key, opts|
    if opts[:nfs]
      # Duplicate the options, set the hostpath, and set disabled on the original
      # options so the ShareFolders middleware doesn't try to mount it.
      folder = opts.dup
      hostpath = Pathname.new(opts[:hostpath]).expand_path(@env[:root_path])

      if !hostpath.directory? && opts[:create]
        # Host path doesn't exist, so let's create it.
        @logger.debug("Host path doesn't exist, creating: #{hostpath}")

        begin
          FileUtils.mkpath(hostpath)
        rescue Errno::EACCES
          raise Errors::SharedFolderCreateFailed, :path => hostpath.to_s
        end
      end

      # Set the hostpath now that it exists.
      folder[:hostpath] = hostpath.to_s

      # Assign the folder to our instance variable for later use
      @folders[key] = folder

      # Disable the folder so that regular shared folders don't try to
      # mount it.
      opts[:disabled] = true
    end
  end
end

#folders ⇒ Object

Returns the folders which are to be synced via NFS.



47
48
49
 
# File 'lib/vagrant/action/vm/nfs.rb', line 47

def folders
  @folders ||= {}
end

#guest_ip ⇒ String

Returns the IP address of the guest by looking at the first enabled host only network.

Returns:

  • (String) 


168
169
170
171
172
173
174
175
176
 
# File 'lib/vagrant/action/vm/nfs.rb', line 168

def guest_ip
  @env[:vm].config.vm.networks.each do |type, args|
    if type == :hostonly && args[0].is_a?(String)
      return args[0]
    end
  end

  nil
end

#host_ip ⇒ String

Returns the IP address of the first host only network adapter

Returns:

  • (String) 


150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/vagrant/action/vm/nfs.rb', line 150

def host_ip
  @env[:vm].driver.read_network_interfaces.each do |adapter, opts|
    if opts[:type] == :hostonly
      @env[:vm].driver.read_host_only_interfaces.each do |interface|
        if interface[:name] == opts[:hostonly]
          return interface[:ip]
        end
      end
    end
  end

  nil
end

#mount_folders ⇒ Object

Uses the system class to mount the NFS folders.



133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/vagrant/action/vm/nfs.rb', line 133

def mount_folders
  @env[:ui].info I18n.t("vagrant.actions.vm.nfs.mounting")

  # Only mount the folders which have a guest path specified
  mount_folders = {}
  folders.each do |name, opts|
    if opts[:guestpath]
      mount_folders[name] = opts.dup
    end
  end

  @env[:vm].guest.mount_nfs(host_ip, mount_folders)
end

#nfs_enabled? ⇒ Boolean

Checks if there are any NFS enabled shared folders.

Returns:

  • (Boolean) 


179
180
181
182
183
184
185
 
# File 'lib/vagrant/action/vm/nfs.rb', line 179

def nfs_enabled?
  @env[:vm].config.vm.shared_folders.each do |key, opts|
    return true if opts[:nfs]
  end

  false
end

#prepare_folders ⇒ Object

Prepares the settings for the NFS folders, such as setting the options on the NFS folders.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/vagrant/action/vm/nfs.rb', line 90

def prepare_folders
  @folders = @folders.inject({}) do |acc, data|
    key, opts = data
    opts[:map_uid] = prepare_permission(:uid, opts)
    opts[:map_gid] = prepare_permission(:gid, opts)
    opts[:nfs_version] ||= 3

    # The poor man's UUID. An MD5 hash here is sufficient since
    # we need a 32 character "uuid" to represent the filesystem
    # of an export. Hashing the host path is safe because two of
    # the same host path will hash to the same fsid.
    opts[:uuid]    = Digest::MD5.hexdigest(opts[:hostpath])

    acc[key] = opts
    acc
  end
end

#prepare_permission(perm, opts) ⇒ Object

Prepares the UID/GID settings for a single folder.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/vagrant/action/vm/nfs.rb', line 109

def prepare_permission(perm, opts)
  key = "map_#{perm}".to_sym
  return nil if opts.has_key?(key) && opts[key].nil?

  # The options on the hash get priority, then the default
  # values
  value = opts.has_key?(key) ? opts[key] : @env[:vm].config.nfs.send(key)
  return value if value != :auto

  # Get UID/GID from folder if we've made it this far
  # (value == :auto)
  stat = File.stat(opts[:hostpath])
  return stat.send(perm)
end

#verify_settings ⇒ Object

Verifies that the host is set and supports NFS.

Raises:



188
189
190
191
192
 
# File 'lib/vagrant/action/vm/nfs.rb', line 188

def verify_settings
  raise Errors::NFSHostRequired if @env[:host].nil?
  raise Errors::NFSNotSupported if !@env[:host].nfs?
  raise Errors::NFSNoHostNetwork if !guest_ip
end