summaryrefslogtreecommitdiff
path: root/puppet/modules/try/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'puppet/modules/try/README.md')
-rw-r--r--puppet/modules/try/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/puppet/modules/try/README.md b/puppet/modules/try/README.md
new file mode 100644
index 00000000..3888661e
--- /dev/null
+++ b/puppet/modules/try/README.md
@@ -0,0 +1,13 @@
+This module provides a "try" wrapper around common resource types.
+
+For example:
+
+ try::file {
+ '/path/to/file':
+ ensure => 'link',
+ target => $target;
+ }
+
+This will work just like `file`, but will silently fail if `$target` is undefined or the file does not exist.
+
+So far, only `file` type with symlinks works.