[doc] update doc to mirror changes in path.
authorPaul Tonelli <paul.tonelli@logilab.fr>
Tue, 03 Dec 2013 11:24:39 +0100
changeset 194 556257e07714
parent 193 918f0ec4d4f5
child 195 d01596003bc0
[doc] update doc to mirror changes in path.
README.rst
--- a/README.rst	Thu Nov 28 10:40:55 2013 +0100
+++ b/README.rst	Tue Dec 03 11:24:39 2013 +0100
@@ -12,7 +12,7 @@
 * 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
+* a production mode, in which a special cloud-builder AMI is used to
   build a preconfigured deployable AMI.
 
 .. _SaltStack: http://docs.saltstack.com/
@@ -47,13 +47,13 @@
 
 1. Get the code ::
 
-    hg clone http://hg.logilab.org/master/salt-ami-cloud-builder/
+    hg clone http://hg.logilab.org/master/salt-ami-cloud-builder/ <your-folder>/sacb
 
 2. Install `salt-minion` and dependencies (as root) ::
 
     sudo apt-get install salt-minion python-apt
 
-3. Configure salt (edit `/etc/salt/minion`):
+3. Configure salt (edit `<your-folder>/minion`):
 
     * set to masterless mode ::
 
@@ -63,7 +63,7 @@
 
        file_roots:
          base:
-          - /home/user/src/salt-ami-cloud-builder/
+          - <your-folder>/sacb 
 
 4. Edit your configuration file ::
 
@@ -75,23 +75,27 @@
 
 5. Set the environment variables by `sourcing` the configuration file ::
 
-    sudo python others/ec2_ami_parser.py user_data.cfg
+    sudo python others/user_data_parser.py user_data.cfg
+
+.. WARNING::
+   salt will use /mnt/variation and /mnt/output folders to put its output
+   files, make sure these folders do not exist before running salt.
 
 6. Run salt ::
 
-    sudo salt-call saltutil.sync_modules
-    sudo salt-call saltutil.sync_states
-    sudo salt-call state.sls ami_builder
+    sudo salt-call --local -c <your-folder> saltutil.sync_modules
+    sudo salt-call --local -c <your-folder> saltutil.sync_states
+    sudo salt-call --local -c <your-folder> state.sls ami_builder
 
 .. WARNING::
     At this point, do NOT run a highstate  (salt-call state.highstate), as this
-    would modify multiple important system files from your system.
+    would modify multiple important system files on your machine.
 
 If you got only green and blue outputs, everything should be ok.
 
-You are now the proud owner of a variation.img file containing your
-dear AMI, in `/mnt/output`.
-
+You are now the proud owner of a variation.img file containing your new AMI, in
+`/mnt/output` (or already uploaded in the cloud if you provided the correct
+credentials).
 
 Documentation
 -------------