Revision ccb6b943 docs/usage.rst

b/docs/usage.rst
31 31 
                         upload the image to pithos with name FILENAME
32 32 
   -r IMAGENAME, --register=IMAGENAME
33 33 
                         register the image with ~okeanos as IMAGENAME
34 
   -a ACCOUNT, --account=ACCOUNT
35 
                         use this ACCOUNT when uploading/registering images
36 
                         [Default: None]
37 34 
   -m KEY=VALUE, --metadata=KEY=VALUE
38 35 
                         add custom KEY=VALUE metadata to the image
39 36 
   -t TOKEN, --token=TOKEN
......
48 45 
                         media
49 46 
   --no-sysprep          don't perform any system preparation operation
50 47 
   --no-shrink           don't shrink the image
48 
   --public              register image to cyclades as public
51 49 
   --tmpdir=DIR          create large temporary image files under DIR
52 50 

  		





  53
  51
  
    
Most input options are self-describing. If you want to save a local copy of


  		





  54
  52
  
    
the image you create, provide a filename using the *-o* option. To upload the


  		





  55
  
  
    
image to *pithos+*, provide valid credentials using *-a* and *-t* and a


  		





  
  53
  
    
image to *pithos+*, provide a valid authentication token using *-t* and a


  		





  56
  54
  
    
filename using *-u*. If you also want to register the image with *~okeanos*, in


  		





  57
  
  
    
addition to *-u* provide a registration name using *-r*.


  		





  
  55
  
    
addition to *-u* provide a registration name using *-r*. All images are


  		





  
  56
  
    
registered as *private*. Only the user that registers the image can create


  		





  
  57
  
    
VM's out of it. If you want the image to be visible by other user too, use the


  		





  
  58
  
    
*--public* option.


  		





  58
  59
  
    

  		





  59
  60
  
    
By default, before extracting the image, snf-image-creator will perform a


  		





  60
  61
  
    
number of system preparation operations on the snapshot of the media and will


  		





  ......




  175
  176
  
    
 * Name: A short name for the image (ex. "Slackware")


  		





  176
  177
  
    
 * Description: An one-line description for the image


  		





  177
  178
  
    
   (ex. "Slackware Linux 14.0 with KDE")


  		





  178
  
  
    
 * Account: An *~okeanos* account user id


  		





  179
  
  
    
 * Token: A token corresponding to the account given above


  		





  
  179
  
    
 * Registration Type: Private or Public


  		





  
  180
  
    
 * Account: The authentication token for an *~okeanos* account


  		





  180
  181
  
    

  		





  181
  182
  
    
After confirming, the image will be extracted, uploaded to *pithos+* and


  		





  182
  183
  
    
registered with *~okeanos*. The user will also be given the choice to keep a


  		





  ......




  201
  202
  
    

  		





  202
  203
  
    
In the *Register* sub-menu the user can provide:


  		





  203
  204
  
    

  		





  204
  
  
    
 * The credentials to login to *~okeanos*


  		





  
  205
  
    
 * The credentials (authentication token) to authenticate on *~okeanos*


  		





  205
  206
  
    
 * A *pithos+* filename for the uploaded *diskdump* image


  		





  206
  
  
    
 * A name for the image to be registered to *~okeanos* with


  		





  
  207
  
    
 * A name for the image to be registered to *~okeanos* with, as well as the


  		





  
  208
  
    
   registration type (*private* or *public*)


  		





  207
  209
  
    

  		





  208
  210
  
    
By choosing the *Extract* menu entry, the user can dump the image to the local


  		





  209
  211
  
    
file system. Finally, if the user selects *Reset*, the system will ignore


  		





  ......




  228
  230
  
    

  		





  229
  231
  
    
.. code-block:: console


  		





  230
  232
  
    

  		





  231
  
  
    
   $ wget http://ubuntureleases.tsl.gr/12.04.1/ubuntu-12.04.1-server-amd64.iso


  		





  
  233
  
    
   $ wget http://ubuntureleases.tsl.gr/12.04.2/ubuntu-12.04.2-server-amd64.iso


  		





  232
  234
  
    

  		





  233
  235
  
    
Verify that it has been downloaded correctly:


  		





  234
  236
  
    

  		





  235
  237
  
    
.. code-block:: console


  		





  236
  238
  
    

  		





  237
  
  
    
   $ echo 'a8c667e871f48f3a662f3fbf1c3ddb17  ubuntu-12.04.1-server-amd64.iso' > check.md5


  		





  
  239
  
    
   $ echo 'a8c667e871f48f3a662f3fbf1c3ddb17  ubuntu-12.04.2-server-amd64.iso' > check.md5


  		





  238
  240
  
    
   $ md5sum -c check.md5


  		





  239
  241
  
    

  		





  240
  242
  
    
Create a 2G sparse file to host the new system:


  		





  ......




  248
  250
  
    
.. code-block:: console


  		





  249
  251
  
    

  		





  250
  252
  
    
   $ sudo kvm -boot d -drive file=ubuntu_hd.raw,format=raw,cache=none,if=virtio \


  		





  251
  
  
    
     -m 1G -cdrom ubuntu-12.04.1-server-amd64.iso


  		





  
  253
  
    
     -m 1G -cdrom ubuntu-12.04.2-server-amd64.iso


  		





  252
  254
  
    

  		





  253
  255
  
    
.. warning::


  		





  254
  256
  
    

  		





  ......




  271
  273
  
    
In the first screen you will be asked to choose if you want to run the program


  		





  272
  274
  
    
in *Wizard* or *Expert* mode. Choose *Wizard*.


  		





  273
  275
  
    

  		





  274
  
  
    
.. image:: /snapshots/01_wizard.png


  		





  
  276
  
    
.. image:: /snapshots/wizard.png


  		





  275
  277
  
    

  		





  276
  
  
    
Then you will be asked to provide a name, a description, an *~okeanos* account


  		





  277
  
  
    
and the token corresponding to this account. Finally, you'll be asked to


  		





  278
  
  
    
confirm the provided data.


  		





  
  278
  
    
Then you will be asked to provide a name, a description, a registration type


  		





  
  279
  
    
(*private* or *public*) and the authentication token corresponding to your


  		





  
  280
  
    
*~okeanos* account. Finally, you'll be asked to confirm the provided data.


  		





  279
  281
  
    

  		





  280
  
  
    
.. image:: /snapshots/06_confirm.png


  		





  
  282
  
    
.. image:: /snapshots/confirm.png


  		





  281
  283
  
    

  		





  282
  284
  
    
Choosing *YES* will create and upload the image to your *~okeanos* account.


  		





  283
  285
  
    

  		












Also available in:
  Unified diff