From 47b12ac80772a11931e57cee7ea9d776ecf989bf Mon Sep 17 00:00:00 2001 From: Anders Ingemann Date: Sun, 23 Feb 2014 16:11:10 +0100 Subject: [PATCH] Adjust README to point at the documentation. Remove outdated CONTRIBUTING.md --- CONTRIBUTING.md | 12 ------------ README.md | 43 ++++++++++++++++--------------------------- 2 files changed, 16 insertions(+), 39 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index fb4a18a..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -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 diff --git a/README.md b/README.md index cb64e9f..7d0d12d 100644 --- a/README.md +++ b/README.md @@ -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 manifests +as well as supporting a high degree of customizability through plugins.
+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).