summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKashyap Kopparam <kashyapk@thoughtworks.com>2014-11-05 11:39:36 +0530
committerKashyap Kopparam <kashyapk@thoughtworks.com>2014-11-05 11:39:36 +0530
commit0f884f437eb56d24ac1a62df2ed9d45c290e19f7 (patch)
treefda53a33d7cd3c62fbffde75936843ac6e063c4e
parent8032eda5774d9b1e880b514f2dade468674dacb3 (diff)
Kashyap | prettified readme
-rw-r--r--README.md52
1 files changed, 21 insertions, 31 deletions
diff --git a/README.md b/README.md
index 1a681a9..cdd9ccb 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,9 @@ as a hypervisor while continuing to be able to manage the existing private cloud
18 18
19## Quick Setup Steps 19## Quick Setup Steps
20 20
211. Go to <OpenStack Root Dir>/nova/nova/virt/ 211. `$ cd <openstack_root_dir>/nova/nova/virt/`
222. `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2` 222. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
233. 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:- 233. `$ vim /etc/nova/nova.conf # make sure it contains the following options in the respective sections`
24 24
25 [DEFAULT] 25 [DEFAULT]
26 compute_driver=ec2.EC2Driver 26 compute_driver=ec2.EC2Driver
@@ -31,29 +31,21 @@ as a hypervisor while continuing to be able to manage the existing private cloud
31 [ec2driver] 31 [ec2driver]
32 ec2_secret_access_key = <your_aws_secret_access_key> 32 ec2_secret_access_key = <your_aws_secret_access_key>
33 ec2_access_key_id = <your_aws_access_key_id> 33 ec2_access_key_id = <your_aws_access_key_id>
344. Now go to the ec2 directory that was cloned and edit the ec2driver_standard_config.py if required. 344. `ec2driver_standard_config.py` can be edited to configure the default AMI, AWS region and endpoints.
355. Restart the nova compute service. 355. Restart the nova-compute service. You are now all set cloud burst!
36 36
37You are now all set cloud burst! 37### What's supported!
38 38Launch, Reboot, Terminate, Resize, Pause/Unpause*, Suspend/Resume*, Attach/Detach Volume, Snapshot
39## What's supported!
40Launch
41Reboot
42Terminate
43Resize
44Pause/Unpause*
45Suspend/Resume*
46Attach/Detach Volume
47Snapshot
48 39
49#For Contributors 40#For Contributors
50 41
51###Instructions for Developer Environment setup 42###Instructions for Developer Environment setup
521. Install git, Virtualbox and Vagrant and Clone this repository: `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git` 431. Install git, Virtualbox and Vagrant.
532. Run`vagrant up` from within the repository to create an Ubuntu virtualbox that will install devstack. This will take a couple minutes. 442. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
543. `vagrant ssh` to ssh into the new machine 453. `$ cd ec2/ && vagrant up` This will download the development environment from Vagrant clound and setup devstack.
554. Refer to Step 3 in Quick Setup to edit nova.conf 464. `$ vagrant ssh`
565. Restart nova 475. Edit nova.conf and add the ec2 configuration options, refer to step 3 in Quick setup guide.
486. Restart nova-compute
57 - `~/devstack/rejoin-stack.sh` 49 - `~/devstack/rejoin-stack.sh`
58 - go to the nova-cpu screen (`ctrl+a`, `7`) 50 - go to the nova-cpu screen (`ctrl+a`, `7`)
59 - restart the process with `ctrl+c`, press up, and then enter 51 - restart the process with `ctrl+c`, press up, and then enter
@@ -62,13 +54,11 @@ Snapshot
62The 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. 54The 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.
63 55
64###Running Tests 56###Running Tests
651. Moto can be used to mock the EC2 server. To install moto, run `pip install moto`. 571. Moto can be used to mock the EC2 server. To install moto, run `sudo pip install moto`.
661. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`. 582. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`.
672. `~/devstack/rejoin-stack.sh` 593. `~/devstack/rejoin-stack.sh`
683. `cd /opt/stack/nova/nova/virt/ec2/tests` 604. `cd /opt/stack/nova/nova/virt/ec2/tests`
694. Use `nosetests -s test_ec2driver.py` 615. Use `nosetests -s test_ec2driver.py`
705. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`. 626. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`.
71 63
72 64\* In Amazon’s 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. \ No newline at end of file
73* In Amazon’s 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.
74