Revision fa479dc3 docs/installation.rst

b/docs/installation.rst
1 1
Installation
2 2
============
3 3

  
4
This guide describes the standard installation process for kamaki, with the aspiration of covering as much cases as possible. Although kamaki was initially targeted to advanced Linux/Unix-like users, it should be quite straightforward to install and have it up and running in most popular platforms.
4
This guide describes the standard installation process for kamaki, with the
5
aspiration of covering as much cases as possible. Although kamaki was initially
6
targeted to Linux/Unix-like users, it is quite straightforward to install and
7
have it up and running in all platforms running python 2.6 or 2.7.
5 8

  
6 9

  
7 10
* Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
8 11

  
9 12
* Kamaki at pypi: `http://pypi.python.org/pypi/kamaki <https://pypi.python.org/pypi/kamaki>`_
10 13

  
11
* Synnefo Linux packages: `http://apt2.dev.grnet.gr <http://apt2.dev.grnet.gr>`_
14
* Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
12 15

  
13 16
Linux and Unix-like enviroments
14 17
-------------------------------
......
20 23

  
21 24
* As root, append the following to */etc/apt/sources.list* ::
22 25

  
23
    deb http://apt2.dev.grnet.gr stable/
26
    deb http://apt.dev.grnet.gr wheezy/
27

  
28
.. warning:: Debian Squeeze users may replace "wheezy" with "squeeze"
24 29

  
25 30
* Make sure the GPG public key for the Synnefo development team is added:
26 31

  
......
94 99

  
95 100
Essential:
96 101

  
97
 * Python 2.6 or better [http://www.python.org]
102
 * Python 2.6 or 2.7 [http://www.python.org]
98 103
 * Python setuptools [http://pypi.python.org/pypi/setuptools]
99 104

  
100 105
Optional:
......
104 109
Setup a virtual enviroment (optional)
105 110
"""""""""""""""""""""""""""""""""""""
106 111

  
107
With virtualenv users can setup kamaki and synnefo services in a sandbox environment.
112
With virtualenv users can setup kamaki and synnefo services in a sandbox
113
environment.
108 114

  
109 115
.. code-block:: console
110 116

  
111 117
    $ virtualenv kamaki-env
112 118
    $ source kamaki-env/bin/activate
113 119

  
114
A more detailed example of using virtual env can be found at the `snf-image-creator setup guide <http://www.synnefo.org/docs/snf-image-creator/latest/install.html#python-virtual-environment>`_
120
A more detailed example of using virtual env can be found at the 
121
`snf-image-creator setup guide <http://www.synnefo.org/docs/snf-image-creator/latest/install.html#python-virtual-environment>`_
115 122

  
116 123
Install kamaki
117 124
""""""""""""""
......
120 127

  
121 128
    $ pip install kamaki
122 129

  
123
Install ansicolors
124
""""""""""""""""""
130
Install ansicolors (optional)
131
"""""""""""""""""""""""""""""
125 132

  
126 133
The **ansicolors** package is not required for running kamaki, but it is
127 134
recommended as a user experience improvement. In specific, ansicolors
......
131 138

  
132 139
    $ pip install ansicolors
133 140

  
134
Install mock
135
""""""""""""
141
Install mock (developers only)
142
""""""""""""""""""""""""""""""
136 143

  
137
The **mock** package is needed for running the prepared unit-tests in the kamaki.clients
138
package. This feature is useful when extendnig / debugging kamaki functionality and is
139
aimed to kamaki developers and contributors. Therefore, users can enjoy the full kamaki
140
user experience without installing mock.
144
The **mock** package is needed for running the prepared unit-tests in the
145
kamaki.clients package. This feature is useful when extending / debugging
146
kamaki functionality and is aimed to kamaki developers and contributors.
147
Therefore, users can enjoy the full kamaki user experience without installing
148
mock.
141 149

  
142 150
.. code-block:: console
143 151

  
......
148 156
Mac OS X
149 157
--------
150 158

  
151
Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-pypi-ref`.
159
Kamaki can be installed on Mac OS X systems from source, by following the steps
160
at :ref:`installing-from-pypi-ref`.
152 161

  
153 162
Windows
154 163
-------
155 164

  
156
Kamaki can be installed on Windows by following the pypi method. Installing the requirements is a bit different than in other systems. 
165
Kamaki can be installed on Windows by following the pypi method. Installing the
166
requirements is a bit different than in other systems. 
157 167

  
158 168
The full process is detailed in the following:
159 169

  
......
164 174

  
165 175
* Setuptools (`Official versions and workarounds <http://pypi.python.org/pypi/setuptools>`_)
166 176

  
167
Users who have already set up python and setuptools (e.g. for another project) may skip python and / or setup tools installation.
177
Users who have already set up and wokring python and setuptools (e.g. for
178
another project) may skip python and / or setup tools installation.
168 179

  
169 180
Install python
170 181
^^^^^^^^^^^^^^
171 182

  
172
Download and run the Windows installer from `here <http://www.python.org/getit>`_
183
Download and run the Windows installer from
184
`here <http://www.python.org/getit>`_
173 185

  
174
Users should pick the installer that fits their windows version and architecture.
186
Users should pick the installer that fits their windows version and machine
187
architecture.
175 188

  
176 189
Add python to windows path
177 190
^^^^^^^^^^^^^^^^^^^^^^^^^^
178 191

  
179
The following will allow users to run python and python scripts from command line.
192
The following will allow users to run python and python scripts from command
193
line.
180 194

  
181
* Select **System** from the Control Panel, select the **Advanced** tab, the **Environment Variables** button and then find the **PATH** (user or system) and **edit**
195
* Select **System** from the Control Panel, select the **Advanced** tab, the
196
    **Environment Variables** button and then find the **PATH** (user or
197
    system) and **edit**
182 198

  
183 199
* Without removing existing values, append the following to PATH::
184 200

  
185
    C:\Python;C:\Python\Scripts
201
    ;C:\Python27;C:\Python27\Scripts
186 202

  
187 203
.. note:: Path values are separated by semicolons
188 204

  
189
.. warning:: C:\\Python should be replaced with the actual python path in the system, e.g. C:\\Python27
205
.. warning:: In case of a different version, C:\\Python27 should be replaced
206
    with the actual python path in the system
190 207

  
191 208
Install setuptools
192 209
^^^^^^^^^^^^^^^^^^
193 210

  
194
According to the corresponding `python org page <http://pypi.python.org/pypi/setuptools>`_, the setuptools installer doesn't currently work on 64bit machines.
211
According to the corresponding
212
`python org page <http://pypi.python.org/pypi/setuptools>`_, the setuptools
213
installer doesn't currently work on 64bit machines.
195 214

  
196
* Users with 32-bit operating systems should download and run the graphic installer
215
* Users with 32-bit operating systems should download and run the graphic
216
    installer
197 217

  
198
* Users with 64-bit machines should download the `ez_setup.py <http://peak.telecommunity.com/dist/ez_setup.py>`_ script and install it from a command shell. In the following example, the script was downloaded at C:\\Downloads::
218
* Users with 64-bit machines should download the
219
    `ez_setup.py <http://peak.telecommunity.com/dist/ez_setup.py>`_ script and
220
    install it from a command shell. In the following example, the script was
221
    downloaded at C:\\Downloads::
199 222

  
200
    C:\> cd Downloads
201
    C:\Downloads\> python ez_setup.py
202
    ...
203
    Installation finished
204
    C:\Downloads\>
223
        C:\> cd Downloads
224
        C:\Downloads\> python ez_setup.py
225
        ...
226
        Installation finished
227
        C:\Downloads\>
205 228

  
206 229
Install kamaki
207 230
^^^^^^^^^^^^^^
208 231

  
209 232
.. code-block:: console
210 233

  
211
    $ easy_setup kamaki
234
    $ easy_install kamaki

Also available in: Unified diff