bootstrap-vz/bootstrapvz/plugins/file_copy
Anders Ingemann f62c8ade99 Convert indentation from tabs to spaces (4)
Up until now I didn't see the point of using spaces for indentation.
However, the previous commit (a18bec3) was quite eye opening.
Given that python is an indentation aware language, the amount of
mistakes that went unnoticed because tabs and spaces were used
at the same time (tabs for indentation and spaces for alignment)
were unacceptable.

E101,W191 have been re-enable in the tox flake8 checker and
the documentation has been modified accordingly.

The following files have been left as-is:
* bootstrapvz/common/assets/extlinux/extlinux.conf
* bootstrapvz/common/assets/init.d/expand-root
* bootstrapvz/common/assets/init.d/generate-ssh-hostkeys
* bootstrapvz/common/assets/init.d/squeeze/generate-ssh-hostkeys
* bootstrapvz/plugins/docker_daemon/assets/init.d/docker
* bootstrapvz/providers/ec2/assets/bin/growpart
* bootstrapvz/providers/ec2/assets/grub.d/40_custom
* bootstrapvz/providers/ec2/assets/init.d/ec2-get-credentials
* bootstrapvz/providers/ec2/assets/init.d/ec2-run-user-data
* docs/_static/taskoverview.coffee
* docs/_static/taskoverview.less
* tests/unit/subprocess.sh
2016-06-04 11:38:16 +02:00
..
__init__.py Convert indentation from tabs to spaces (4) 2016-06-04 11:38:16 +02:00
manifest-schema.yml file_copy: Fix manifest 2016-02-29 19:08:42 +01:00
README.rst file_copy: Fix documentation typo 2016-06-02 16:12:57 -07:00
tasks.py Convert indentation from tabs to spaces (4) 2016-06-04 11:38:16 +02:00

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 optionally 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.