cookbook 'nfs', '= 4.0.0'
nfs
(57) Versions
4.0.0
-
-
5.1.5
-
5.1.4
-
5.1.3
-
5.1.2
-
5.1.1
-
5.1.0
-
5.0.10
-
5.0.9
-
5.0.8
-
5.0.4
-
5.0.3
-
5.0.2
-
5.0.1
-
5.0.0
-
4.0.0
-
3.0.0
-
2.6.4
-
2.6.3
-
2.6.2
-
2.6.1
-
2.6.0
-
2.5.1
-
2.5.0
-
2.4.1
-
2.4.0
-
2.3.1
-
2.3.0
-
2.2.12
-
2.2.11
-
2.2.10
-
2.2.8
-
2.2.7
-
2.2.6
-
2.2.5
-
2.2.4
-
2.2.3
-
2.2.2
-
2.2.1
-
2.2.0
-
2.1.0
-
2.0.0
-
1.0.0
-
0.5.0
-
0.4.2
-
0.4.1
-
0.4.0
-
0.3.1
-
0.3.0
-
0.2.8
-
0.2.7
-
0.2.6
-
0.2.5
-
0.2.4
-
0.2.3
-
0.2.2
-
0.1.0
-
0.0.6
Follow51
- 5.1.5
- 5.1.4
- 5.1.3
- 5.1.2
- 5.1.1
- 5.1.0
- 5.0.10
- 5.0.9
- 5.0.8
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 4.0.0
- 3.0.0
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.1
- 2.6.0
- 2.5.1
- 2.5.0
- 2.4.1
- 2.4.0
- 2.3.1
- 2.3.0
- 2.2.12
- 2.2.11
- 2.2.10
- 2.2.8
- 2.2.7
- 2.2.6
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.0
- 2.0.0
- 1.0.0
- 0.5.0
- 0.4.2
- 0.4.1
- 0.4.0
- 0.3.1
- 0.3.0
- 0.2.8
- 0.2.7
- 0.2.6
- 0.2.5
- 0.2.4
- 0.2.3
- 0.2.2
- 0.1.0
- 0.0.6
Installs and configures NFS, and NFS exports
cookbook 'nfs', '= 4.0.0', :supermarket
knife supermarket install nfs
knife supermarket download nfs
NFS cookbook
Description
Installs and configures NFS client and server components
Requirements
Should work on any RHEL 7+, Debian 10+, Ubuntu 18.04+ distributions.
This cookbook depends on the line
cookbook
Attributes
-
nfs['packages']
- Case switch in attributes to choose NFS client packages dependent on platform.
-
nfs['service']
-
['config']
- only set on Debian/Ubuntu to work around loose systemd dependencies on this platform family - debian:nfs-config.service
-
['portmap']
- the rpcbind service - default:nfs-client.target
-
['lock']
- the rpc-statd service - default:nfs-client.target
, debian:rpc-statd.service
-
['server']
- the server component, - default:nfs-server.service
, debian:nfs-kernel-server.service
-
['idmap']
- the NFSv4 idmap component
-
-
nfs['config']
-
client_templates
- templates to iterate through on client systems, chosen by platform -
server_template
- Per-platform case switch in common nfs.erb template. This string should be set to where the main NFS server configuration file should be placed. -
idmap_template
- Path to idmapd.conf used innfs::client4
andnfs::server4
recipes.
-
nfs['threads']
- Number of nfsd threads to run. Default 8 on Linux, 24 on FreeBSD. Set to 0, to disable.-
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['v2']
,nfs['v3']
,nfs['v4']
- Set to
yes
orno
to turn on/off NFS protocol level v2, or v3. - Defaults to nil, deferring to the default behavior provided by running kernel.
- Set to
nfs['mountd_flags']
- BSD launch options for mountd.nfs['server_flags']
- BSD launch options for nfsd.-
nfs['idmap']
- Attributes specific to idmap template and service.
-
['domain']
- Domain for idmap service, defaults tonode['domain']
-
['pipefs_directory']
- platform-specific location ofPipefs-Directory
-
['user']
- effective user for idmap service, defaultnobody
. -
['group']
- effective group for idmap service, defaultnogroup
.
Usage
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." override_attributes( "nfs" => { "packages" => [ "portmap", "nfs-common", "nfs-kernel-server" ], "port" => { "statd" => 32765, "statd_out" => 32766, "mountd" => 32767, "lockd" => 32768 } } ) run_list [ "nfs::server" ]
nfs_export
resource Usage
Applications or other cookbooks can use the nfs_export
resource to add exports:
nfs_export "/exports" do network '10.0.0.0/8' writeable false sync true options ['no_root_squash'] end
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
- can be a string for a single address or an array of networks
-
writeable
- ro/rw export option
- defaults to false
-
sync
- synchronous/asynchronous export option
- defaults to true
-
anonuser
- user mapping for anonymous users
- the user's UID will be retrieved from /etc/passwd for the anonuid=x option
- defaults to nil (no mapping)
-
anongroup
- group mapping for anonymous users
- the group's GID will be retrieved from /etc/group for the anongid=x option
- defaults to nil (no mapping)
-
options
- additional export options as an array, excluding the parameterized sync/async, ro/rw options, and anoymous mappings
- defaults to
root_squash
nfs::default recipe
The default recipe installs and configures the common components for an NFS client, at an effective protocol level of
NFSv3. The Chef resource logic for this is in the nfs::_common
recipe, with platform-specific conditional defaults set
in the default attributes file.
nfs::client4 recipe
Includes the logic from nfs::_common
, and also configures and installs the idmap service to provide an effective
protocol level of NFSv4. Effectively the same as running both nfs::_common
and nfs::_idmap
.
nfs::server recipe
The server recipe includes the common client components from nfs::_common
. This also configures and installs the
platform-specific server services for an effective protocol level of NFSv3.
nfs::server4 recipe
This recipe includes the common client components from nfs::_common
. It also configures and installs the
platform-specific server services for an effective protocol level of NFSv4. Effectively the same as running
nfs::_common
and nfs::_idmap
and nfs::server
.
nfs::undo recipe
Does your freshly kickstarted/preseeded system come with NFS, when you didn't ask for NFS? This recipe inspired by the
annoyances cookbook, will run once to remove NFS from the system. Use a knife command to remove NFS components from your
system like so.
knife run_list add $NODE nfs::undo
License and Author
Author: Eric G. Wolfe (eric.wolfe@gmail.com)
Contributors: Riot Games, Sean O'Meara
Copyright 2011-2020, Eric G. Wolfe
Copyright 2014, Joe Rocklin
Copyright 2012, Riot Games
Copyright 2012, Sean O'Meara
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
http://www.apache.org/licenses/LICENSE-2.0
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.
Collaborator Number Metric
4.0.0 passed this metric
Contributing File Metric
4.0.0 passed this metric
Foodcritic Metric
4.0.0 passed this metric
No Binaries Metric
4.0.0 passed this metric
Testing File Metric
4.0.0 passed this metric
Version Tag Metric
4.0.0 passed this metric
4.0.0 passed this metric
4.0.0 passed this metric
Foodcritic Metric
4.0.0 passed this metric
No Binaries Metric
4.0.0 passed this metric
Testing File Metric
4.0.0 passed this metric
Version Tag Metric
4.0.0 passed this metric
4.0.0 passed this metric
4.0.0 passed this metric
Testing File Metric
4.0.0 passed this metric
Version Tag Metric
4.0.0 passed this metric
4.0.0 passed this metric
4.0.0 passed this metric