Chef cookbook for NFS
Switch branches/tags
Nothing to show
Pull request Compare This branch is 271 commits behind atomic-penguin:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Installs and configures NFS client, or server components


Should work on any Red Hat-family or Debian-family Linux distribution.


  • nfs['packages']

    • Makes a best effort to choose NFS client packages dependent on platform
    • NFS server package needs to be hardcoded for Debian/Ubuntu in the server recipe, or overridden in a role.
  • nfs['service']

    • portmap - the portmap or rpcbind service depending on platform
    • lock - the statd or nfslock service depending on platform
    • server - the server component, nfs or nfs-kernel-server depending on platform
  • nfs['config']

    • client_templates - templates to iterate through on client systems, chosen by platform
    • server_template - server specific template, chosen by platform
  • nfs['port']

    • ['statd'] = Listen port for statd, default 32765
    • ['statd_out'] = Outgoing port for statd, default 32766
    • ['mountd'] = Listen port for mountd, default 32767
    • ['lockd'] = Listen port for lockd, default 32768
  • nfs['exports']

    • An array of strings to populate in an export file. Can be manipulated in recipes with the nfs_export LWRP.


To install the NFS components for a client system, simply add nfs to the run_list.

name "base"
description "Role applied to all systems"
run_list => [ "nfs" ]

Then in an nfs_server.rb role that is applied to NFS servers:

name "nfs_server"
description "Role applied to the system that should be an NFS server."
  "nfs" => {
    "packages" => [ "portmap", "nfs-common", "nfs-kernel-server" ],
    "ports" => {
      "statd" => 32765,
      "statd_out" => 32766,
      "mountd" => 32767,
      "lockd" => 32768
    "exports" => [
run_list => [ "nfs::server" ]

nfs_export LWRP Usage

Applications or other cookbooks can use the nfs_export LWRP to add exports:

nfs_export "/exports" do
  network ''
  writeable false 
  sync true
  options ['no_root_squash']

The default parameters for the nfs_export LWRP are as follows

  • directory

    • directory you wish to export
    • defaults to resource name
  • network

    • a CIDR, IP address, or wildcard (*)
    • requires an option
  • writeable

    • ro/rw export option
    • defaults to false
  • sync

    • synchronous/asynchronous export option
    • defaults to true
  • options

    • additional export options as an array, excluding the parameterized sync/async and ro/rw options
    • defaults to root_squash

License and Author

Author: Eric G. Wolfe ( Contributors: Riot Games

Copyright 2011-2012, Eric G. Wolfe Copyright 2012, Riot Games

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

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. See the License for the specific language governing permissions and limitations under the License.