[doc] improved readme file to add production mode howto + typos
authorPaul Tonelli <paul.tonelli@logilab.fr>
Thu, 25 Jul 2013 15:12:30 +0200
changeset 180 fe8b24630837
parent 179 dde619dd74ea
child 181 52418fb97f5d
[doc] improved readme file to add production mode howto + typos
README.rst
--- a/README.rst	Tue Jul 16 11:13:51 2013 +0200
+++ b/README.rst	Thu Jul 25 15:12:30 2013 +0200
@@ -9,8 +9,8 @@
 
 The AMI builder tool can be used in two ways:
 
-* a simple developper mode, which will create new AMIs from your
-  workstation (it requires root credentials on a the machine)
+* a simple developer mode, which will create new AMIs from your
+  workstation (it requires root credentials on the machine)
 
 * a production mode, in which the special cloud-builder AMI is used to
   build a preconfigured deployable AMI.
@@ -31,7 +31,7 @@
 machine" we go for a "install once, run multiple times" approach.
 
 Another benefit of this approach is that you have a repeatable
-environnement.
+environment.
 
 If you're already using SaltStack_, you can easily reuse your `salt
 states`_ to setup a custom AMI.
@@ -43,7 +43,7 @@
 Quick start
 -----------
 
-To create your first working image, follow these instructions:
+To create your first working image in development mode, follow these instructions:
 
 1. Get the code ::
 
@@ -71,9 +71,9 @@
     cp user_data.cfg.sample user_data.cfg
     vim user_data.cfg
 
-   You should remove the unsed parts.
+   You should remove the unused parts.
 
-5. Set the environment variables by `sourcing` the config file ::
+5. Set the environment variables by `sourcing` the configuration file ::
 
     sudo python others/ec2_ami_parser.py user_data.cfg
 
@@ -99,4 +99,20 @@
 For further documentation (installation, deployment, examples, etc) see
 the docs/ folder.
 
+Quick start for producton mode
+------------------------------
 
+If an AMI-builder image is already available (production environment), there
+are three required steps to create your own AMI
+
+1. Create the repository containing your image configuration written in salt.
+   to do that, you can start from an existing repository or from the sample
+   repository::
+
+   http://hg.logilab.org/users/ptonelli/salt-ami-cloud-builder/variation/
+
+2. Write the required user data starting from the "user_data.cfg.sample" file.
+
+3. Boot the AMI-builder image you have with the previously modified user-data
+   in the correct field. You can then wait until your AMI is created.
+