Browse code

update readme

Anthony Young authored on 2011/10/01 03:34:43
Showing 1 changed files
... ...
@@ -1,4 +1,11 @@
1
-Tool to quickly deploy openstack dev environments
1
+Tool to quickly deploy openstack dev environments.
2
+
3
+# Goals
4
+
5
+* To quickly build dev openstack environments in clean natty environments
6
+* To describe working configurations of openstack (which code branches work together?  what do config files look like for those branches?)
7
+* To make it easier for developers to dive into openstack so that they can productively contribute without having to understand every part of the system at once
8
+* To make it easy to prototype cross-project features
2 9
 
3 10
 Be sure to carefully read these scripts before you run them as they install software and may alter your networking configuration.
4 11
 
... ...
@@ -6,34 +13,30 @@ Be sure to carefully read these scripts before you run them as they install soft
6 6
 
7 7
     ./stack.sh
8 8
 
9
+If working correctly, you should be able to access openstack endpoints, like:
10
+
11
+* Dashboard: http://myhost/
12
+* Keystone: http://myhost:5000/v2.0/
13
+
9 14
 # To start a dev cloud in an lxc container:
10 15
 
11 16
     ./build_lxc.sh
12 17
 
13 18
 You will need to configure a bridge and network on your host machine (by default br0) before starting build_lxc.sh.  A sample host-only network configuration can be found in lxc_network_hostonlyplusnat.sh.
14 19
 
20
+# Customizing
21
+
22
+You can tweak environment variables by creating file name 'localrc' should you need to override defaults.  It is likely that you will need to do this to tweak your networking configuration should you need to access your cloud from a different host.
23
+
15 24
 # Todo
16 25
 
17 26
 * Add python-novaclient cli support
18
-* move keystone/glance/dash to mysql
19 27
 * syslog
20
-* check openstack-puppet recipes to see if anything else is missing
21 28
 * allow rabbit connection to be specified via environment variables with sensible defaults
22 29
 * Add volume support
23
-* allow changing of git locations (specify different tag/branch or repos)
24
-* change method of invoking stack.sh to ./stack.sh all _or_ ./stack.sh nova-compute,nova-network,nova-api,nova-volume
25 30
 * Add quantum support
26 31
 
27
-# Done
28
-
29
-* sqlconn can be set via env
30
-* move back to using sudo
31
-* move nova to mysql
32
-* munin
33
-* image upload with a script that supports generating images via debootstrap (ubuntu-vm-builder)
34
-
35 32
 # Future
36 33
 
37 34
 * idea: move from screen to tmux?
38 35
 * idea: create a live-cd / vmware preview image using this?
39
-* idea: use lxc to make the proto-image have everything?  so launching a new server is just turn on / updating / run?