Browse Source

Kashyap | prettified readme

changes/85/139985/1
Kashyap Kopparam 4 years ago
parent
commit
0f884f437e
1 changed files with 21 additions and 31 deletions
  1. 21
    31
      README.md

+ 21
- 31
README.md View File

@@ -18,9 +18,9 @@ as a hypervisor while continuing to be able to manage the existing private cloud
18 18
 
19 19
 ## Quick Setup Steps
20 20
 
21
-1. Go to <OpenStack Root Dir>/nova/nova/virt/
22
-2. `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
23
-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:-
21
+1. `$ cd <openstack_root_dir>/nova/nova/virt/`
22
+2. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
23
+3. `$ vim /etc/nova/nova.conf # make sure it contains the following options in the respective sections`
24 24
 
25 25
         [DEFAULT]
26 26
         compute_driver=ec2.EC2Driver
@@ -31,29 +31,21 @@ as a hypervisor while continuing to be able to manage the existing private cloud
31 31
         [ec2driver]
32 32
         ec2_secret_access_key = <your_aws_secret_access_key>
33 33
         ec2_access_key_id = <your_aws_access_key_id>
34
-4. Now go to the ec2 directory that was cloned and edit the ec2driver_standard_config.py if required.
35
-5. Restart the nova compute service. 
34
+4. `ec2driver_standard_config.py` can be edited to configure the default AMI, AWS region and endpoints. 
35
+5. Restart the nova-compute service. You are now all set cloud burst!
36 36
 
37
-You are now all set cloud burst!
38
-
39
-## What's supported!
40
-Launch
41
-Reboot
42
-Terminate
43
-Resize
44
-Pause/Unpause*
45
-Suspend/Resume*
46
-Attach/Detach Volume
47
-Snapshot
37
+### What's supported!
38
+Launch, Reboot, Terminate, Resize, Pause/Unpause*, Suspend/Resume*, Attach/Detach Volume, Snapshot
48 39
 
49 40
 #For Contributors
50 41
 
51 42
 ###Instructions for Developer Environment setup
52
-1. Install git, Virtualbox and Vagrant and Clone this repository: `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git`
53
-2. Run`vagrant up` from within the repository to create an Ubuntu virtualbox that will install devstack. This will take a couple minutes.
54
-3. `vagrant ssh` to ssh into the new machine
55
-4. Refer to Step 3 in Quick Setup to edit nova.conf
56
-5. Restart nova
43
+1. Install git, Virtualbox and Vagrant.
44
+2. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
45
+3. `$ cd ec2/ && vagrant up` This will download the development environment from Vagrant clound and setup devstack. 
46
+4. `$ vagrant ssh`
47
+5. Edit nova.conf and add the ec2 configuration options, refer to step 3 in Quick setup guide.
48
+6. Restart nova-compute
57 49
   - `~/devstack/rejoin-stack.sh`
58 50
   - go to the nova-cpu screen (`ctrl+a`, `7`)
59 51
   - restart the process with `ctrl+c`, press up, and then enter
@@ -62,13 +54,11 @@ Snapshot
62 54
 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.
63 55
 
64 56
 ###Running Tests
65
-1. Moto can be used to mock the EC2 server. To install moto, run `pip install moto`.
66
-1. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`.
67
-2. `~/devstack/rejoin-stack.sh`
68
-3. `cd /opt/stack/nova/nova/virt/ec2/tests`
69
-4. Use `nosetests -s test_ec2driver.py`
70
-5. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`.
71
-
72
-
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
-
57
+1. Moto can be used to mock the EC2 server. To install moto, run `sudo pip install moto`.
58
+2. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`.
59
+3. `~/devstack/rejoin-stack.sh`
60
+4. `cd /opt/stack/nova/nova/virt/ec2/tests`
61
+5. Use `nosetests -s test_ec2driver.py`
62
+6. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`.
63
+
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.

Loading…
Cancel
Save