summaryrefslogtreecommitdiff
path: root/vmdb/plugins/copy_dir.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'vmdb/plugins/copy_dir.mdwn')
-rw-r--r--vmdb/plugins/copy_dir.mdwn23
1 files changed, 23 insertions, 0 deletions
diff --git a/vmdb/plugins/copy_dir.mdwn b/vmdb/plugins/copy_dir.mdwn
new file mode 100644
index 0000000..a21e580
--- /dev/null
+++ b/vmdb/plugins/copy_dir.mdwn
@@ -0,0 +1,23 @@
+Step: copy-dir
+-----------------------------------------------------------------------------
+
+Recursively copy a directory from outside into the target filesystem.
+
+Step keys:
+
+* `copy-dir` — REQUIRED; the full (starting from the new
+ filesystem root) path of directory to copy to. Any missing
+ directories will be created with the configured user and group ownership and
+ permissions. See the `perm`, `uid`, `gid`, `user` and `group` keys.
+* `src` — REQUIRED; the path of the directory to copy from on the host
+ filesystem, outside the chroot, relative to the current working directory of
+ the vmdb2 process.
+* `perm` — OPTIONAL; the permissions to apply to any missing parent
+ directories that are created on the target. The value of `umask` is applied
+ to this value.
+* `umask` — OPTIONAL; the numeric (octal) representation of umask to
+ apply to the permissions of copied files and directories. Defaults to 0022.
+* `uid` — OPTIONAL; the numeric user ID to assign to the copied files
+ and directories. Defaults to 0 (root).
+* `gid` — OPTIONAL; the numeric group ID to assign to the copied files
+ and directories. Defaults to 0 (root).