From de888c1b3cff446734050f4e61d0ac002aa8ee48 Mon Sep 17 00:00:00 2001 From: Nicolas Braud-Santoni Date: Mon, 29 Feb 2016 18:57:10 +0100 Subject: [PATCH] file_copy: Add documentation --- bootstrapvz/plugins/file_copy/README.rst | 26 ++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 bootstrapvz/plugins/file_copy/README.rst diff --git a/bootstrapvz/plugins/file_copy/README.rst b/bootstrapvz/plugins/file_copy/README.rst new file mode 100644 index 0000000..e45c12a --- /dev/null +++ b/bootstrapvz/plugins/file_copy/README.rst @@ -0,0 +1,26 @@ +File copy +--------- + +This plugin lets you copy files from the host to the VM under construction, + create directories, and set permissions and ownership. + +Note that this necessarily violates the `first development guideline`_. + +.. _first development guideline: https://github.com/andsens/bootstrap-vz/blob/master/CONTRIBUTING.rst#the-manifest-should-always-fully-describe-the-resulting-image + + +Settings +~~~~~~~~ + +The ``file_copy`` plugin takes a (non-empty) ``files`` list, and optionnaly a ``mkdirs`` list. + +Files (items in the ``files`` list) must be objects with the following properties: +* ``src`` and ``dst`` (required) are the source and destination paths. + ``src`` is relative to the current directory, whereas ``dst`` is a path in the VM. +* ``permissions`` (optional) is a permission string in a format appropriate for ``chmod(1)``. +* ``owner`` and ``group`` (optional) are respectively a user and group specification, + in a format appropriate for ``chown(1)`` and ``chgrp(1)``. + +Folders (items in the ``mkdirs`` list) must be objects with the following properties: +* ``dir`` (required) is the path of the directory. +* ``permissions``, ``owner`` and ``group`` are the same as for files.