Kashyap | prettified readme

This commit is contained in:
Kashyap Kopparam 2014-11-05 11:39:36 +05:30
parent 8032eda577
commit 0f884f437e
1 changed files with 20 additions and 30 deletions

View File

@ -18,9 +18,9 @@ as a hypervisor while continuing to be able to manage the existing private cloud
## Quick Setup Steps ## Quick Setup Steps
1. Go to <OpenStack Root Dir>/nova/nova/virt/ 1. `$ cd <openstack_root_dir>/nova/nova/virt/`
2. `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2` 2. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
3. Go to /etc/nova/nova.conf and make sure it contains the following, you might have the default and conductor section already, but add the ec2driver section:- 3. `$ vim /etc/nova/nova.conf # make sure it contains the following options in the respective sections`
[DEFAULT] [DEFAULT]
compute_driver=ec2.EC2Driver compute_driver=ec2.EC2Driver
@ -31,29 +31,21 @@ as a hypervisor while continuing to be able to manage the existing private cloud
[ec2driver] [ec2driver]
ec2_secret_access_key = <your_aws_secret_access_key> ec2_secret_access_key = <your_aws_secret_access_key>
ec2_access_key_id = <your_aws_access_key_id> ec2_access_key_id = <your_aws_access_key_id>
4. Now go to the ec2 directory that was cloned and edit the ec2driver_standard_config.py if required. 4. `ec2driver_standard_config.py` can be edited to configure the default AMI, AWS region and endpoints.
5. Restart the nova compute service. 5. Restart the nova-compute service. You are now all set cloud burst!
You are now all set cloud burst! ### What's supported!
Launch, Reboot, Terminate, Resize, Pause/Unpause*, Suspend/Resume*, Attach/Detach Volume, Snapshot
## What's supported!
Launch
Reboot
Terminate
Resize
Pause/Unpause*
Suspend/Resume*
Attach/Detach Volume
Snapshot
#For Contributors #For Contributors
###Instructions for Developer Environment setup ###Instructions for Developer Environment setup
1. Install git, Virtualbox and Vagrant and Clone this repository: `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git` 1. Install git, Virtualbox and Vagrant.
2. Run`vagrant up` from within the repository to create an Ubuntu virtualbox that will install devstack. This will take a couple minutes. 2. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
3. `vagrant ssh` to ssh into the new machine 3. `$ cd ec2/ && vagrant up` This will download the development environment from Vagrant clound and setup devstack.
4. Refer to Step 3 in Quick Setup to edit nova.conf 4. `$ vagrant ssh`
5. Restart nova 5. Edit nova.conf and add the ec2 configuration options, refer to step 3 in Quick setup guide.
6. Restart nova-compute
- `~/devstack/rejoin-stack.sh` - `~/devstack/rejoin-stack.sh`
- go to the nova-cpu screen (`ctrl+a`, `7`) - go to the nova-cpu screen (`ctrl+a`, `7`)
- restart the process with `ctrl+c`, press up, and then enter - restart the process with `ctrl+c`, press up, and then enter
@ -62,13 +54,11 @@ Snapshot
The driver should now be loaded. The contents of the repository is mapped to `/opt/stack/nova/nova/virt/ec2/`, and you can edit it directly from your host computer with an IDE of your choice. The driver should now be loaded. The contents of the repository is mapped to `/opt/stack/nova/nova/virt/ec2/`, and you can edit it directly from your host computer with an IDE of your choice.
###Running Tests ###Running Tests
1. Moto can be used to mock the EC2 server. To install moto, run `pip install moto`. 1. Moto can be used to mock the EC2 server. To install moto, run `sudo pip install moto`.
1. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`. 2. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`.
2. `~/devstack/rejoin-stack.sh` 3. `~/devstack/rejoin-stack.sh`
3. `cd /opt/stack/nova/nova/virt/ec2/tests` 4. `cd /opt/stack/nova/nova/virt/ec2/tests`
4. Use `nosetests -s test_ec2driver.py` 5. Use `nosetests -s test_ec2driver.py`
5. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`. 6. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`.
* In Amazons EC2 there is no concept of suspend and resume on instances. Therefore, we simply stop EC2 instances when suspended and start the instances when resumed, we do the same on pause and un-pause.
\* In Amazons EC2 there is no concept of suspend and resume on instances. Therefore, we simply stop EC2 instances when suspended and start the instances when resumed, we do the same on pause and un-pause.