From ec3b8f7864321394e3bcb57b7fd6289ec2d7c27c Mon Sep 17 00:00:00 2001 From: Stavros Sachtouris Date: Tue, 18 Dec 2012 14:30:15 +0200 Subject: [PATCH] Prepent installation from package to source --- docs/installation.rst | 135 ++++++++++++++++++++++++++----------------------- docs/man/kamaki.rst | 4 +- 2 files changed, 74 insertions(+), 65 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index dc4f03f..42fe555 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -11,6 +11,69 @@ This guide describes the standard installation process for kamaki, with the aspi Linux and Unix-like enviroments ------------------------------- +Ubuntu and Debian packages +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following steps describe a command-line approach, but any graphic package manager can be used instead. + +Add the following to apt sources list +""""""""""""""""""""""""""""""""""""" + +As root, append one of the following to */etc/apt/sources.list*: + +* Debian Sid (kamaki 0.6.2):: + + deb http://apt.dev.grnet.gr/ sid main + +* Debian Stable (kamaki 0.6.1):: + + deb http://apt.dev.grnet.gr/ squeeze main + deb http://apt2.dev.grnet.gr stable/ + +* Ubuntu (kamaki 0.6.1):: + + deb http://apt.dev.grnet.gr/ precise main + + +Update +"""""" + +.. note:: make sure the GPG public key for the GRNET dev team is added: + + .. code-block:: console + + $ curl https://dev.grnet.gr/files/apt-grnetdev.pub|apt-key add - + + otherwise *apt-get update* will produce GPG warnings. + +.. code-block:: console + + $ sudo apt-get update + + +Install kamaki +"""""""""""""" + +.. note:: **versions 0.6.0 - 0.6.1:** + + The *snf-common* package (available at synnefo apt repository) will be automatically installed as a dependency. + +.. note:: **versions 0.6.2 and on:** + + Since version 0.6.2, *objpool* replaces *snf-common*. The objpool package is also available at synnefo repository and is automatically installed as a dependency. The *snf-common* dependency is removed. + +.. code-block:: console + + $ sudo apt-get install kamaki + +Install ansicolors and/or progress (Optional) +""""""""""""""""""""""""""""""""""""""""""""" + +.. code-block:: console + + $ sudo apt-get install python-ansicolors + $ sudo apt-get install python-progress + .. _installing-from-source-ref: Installing from source (git repos.) @@ -28,8 +91,8 @@ Optional: * VirtualEnv (python-virtualenv) [http://www.virtualenv.org] -1. Setup a virtual enviroment (optional) -"""""""""""""""""""""""""""""""""""""""" +Setup a virtual enviroment (optional) +""""""""""""""""""""""""""""""""""""" With virtualenv users can setup kamaki and synnefo services in a sandbox environment. @@ -40,8 +103,8 @@ With virtualenv users can setup kamaki and synnefo services in a sandbox environ A more detailed example of using virtual env can be found at the `snf-image-creator setup guide `_ -2. Install objpool (was: snf-common) -"""""""""""""""""""""""""""""""""""""""""" +Install objpool (was: snf-common) +""""""""""""""""""""""""""""""""" .. note:: **versions 0.6.0 - 0.6.1** @@ -65,8 +128,8 @@ Since 0.6.2, kamaki is based on objpool (hence the snf-common dependency is now $ ./setup build install $ cd - -3. Install kamaki -""""""""""""""""" +Install kamaki +"""""""""""""" .. code-block:: console @@ -74,8 +137,8 @@ Since 0.6.2, kamaki is based on objpool (hence the snf-common dependency is now $ cd kamaki $ ./setup build install -4. Install progress and/or ansicolors (optional) -"""""""""""""""""""""""""""""""""""""""""""""""" +Install progress and/or ansicolors (optional) +""""""""""""""""""""""""""""""""""""""""""""" progress: command-line progress bars (in some commands) @@ -86,60 +149,6 @@ ansicolors: color kamaki output (can switched on and off in `setup ` $ pip install progress $ pip install ansicolors -Ubuntu and Debian packages -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The following steps describe a command-line approach, but any graphic package manager can be used instead. - -1. Add the following to apt sources list -"""""""""""""""""""""""""""""""""""""""" - -* Debian:: - - deb http://apt.dev.grnet.gr/ sid main - -* Ubuntu:: - - deb http://apt.dev.grnet.gr/ precise main - -2. Update -""""""""" - -.. code-block:: console - - $ sudo apt-get update - -.. note:: Don't forget to get the GPG public key for the GRNET dev team: - - .. code-block:: console - - $ curl https://dev.grnet.gr/files/apt-grnetdev.pub|apt-key add - - - otherwise *apt-get update* will produce GPG warnings. - -3. Install kamaki -""""""""""""""""" - -.. note:: **versions 0.6.0 - 0.6.1:** - - The *snf-common* package (available at synnefo apt repository) will be automatically installed as a dependency. - -.. note:: **versions 0.6.2 and on:** - - Since version 0.6.2, *objpool* replaces *snf-common*. The objpool package is also available at synnefo repository and is automatically installed as a dependency. The *snf-common* dependency is removed. - -.. code-block:: console - - $ sudo apt-get install kamaki - -4. Install ansicolors and/or progress (Optional) -"""""""""""""""""""""""""""""""""""""""""""""""" - -.. code-block:: console - - $ sudo apt-get install python-ansicolors - $ sudo apt-get install python-progress - Mac OS X -------- @@ -148,4 +157,4 @@ Kamaki can be installed on Mac OS X systems from source, by following the steps Windows ------- -Although it is proven not too tricky to install kamaki on Windows console using `git for windows `_, Windows environments are not supported at the time being. +Since version 0.6.2 kamaki can run on Windows, either on standard Windows console, or inside an improved command line shell. diff --git a/docs/man/kamaki.rst b/docs/man/kamaki.rst index bb1ff9f..1652893 100644 --- a/docs/man/kamaki.rst +++ b/docs/man/kamaki.rst @@ -85,9 +85,9 @@ history commands Command user history, as stored in ~/.kamaki.history -* all show user history +* show show user history * clean clean up history -* load Run previously executed command(s) +* run run previously executed command(s) server commands -- 1.7.10.4