Add getting started guide to README.rst

Tell folks how to use the software. Change-Id: I8c4de089f7a8a3075f660689bcc4743dfc9fc5f9
2014-11-25 13:04:42 -07:00 · 2014-11-25 13:04:42 -07:00 · aaa31eefce
parent 0a7969740a
commit aaa31eefce
1 changed files with 78 additions and 0 deletions
--- a/README.rst
+++ b/README.rst
@ -44,3 +44,81 @@ Features
 * Integration with Kubernetes and Docker for backend container technology.
 * Integration with Keystone for multi-tenant security.
 * Integraiton with Neutron for k8s multi-tenancy network security.
+
+Installation
+------------
+* Configure Keystone
+
+$ source openrc admin admin
+
+$ keystone user-create --name=magnum --pass=<secure-magnum-password> --email=magnum@example.com
+$ keystone 1
+ keystone service-create --name=container --type=container --description="Magnum Container Service"
+$keystone endpoint-create --service=container --publicurl=http://127.0.0.1:9511/v1 --internalurl=http://127.0.0.1:9511/v1 --adminurl=http://127.0.0.1:9511/v1
+
+* Install Magnum
+
+$ git clone http://github.com/stackforge/magnum
+$ cd magnum
+$ sudo python ./setup.py install
+$ cd ..
+
+* Install Magnum's Python Client
+
+$ git clone http://github.com/stackforge/python-magnumclient
+$ cd python-magnumclient
+$ sudo python ./setup.py install
+$ cd ..
+
+Run
+---
+* Start magnum-api
+
+$ magnum-api &
+
+* Start magnum-conductor
+
+$ magnum-conductor &
+
+* Start magnum-backend (should be started where a docker server or kubernetes
+* api server is running
+
+$ magnum-backend &
+
+* Install magnum pythonclient
+$ git clone http://github.com/stackforge/python-magnumclient
+$ cd python-magnumclient
+$ sudo python ./setup.py install
+
+Access Magnum via ReST API
+--------------------------
+
+* Note the magnum ReST API is not yet plumbed *
+
+* select a subcommand:
+    bay-create
+    bay-delete
+    bay-list
+    bay-show
+    container-create
+    container-delete
+    container-execute
+    container-list
+    container-logs
+    container-pause
+    container-reboot
+    container-show
+    container-start
+    container-stop
+    container-unpause
+    pod-create
+    pod-delete
+    pod-list
+    pod-show
+    service-create
+    service-delete
+    service-list
+    service-show
+
+* Run the operation:
+$ magnum bay-list