This document is the Software Manual for EC2Stack. The Software user manual instructs how to install and use the EC2Stack from a developer's perspective.
This document covers the use for the following users of EC2Stack:
This software user manual applies to EC2Stack, version 0.5.
The purpose of the software user manual is to assist:
Section 2 includes information for a developer. This covers installation for development purposes, git repository location, test execution and the automated vagrant development environment.
The latest version of the EC2Stack code base can be found on github at https://github.com/apache/cloudstack-ec2stack
To clone the repository execute the following command:
$ git clone email@example.com:apache/cloudstack-ec2stack.git
For developing EC2Stack it is recommended to run it in development mode. To do so install it using the following command:
$ python setup.py develop
EC2Stack will still need to be configured, this can be done so by executing ec2stack-configure as outlined in section 2 of this document.
You can start gstack in debug mode using the optional -d or --debug flag
$ ec2stack -d True
To run the included tests the following software is required:
These can be installed via the Python Package Index:
$ pip install pep8 pylint nose mock coverage factory-boy==1.3.0
Tests can be executed from the root of the code base as follows:
$ pep8 --ignore=E501 *.py ec2stack
$ pylint --rcfile=pylint.rc *.py ec2stack
$ nosetests --with-coverage --cover-erase --cover-package=ec2stack --cover-html
A HTML base coverage report will be placed in ./cover
Within the code base there is a VagrantFile and Puppet Manifests. Assuming you have vagrant installed and configured you can execute vagrant up.
This will bring up a new virtual machine configure with all necessary tools for development and the code base located at /vagrant``