mount

[edit on GitHub]

Use the mount resource to manage a mounted file system.

Syntax

A mount resource block manages a mounted file system:

mount node['mysql']['ec2_path'] do
  device ebs_vol_dev
  fstype 'xfs'
  action :mount
end

The full syntax for all of the properties that are available to the mount resource is:

mount 'name' do
  device                     String
  device_type                Symbol
  domain                     String
  dump                       Integer, False
  enabled                    True, False
  fsck_device                String
  fstype                     String
  mount_point                String # defaults to 'name' if not specified
  mounted                    True, False
  notifies                   # see description
  options                    Array, String
  pass                       Integer, False
  password                   String
  subscribes                 # see description
  supports                   # see description
  username                   String
  action                     Symbol # defaults to :mount if not specified
end

where

  • mount is the resource
  • name is the name of the resource block
  • action identifies the steps the chef-client will take to bring the node into the desired state
  • device, device_type, domain, dump, enabled, fsck_device, fstype, mount_point, mounted, options, pass, password, supports, and username are properties of this resource, with the Ruby type shown. See “Properties” section below for more information about all of the properties that may be used with this resource.

Actions

This resource has the following actions:

:disable
Remove an entry from the file systems table (fstab).
:enable
Add an entry to the file systems table (fstab).
:mount
Default. Mount a device.
:nothing
Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the Chef Client run.
:remount
Remount a device.
:umount
Unmount a device.
:unmount

Alias for :umount action.

New in Chef Client 12.17.

Note

Order matters when passing multiple actions. For example: action [:mount, :enable] ensures that the file system is mounted before it is enabled.

Properties

This resource has the following properties:

device

Ruby Type: String

Required for :umount and :remount actions (for the purpose of checking the mount command output for presence). The special block device or remote node, a label, or a uuid to be mounted.

device_type

Ruby Type: Symbol

The type of device: :device, :label, or :uuid. Default value: :device.

domain

Ruby Type: String

Microsoft Windows only. Use to specify the domain in which the username and password are located.

dump

Ruby Types: Integer, False

The dump frequency (in days) used while creating a file systems table (fstab) entry. Default value: 0.

enabled

Ruby Types: True, False

Use to specify if a mounted file system is enabled. Default value: false.

fsck_device

Ruby Type: String

The fsck device on the Solaris platform. Default value: -.

New in Chef Client 12.0.

fstype

Ruby Type: String

Required. The file system type (fstype) of the device.

ignore_failure

Ruby Types: True, False

Continue running a recipe if a resource fails for any reason. Default value: false.

mount_point

Ruby Type: String

The directory (or path) in which the device is to be mounted. Default value: the name of the resource block See “Syntax” section above for more information.

mounted

Ruby Types: True, False

Use to specify if a file system is already mounted. Default value: false.

notifies

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may notify another resource to take action when its state changes. Specify a 'resource[name]', the :action that resource should take, and then the :timer for that action. A resource may notify more than one resource; use a notifies statement for each resource to be notified.

A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:

:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the very end of the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for notifies is:

notifies :action, 'resource[name]', :timer
options

Ruby Types: Array, String

An array or string that contains mount options. If this value is a string, it is converted to an array. Default value: defaults.

pass

Ruby Types: Integer, False

The pass number used by the file system check (fsck) command while creating a file systems table (fstab) entry. Default value: 2.

password

Ruby Type: String

Microsoft Windows only. Use to specify the password for username.

retries

Ruby Type: Integer

The number of times to catch exceptions and retry the resource. Default value: 0.

retry_delay

Ruby Type: Integer

The retry delay (in seconds). Default value: 2.

subscribes

Ruby Type: Symbol, ‘Chef::Resource[String]’

A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a 'resource[name]', the :action to be taken, and then the :timer for that action.

Note that subscribes does not apply the specified action to the resource that it listens to - for example:

file '/etc/nginx/ssl/example.crt' do
   mode '0600'
   owner 'root'
end

service 'nginx' do
   subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

In this case the subscribes property reloads the nginx service whenever its certificate file, located under /etc/nginx/ssl/example.crt, is updated. subscribes does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the :reload action for its resource (in this example nginx) when a change is detected.

A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:

:before
Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
Default. Specifies that a notification should be queued up, and then executed at the very end of the Chef Client run.
:immediate, :immediately
Specifies that a notification should be run immediately, per resource notified.

The syntax for subscribes is:

subscribes :action, 'resource[name]', :timer
supports

Ruby Type: Hash, Array

Specify a Hash of supported mount features. Default value: remount: false (preferred). Array defaults to remount: true (non-preferred).

username

Ruby Type: String

Microsoft Windows only. Use to specify the user name.

Examples

The following examples demonstrate various approaches for using resources in recipes. If you want to see examples of how Chef uses resources in recipes, take a closer look at the cookbooks that Chef authors and maintains: https://github.com/chef-cookbooks.

Mount a labeled file system

mount '/mnt/volume1' do
  device 'volume1'
  device_type :label
  fstype 'xfs'
  options 'rw'
end

Mount a local block drive

mount '/mnt/local' do
  device '/dev/sdb1'
  fstype 'ext3'
end

Mount a non-block file system

mount '/mount/tmp' do
  pass     0
  fstype   'tmpfs'
  device   '/dev/null'
  options  'nr_inodes=999k,mode=755,size=500m'
  action   [:mount, :enable]
end

Mount and add to the file systems table

mount '/export/www' do
  device 'nas1prod:/export/web_sites'
  fstype 'nfs'
  options 'rw'
  action [:mount, :enable]
end

Mount a remote file system

mount '/export/www' do
  device 'nas1prod:/export/web_sites'
  fstype 'nfs'
  options 'rw'
end

Mount a remote folder in Microsoft Windows

mount 'T:' do
  action :mount
  device '\\\\hostname.example.com\\folder'
end

Unmount a remote folder in Microsoft Windows

mount 'T:' do
  action :umount
  device '\\\\hostname.example.com\\D$'
end

Stop a service, do stuff, and then restart it

The following example shows how to use the execute, service, and mount resources together to ensure that a node running on Amazon EC2 is running MySQL. This example does the following:

  • Checks to see if the Amazon EC2 node has MySQL
  • If the node has MySQL, stops MySQL
  • Installs MySQL
  • Mounts the node
  • Restarts MySQL
# the following code sample comes from the ``server_ec2``
# recipe in the following cookbook:
# https://github.com/chef-cookbooks/mysql

if (node.attribute?('ec2') && ! FileTest.directory?(node['mysql']['ec2_path']))

  service 'mysql' do
    action :stop
  end

  execute 'install-mysql' do
    command "mv #{node['mysql']['data_dir']} #{node['mysql']['ec2_path']}"
    not_if do FileTest.directory?(node['mysql']['ec2_path']) end
  end

  [node['mysql']['ec2_path'], node['mysql']['data_dir']].each do |dir|
    directory dir do
      owner 'mysql'
      group 'mysql'
    end
  end

  mount node['mysql']['data_dir'] do
    device node['mysql']['ec2_path']
    fstype 'none'
    options 'bind,rw'
    action [:mount, :enable]
  end

  service 'mysql' do
    action :start
  end

end

where

  • the two service resources are used to stop, and then restart the MySQL service
  • the execute resource is used to install MySQL
  • the mount resource is used to mount the node and enable MySQL