translate readme.txt file and update the script behavior following meeting
authorPaul Tonelli <paul.tonelli@logilab.fr>
Thu, 28 Feb 2013 15:49:24 +0100
changeset 9 b53834c4133f
parent 8 c6acd24fb4f4
child 10 623c964b59f5
translate readme.txt file and update the script behavior following meeting
readme.txt
--- a/readme.txt	Thu Feb 28 15:59:47 2013 +0100
+++ b/readme.txt	Thu Feb 28 15:49:24 2013 +0100
@@ -1,21 +1,31 @@
 
-Objectif
+Objective
 =======
 
-créer de manière automatique des variantes machines virtuelles en
-fonction de fichiers disponibles sur un repository hg.
+Automatically create variations of virtual machines depending
+on configuration files availables in repository :
+
+  http://hg.logilab.fr/users/ptonelli/srv_salt/states/
+
+Files
+-----
 
-Fonctionnement actuel
----------------------
+init-server.sls file to initialize ami-creator and create mounting machine
+init-client.sls sample state file for variation of virtual machine (to be
+modified for multiple variations)
 
-- lancer l'instance openstack ami image creation (id : d4062f13-f26a-4a9a-a61c-613911b22c77 ) et se logger dessus
-- lancer le script de creation (salt-minion a été enlevé de wheezy...):
+Present state
+-------------
+
+- Resume Openstack image "ami image creation" (id: d4062f13-f26a-4a9a-a61c-613911b22c77) and log on it.
+- Launch salt-call with the creation script.
 
   $ salt-call vm_create.create_flavor $image_name None
 
-ou
+or
 
-- créer une machine wheezy 64 bits, faire un checkout de ce repo et lancer le script de bootstrap
+- Create a new instance of ``wheezy 64bits``, clone the repo listed at the top
+  of this file and launch the bootstrap script:
 
   $ chmod +x bootstrap-script.sh
   $ ./bootstrap-script.sh 
@@ -28,45 +38,37 @@
 glance
 ------
 
-le modules salt glance se base sur glanceclient qui n'est disponible que dans debian experimental et je n'ai pas reussi à le faire fonctionner avec essex (de ce que j'ai pu tester, à confirmer), à revérifier
+The salt module from glance does not work in debian as ``glanceclient`` package is only available in experimental and I did not manage to connect to openstack essex with it.
 
 nova
 ----
 
-le module fonctionne parfaitement, donc l'autre devrait aussi fonctionner...
-
+The salt module is working as intended. 
 
-fonctionnement souhaité du script :
-
-3 niveaux de scripting, chaque niveau doit bootstrapper le niveau en dessous:
+Optimal behavior of this project
+================================
 
-lanceur du script
------------------
-
-potentiellement lancé automatiquement sur un commit hg du repository flavors
+3 levels of scripting:
 
-- regarde si des flavors ont été ajouté / supprimées modifiées
-- si oui, instancie / crée / unsuspend la machine virtuelle permettant la création d'images EN COURS
-- modifie l'image pour qu'elle puisse exécuter des scripts salt
-- force un salt-call local sur la machine intermediaire
+Virtual Instance Launcher
+-------------------------
+
+(hooked to modifications of HG repository)
+NOTHING DONE
 
-machine intermédiaire 
----------------------
+Ami Creator
+-----------
 
-(Script le plus avancé)
+An image available on openstack / ec2.
 
-- télécharge si nécessaire l'image à personaliser
-- pour chaque flavor possible
-- decompresse et mount puis préparer le chroot DONE
-- modifie l'image pour qu'elle puisse exécuter des scripts salt DONE
-- force un salt-call local sur le chroot après avoir installé le script flavor DONE
-- démonte le tout et uploade sur openstack / amazon DONE pour openstack
+At boot, the user must supply a repository address in user data as
+``variation_address`` this information is used by salt at boot to download the
+correct revision of files.  it then execute salt-call
+vm_create.create_variation which will create a complete ami file and upload it
+to glance EC2
 
-machine cible (chroot)
-----------------------
+Chroot Image
+------------
 
-- exécute le script flavor
-
-idés
-----
-utiliser la machine intermédiaire comme un salt master et paralléliser le processus ?
+this script should only be a salt state file, and must be run using
+salt-highstate before packaging of the ami.