Revision 5aa25240

b/docs/index.rst
17 17
   install
18 18
   usage
19 19

  
20
Contact
21
=======
20 22

  
21
Indices and tables
22
==================
23
For questions or bug reports you can contact the Synnefo team at the following
24
mailing lists:
23 25

  
24
* :ref:`genindex`
25
* :ref:`modindex`
26
* :ref:`search`
26
 * Users list: synnefo@googlegroups.com
27
 * Developers list: synnefo-devel@googlegroups.com
28

  
29
..
30
 Indices and tables
31
 ==================
32
 * :ref:`genindex`
33
 * :ref:`modindex`
34
 * :ref:`search`
27 35

  
b/docs/install.rst
25 25
The above dependencies are resolved differently, depending on the installation
26 26
method you choose. There are two installation methods available:
27 27

  
28
#. `Installation using official packages <#install-snf-image-creator-using-official-packages>`_ (currently only for Ubuntu 12.04 LTS and 12.10).
28
#. `Installation using packages <#install-snf-image-creator-using-packages>`_ (currently only for Ubuntu and Arch Linux).
29 29

  
30 30
#. `Installation from source <#install-snf-image-creator-from-source>`_
31 31

  
32
Install snf-image-creator using official packages
33
=================================================
32
Install snf-image-creator using packages
33
========================================
34 34

  
35
For Ubuntu systems, you can use our official packages found in *grnet/synnefo*
36
Lauchpad PPA.
35
Ubuntu
36
------
37

  
38
For *Ubuntu 12.04 LTS* and *12.10* systems, you can use our official packages
39
found in *grnet/synnefo* Lauchpad PPA.
37 40

  
38 41
Add the synnefo PPA in your system:
39 42

  
......
71 74
   If you are asked during the installation to create/update a
72 75
   "supermin appliance", choose "Yes".
73 76

  
77
.. warning::
78
   In *Ubuntu 12.10* the current package of libguestfs (1.18-2) is broken. Take
79
   a look at the open `bug report <https://bugs.launchpad.net/ubuntu/quantal/+source/libguestfs/+bug/1086974>`_.
80
   Until version 1.18-2ubunut1 is out, you may workaround this problem by
81
   creating a symlink like this:
82

  
83
   *sudo ln -s /usr/lib/guestfs /usr/lib/x86_64-linux-gnu/guestfs*
84

  
85
Arch Linux
86
----------
87

  
88
For *Arch Linux* there are **unofficial** packages in AUR:
89
https://aur.archlinux.org/packages/snf-image-creator/ kindly provided by
90
Axilleas Pipinellis <axilleas@archlinux.info>.
91

  
92
.. note::
93
    Those packages are not maintained by the Synnefo development team.
94

  
95
    Please direct package-specific questions to Axilleas Pipinellis <axilleas@archlinux.info>,
96
    Cc: the Synnefo development team <synnefo-devel@googlegroups.com>
97

  
98
To install the package you may use *yaourt*. Create and install
99
the *yaourt* package:
100

  
101
.. code-block:: console
102

  
103
   $ wget https://aur.archlinux.org/packages/pa/package-query/package-query.tar.gz
104
   $ tar -xvf package-query.tar.gz
105
   $ cd package-query
106
   $ makepkg -s
107
   $ pacman -U package-query-<VERSION>-<ARCH>.pkg.tar.xz
108
   $ cd ..
109
   $ wget https://aur.archlinux.org/packages/ya/yaourt/yaourt.tar.gz
110
   $ tar -xvf yaourt.tar.gz
111
   $ cd yaourt
112
   $ makepkg -s
113
   $ pacman -U yaourt-<VERSION>-<ARCH>.pkg.tar.xz
114

  
115
Install *snf-image-creator* using yaourt:
116

  
117
.. code-block:: console
118

  
119
   $ yaourt -Sa snf-image-creator
120

  
74 121
Install snf-image-creator from source
75 122
=====================================
76 123

  
b/docs/usage.rst
217 217
media or by using the *Bundle Host* button in the media selection dialog of
218 218
snf-mkimage. During this operation, the files of the disk are copied into a
219 219
temporary image file, which means that the file system that will host the
220
temporary image needs to have a lot of free space (see `the tmpdir option`_
220
temporary image needs to have a lot of free space (see `large temporary files`_
221 221
for more information).
222 222

  
223 223
Creating a new image
......
281 281

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

  
284
Some caveats on image creation
285
==============================
284
Limitations
285
===========
286

  
287
Supported operating systems
288
---------------------------
289

  
290
*snf-image-creator* can only fully function on input media hosting *Linux*
291
systems. The program will detect the needed metadata and you may use it to
292
upload and register other *Unix* or *Windows* images, but you cannot use it to
293
shrink them or perform system preparation operations.
294

  
295
Logical Volumes
296
---------------
297

  
298
The program cannot work on LVM partitions [#f1]_. The input media may only
299
contain primary or logical partitions.
286 300

  
287 301
Para-virtualized drivers
288 302
------------------------
......
298 312
Many popular Linux distributions, like Ubuntu and Debian, will automatically
299 313
create a generic initial ramdisk file that contains many different modules,
300 314
including the VirtIO drivers. Others that target more experienced users, like
301
Slackware, won't do that [#f1]_. *snf-image-creator* cannot resolve this kind
315
Slackware, won't do that [#f2]_. *snf-image-creator* cannot resolve this kind
302 316
of problems and it's left to the user to do so. Please refer to your
303 317
distribution's documentation for more information on this. You can always check
304 318
if a system can boot with para-virtualized disk controller by launching it with
305 319
kvm using the *if=virtio* option (see the kvm command in the
306 320
`Creating a new image`_ section).
307 321

  
322
Some caveats on image creation
323
==============================
324

  
308 325
Image partition schemes and shrinking
309 326
-------------------------------------
310 327

  
......
322 339
partition placed as the last partition on the disk and have your largest
323 340
partition (*/* or */home*) just before that.
324 341

  
325
The tmpdir option
326
-----------------
342
Large temporary files
343
---------------------
327 344

  
328 345
*snf-image-creator* may create large temporary files when running:
329 346

  
......
343 360

  
344 361
.. rubric:: Footnotes
345 362

  
346
.. [#f1] http://mirrors.slackware.com/slackware/slackware-14.0/README.initrd
363
.. [#f1] http://sourceware.org/lvm2/
364
.. [#f2] http://mirrors.slackware.com/slackware/slackware-14.0/README.initrd

Also available in: Unified diff