aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNan Liu <nan@puppetlabs.com>2012-06-25 13:43:26 -0700
committerNan Liu <nan@puppetlabs.com>2012-06-25 14:34:15 -0700
commit600754c8d841646c73df3e0fe5d4290e8ddfd37d (patch)
tree3ae144a5eaba9b35376c81d802a918f16c2b689f /README.md
parenta45261555e1b70fc041fc001b4d4c1d18693ccc1 (diff)
downloadpuppet-tftp-600754c8d841646c73df3e0fe5d4290e8ddfd37d.tar.gz
puppet-tftp-600754c8d841646c73df3e0fe5d4290e8ddfd37d.tar.bz2
Update documentation and README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/README.md b/README.md
index 9bd2000..d1c41c7 100644
--- a/README.md
+++ b/README.md
@@ -32,13 +32,16 @@ Example:
Parameters:
-* ensure: file type, default file.
-* recurse: file recurse, default false.
-* owner: file owner, default tftp.
-* group: file group. default tftp.
-* mode: file mode, default 0644 (puppet will change to 0755 for directories).
-* content: file content.
-* source: file source.
+* ensure: file type, default file.
+* owner: file owner, default tftp.
+* group: file group. default tftp.
+* mode: file mode, default 0644 (puppet will change to 0755 for directories).
+* content: file content.
+* source: file source, defaults to puppet:///module/${caller_module_name}/${name} for files without content.
+* recurse: directory recurse, default false.
+* purge: directory recurse and purge.
+* replace: replace directory with file or symlink, default undef,
+* recurselimit: directory recurse limit, default undef,
Example:
@@ -51,9 +54,14 @@ Example:
}
tftp::file { 'pxelinux.cfg/default':
- source => 'puppet:///modules/acme/default',
+ ensure => file,
+ source => 'puppet:///modules/acme/pxelinux.cfg/default',
}
+The last example can be abbreviated to the following if it's in the acme module:
+
+ tftp::file { 'pxelinux.cfg/default': }
+
## Example
1. tftp directories not in the OS package defaults should be managed as file resources.