mv readme.rst to README.rst
authorArthur Lutz <arthur.lutz@logilab.fr>
Fri, 31 May 2013 18:36:56 +0200
changeset 156 0aadee82ba1d
parent 155 05047af1803b
child 157 aef6810925ad
mv readme.rst to README.rst
README.rst
readme.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Fri May 31 18:36:56 2013 +0200
@@ -0,0 +1,98 @@
+
+Objective
+---------
+
+The goal is to automatically create variations of virtual machines
+images for a cloud infrastructure (OpenStack or Amazon are currently
+supported) using SaltStack_ based configuration files available in a
+given Mercurial_ repository.
+
+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 production mode, in which the special cloud-builder AMI is used to
+  build a preconfigured deployable AMI.
+
+.. _SaltStack: http://docs.saltstack.com/
+.. _Mercurial: http://mercurial.selenic.com/
+
+
+Why you need salt-ami-cloud-builder
+-----------------------------------
+
+ .. or why we build it.
+
+For a virtual machine in the cloud (private or Amazon), having a
+preconfigured AMI_ helps you gain setup time and execution time.
+
+Instead of having an "install and configure each instantiation of a
+machine" we go for a "install once, run multiple times" approach.
+
+Another benefit of this approach is that you have a repeatable
+environnement.
+
+If you're already using SaltStack_, you can easily reuse your `salt
+states`_ to setup a custom AMI.
+
+.. _AMI: http://en.wikipedia.org/wiki/Amazon_Machine_Image
+.. _`salt states`: http://docs.saltstack.com/topics/tutorials/starting_states.html
+
+
+Quick start
+-----------
+
+To create your first working image, follow these instructions:
+
+1. Get the code ::
+
+    hg clone http://hg.logilab.org/master/salt-ami-cloud-builder/
+
+2. Install `salt-minion` and dependencies (as root) ::
+
+    sudo apt-get install salt-minion python-apt
+
+3. Configure salt (edit `/etc/salt/minion`):
+
+    * set to masterless mode ::
+
+       file_client: local
+
+    * set state and modules source as local folder ::
+
+       file_roots:
+         base:
+          - /home/user/src/salt-ami-cloud-builder/
+
+4. Edit your configuration file ::
+
+    cd salt-ami-cloud-builder
+    cp user_data.cfg.sample user_data.cfg
+    vim user_data.cfg
+
+   You should remove the unsed parts.
+
+5. Set the environment variables by `sourcing` the config file ::
+
+    sudo python others/ec2_ami_parser.py user_data.cfg
+
+6. Run salt ::
+
+    sudo salt-call saltutil.sync_modules
+    sudo salt-call saltutil.sync_states
+    sudo salt-call state.sls ami_builder
+
+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`.
+
+
+Documentation
+-------------
+
+For further documentation (installation, deployment, examples, etc) see
+the docs/ folder.
+
+
--- a/readme.rst	Fri May 31 18:35:56 2013 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,98 +0,0 @@
-
-Objective
----------
-
-The goal is to automatically create variations of virtual machines
-images for a cloud infrastructure (OpenStack or Amazon are currently
-supported) using SaltStack_ based configuration files available in a
-given Mercurial_ repository.
-
-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 production mode, in which the special cloud-builder AMI is used to
-  build a preconfigured deployable AMI.
-
-.. _SaltStack: http://docs.saltstack.com/
-.. _Mercurial: http://mercurial.selenic.com/
-
-
-Why you need salt-ami-cloud-builder
------------------------------------
-
- .. or why we build it.
-
-For a virtual machine in the cloud (private or Amazon), having a
-preconfigured AMI_ helps you gain setup time and execution time.
-
-Instead of having an "install and configure each instantiation of a
-machine" we go for a "install once, run multiple times" approach.
-
-Another benefit of this approach is that you have a repeatable
-environnement.
-
-If you're already using SaltStack_, you can easily reuse your `salt
-states`_ to setup a custom AMI.
-
-.. _AMI: http://en.wikipedia.org/wiki/Amazon_Machine_Image
-.. _`salt states`: http://docs.saltstack.com/topics/tutorials/starting_states.html
-
-
-Quick start
------------
-
-To create your first working image, follow these instructions:
-
-1. Get the code ::
-
-    hg clone http://hg.logilab.org/master/salt-ami-cloud-builder/
-
-2. Install `salt-minion` and dependencies (as root) ::
-
-    sudo apt-get install salt-minion python-apt
-
-3. Configure salt (edit `/etc/salt/minion`):
-
-    * set to masterless mode ::
-
-       file_client: local
-
-    * set state and modules source as local folder ::
-
-       file_roots:
-         base:
-          - /home/user/src/salt-ami-cloud-builder/
-
-4. Edit your configuration file ::
-
-    cd salt-ami-cloud-builder
-    cp user_data.cfg.sample user_data.cfg
-    vim user_data.cfg
-
-   You should remove the unsed parts.
-
-5. Set the environment variables by `sourcing` the config file ::
-
-    sudo python others/ec2_ami_parser.py user_data.cfg
-
-6. Run salt ::
-
-    sudo salt-call saltutil.sync_modules
-    sudo salt-call saltutil.sync_states
-    sudo salt-call state.sls ami_builder
-
-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`.
-
-
-Documentation
--------------
-
-For further documentation (installation, deployment, examples, etc) see
-the docs/ folder.
-
-