kevinheyer/bootstrap-vz
1
0
Fork 0
mirror of https://github.com/kevingruesser/bootstrap-vz.git synced 2025-08-24 07:26:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adjust README to point at the documentation.

Browse source 
Remove outdated CONTRIBUTING.md
This commit is contained in:
Anders Ingemann 2014-02-23 16:11:10 +01:00
parent cb011dabf3
commit 47b12ac807
2 changed files with 16 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -1,12 +0,0 @@
# Coding standards #
* Specify the full path when invoking a command.
* Use long options whenever possible, this makes the commands invoked a lot easier to understand.
* Use tabs for indentation and spaces for alignment.
* Max line length is 110 chars.
* Multiple assignments may be aligned.
* Follow PEP8 with the exception of the following rules
* E101: Indenting with tabs and aligning with spaces
* E221: Alignment of assignments
* E241: Alignment of assignments
* E501: The line length is 110 characters not 80
* W191: We indent with tabs not spaces

43
README.md
View file

@ -1,31 +1,20 @@
bootstrap-vz
===========================================
bootstrap-vz is a fully automated bootstrapping tool for Debian.
It creates images for various virtualized platforms (at the moment: kvm, virtualbox, ec2).
The plugin architecture allows for heavy modification of standard behavior
(e.g. create a vagrant box, apply puppet manifests, run custom shell commands).
bootstrap-vz is a bootstrapping framework for Debian.
It is is specifically intended to bootstrap systems for virtualized environments.
It runs without any user intervention and generates ready-to-boot images for
[a number of virtualization platforms(http://andsens.github.io/bootstrap-vz/providers.html).
Its aim is to provide a reproducable bootstrapping process using <a href="manifest.html">manifests</a>
as well as supporting a high degree of customizability through plugins.<br/>
bootstrap-vz was coded from scratch in python once the bash scripts that were used in the
[build-debian-cloud](https://github.com/andsens/build-debian-cloud) bootstrapper reached their
limits.
At no time is the resulting image booted, meaning there are no latent logfiles
or bash_history files.
The bootstrapper runs on a single json manifest file which contains all configurable
parameters. This allows you to recreate the image whenever you like so you can create
an updated version of an existing image or create the same image in multiple EC2 regions.
Dependencies
------------
You will need to run debian wheezy with **python 2.7** and **debootstrap** installed.
Other depencies include:
* qemu-utils
* parted
* grub2
* euca2ools
* xfsprogs (If you want to use XFS as a filesystem)
Also the following python libraries are required:
* **boto** ([version 2.14.0 or higher](https://github.com/boto/boto))
* **jsonschema** ([version 2.0.0](https://pypi.python.org/pypi/jsonschema), only available through pip)
* **termcolor**
* **fysom**
Bootstrapping instance store AMIs requires **euca2ools** to be installed.
Documentation
-------------
The documentation for bootstrap-vz is available
at [andsens.github.io/bootstrap-vz](http://andsens.github.io/bootstrap-vz).
There, you can discover [what the dependencies](http://andsens.github.io/bootstrap-vz/#dependencies)
for a specific cloud provider are, [see the list of available plugins](http://andsens.github.io/bootstrap-vz/plugins.html)
and learn [how you create a manifest](http://andsens.github.io/bootstrap-vz/manifest.html).