Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
itminedu
snf-image
Commits
ad9ea077
Commit
ad9ea077
authored
Sep 19, 2013
by
Nikos Skalkotos
Browse files
Fix minor typos in the documentation
parent
7f904d29
Changes
3
Hide whitespace changes
Inline
Side-by-side
docs/architecture.rst
View file @
ad9ea077
...
@@ -2,8 +2,8 @@ Architecture
...
@@ -2,8 +2,8 @@ Architecture
============
============
snf-image is split in two components: The main program running on the Ganeti
snf-image is split in two components: The main program running on the Ganeti
host
,
with full root privilege (*snf-image* previously *snf-image-host*)
,
and a
host with full root privilege (*snf-image* previously *snf-image-host*) and a
part running inside an unprivileged
,
helper VM (*snf-image-helper*).
part running inside an unprivileged helper VM (*snf-image-helper*).
snf-image
snf-image
^^^^^^^^^
^^^^^^^^^
...
...
docs/installation.rst
View file @
ad9ea077
...
@@ -23,21 +23,21 @@ For Debian Wheezy add the following lines:
...
@@ -23,21 +23,21 @@ For Debian Wheezy add the following lines:
``deb-src http://apt.dev.grnet.gr squeeze/``
``deb-src http://apt.dev.grnet.gr squeeze/``
and
import the repo's GPG key:
After you update ``/etc/apt/sources.list``
import the repo's GPG key:
.. code-block:: console
.. code-block:: console
$ curl https://dev.grnet.gr/files/apt-grnetdev.pub | apt-key add -
$ curl https://dev.grnet.gr/files/apt-grnetdev.pub | apt-key add -
I
nstall the package us
ing
the following commands:
To i
nstall the package us
e
the following commands:
.. code-block:: console
.. code-block:: console
$ apt-get update
$ apt-get update
$ apt-get install snf-image
$ apt-get install snf-image
The last command will also download and install the
fixed
*snf-image-helper*
The last command will also download and install the *snf-image-helper*
image in
appliance in
the post install phase of the package installation.
the post install phase of the package installation.
Installing snf-image from source
Installing snf-image from source
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
...
@@ -65,7 +65,7 @@ Install snf-image:
...
@@ -65,7 +65,7 @@ Install snf-image:
$ make install
$ make install
$ install -Dm600 defaults /etc/default/snf-image
$ install -Dm600 defaults /etc/default/snf-image
I
nstall the helper image by executing:
Finally, i
nstall the helper image by executing:
.. code-block:: console
.. code-block:: console
...
...
docs/usage.rst
View file @
ad9ea077
...
@@ -80,9 +80,9 @@ still some rules to follow:
...
@@ -80,9 +80,9 @@ still some rules to follow:
Image IDs & Storage back-ends
Image IDs & Storage back-ends
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
*snf-image* ca
n use
images that are stored in a variety of
different back-ends.
*snf-image* ca
pable of deploying
images that are stored in a variety of
The back-end to be used is determined by the value
passed by the *img_id* OS
different back-ends.
The back-end to be used is determined by the value
of the
parameter. The following back-ends are supported:
*img_id* OS
parameter. The following back-ends are supported:
* **Local back-end**:
* **Local back-end**:
The local back-end is used to retrieve images that are stored in the ganeti
The local back-end is used to retrieve images that are stored in the ganeti
...
@@ -90,10 +90,10 @@ parameter. The following back-ends are supported:
...
@@ -90,10 +90,10 @@ parameter. The following back-ends are supported:
the value of the *img_id* ganeti OS parameter is either prefixed with
the value of the *img_id* ganeti OS parameter is either prefixed with
*file://* or is not prefixed at all. All local images are expected to be
*file://* or is not prefixed at all. All local images are expected to be
found under a predifined image directory. By default */var/lib/snf-image* is
found under a predifined image directory. By default */var/lib/snf-image* is
used, but the user
can
change thi
directory
by overwriting the value of the
used, but the user
may
change thi
s
by overwriting the value of the
*IMAGE_DIR* variable under
*
/etc/default/snf-image
*
. The name of the image
*IMAGE_DIR* variable under
``
/etc/default/snf-image
``
. The name of the image
file is created by adding the image type extension in the end of the
file is created by adding the image type extension in the end of the
*img_id*.
I
f the *img_id*
for example
is *file://slackware* and the image
*img_id*.
For example i
f the *img_id* is *file://slackware* and the image
type is *diskdump*, snf-image will expect to find an image file under the
type is *diskdump*, snf-image will expect to find an image file under the
following path: ``/usr/lib/snf-image/slackware.diskdump``
following path: ``/usr/lib/snf-image/slackware.diskdump``
...
@@ -104,28 +104,28 @@ parameter. The following back-ends are supported:
...
@@ -104,28 +104,28 @@ parameter. The following back-ends are supported:
image using `cURL <http://curl.haxx.se/>`_.
image using `cURL <http://curl.haxx.se/>`_.
* **Pithos back-end**:
* **Pithos back-end**:
If an *img_id* is prefixed with *pithos:* or *pithosmap:*
,
the image is
If an *img_id* is prefixed with *pithos:* or *pithosmap:* the image is
considered to be pithos back-ended. *snf-image* contains a special
considered to be pithos back-ended. *snf-image* contains a special
command-line tool (*pithcat*) for retrieving this kind of images. For
command-line tool (*pithcat*) for retrieving this kind of images. For
*pithosmap:* images, the user needs to have set a valid value for the
*pithosmap:* images, the user needs to have set a valid value for the
*PITHOS_DATA* variable. For *pithos:* images, in addition to PITHOS_DATA,
*PITHOS_DATA* variable. For *pithos:* images, in addition to PITHOS_DATA,
the PITHOS_DB variable needs to contain a valid value.
the PITHOS_DB variable needs to contain a valid value
too
.
*
/etc/default/snf-image
*
may be used to set both values.
``
/etc/default/snf-image
``
may be used to set both values.
* **Null back-end**:
* **Null back-end**:
The null back-end is used if the *img_id* value is *null*. In this case no
The null back-end is used if the *img_id* value is *null*. In this case no
image copying is performed. This is
handy
if the hard disk already
contains
image copying is performed. This is
usefull
if the hard disk already
the image data
before *snf-image* is executed (for example if
the hard disk
contains an OS installation
before *snf-image* is executed (for example if
is a snapshot of an existing VM's hard disk).
the hard disk
is a snapshot of an existing VM's hard disk).
.. _image-properties:
.. _image-properties:
Image Properties
Image Properties
^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^
In order for snf-image to be able to properly configure an image, it may make
In order for
*
snf-image
*
to be able to properly configure an image, it may make
use of a set of image properties. Those image properties are passed to
use of a set of image properties. Those image properties are passed to
snf-image by Ganeti through the img_poroperties OS parameter (see Ganeti OS
*
snf-image
*
by Ganeti through the
*
img_poroperties
*
OS parameter (see Ganeti OS
Interface). The name of all image properties is case-insensitive. For the
Interface). The name of all image properties is case-insensitive. For the
diskdump format some properties are mandatory. For {ext,ntfs}dump formats all
diskdump format some properties are mandatory. For {ext,ntfs}dump formats all
image properties are optional.
image properties are optional.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment