[docs][2] Re-design docs to cover all user-groups

First pack of changes in upcoming chain to redesign Rally docs.
All information related to the installation and upgrades process
separated and refactored. Modified files fit 80 symbols margin
where possible.

[TODO] continue with other parts of the docs:
       - Quick start aka Rally step-by-step
       - Command Line Interface
       - Rally Task Component
       - Rally Verification Component
       - Rally Plugins, Rally Plugins Reference
       - Contribute to Rally
       - Request New Features
       - Project Info
[TODO] add 80 symbols margin check similar to what
       Performance Documentation has

Change-Id: I0075be010fcad98272cec0928bcd29ca7b655d33

devstack/README.rst

@@ -1,15 +1,30 @@
-===============================
+Rally with DevStack all-in-one installation
-Installing Rally using devstack
+-------------------------------------------
-===============================
 
-This directory contains the files necessary to integrate Rally with devstack.
+It is also possible to install Rally with DevStack. First, clone the
+corresponding repositories:
 
-To configure devstack to run rally edit ``${DEVSTACK_DIR}/local.conf`` file and add::
+.. code-block:: bash
+
+   git clone https://git.openstack.org/openstack-dev/devstack
+   git clone https://github.com/openstack/rally
+
+Then, configure DevStack to run Rally. First, create your ``local.conf`` file:
+
+.. code-block:: bash
+
+   cd devstack
+   cp samples/local.conf local.conf
+
+Next, edit local.conf: add the following line to the ``[[local|localrc]]``
+section.
+
+.. code-block:: bash
 
     enable_plugin rally https://github.com/openstack/rally master
 
-to the ``[[local|localrc]]`` section.
+Finally, run DevStack as usually:
 
-Run devstack as normal::
+.. code-block:: bash
 
-    $ ./stack.sh
+   ./stack.sh

doc/source/index.rst

@@ -37,13 +37,12 @@ Contents
    :maxdepth: 2
 
    overview/index
-   install
+   install_and_upgrade/index
    tutorial
    cli/cli_reference
    reports
    plugins
    plugin/plugin_reference
-   db_migrations
    contribute
    gates
    feature_requests

doc/source/install_and_upgrade/db_migrations.rst

@@ -0,0 +1 @@
+../../../rally/common/db/sqlalchemy/migrations/README.rst

doc/source/install_and_upgrade/index.rst

@@ -0,0 +1,24 @@
+..
+      Copyright 2015 Mirantis Inc. All Rights Reserved.
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+=========================
+Installation and upgrades
+=========================
+
+.. toctree::
+    :glob:
+
+    install
+    db_migrations

doc/source/install_and_upgrade/install.rst

@@ -0,0 +1,176 @@
+..
+      Copyright 2015 Mirantis Inc. All Rights Reserved.
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+.. _install:
+
+Installation process
+====================
+
+Automated installation
+----------------------
+
+The easiest way to install Rally is by executing its `installation script`_
+
+.. code-block:: bash
+
+    wget -q -O- https://raw.githubusercontent.com/openstack/rally/master/install_rally.sh | bash
+    # or using curl
+    curl https://raw.githubusercontent.com/openstack/rally/master/install_rally.sh | bash
+
+The installation script will also check if all the software required
+by Rally is already installed in your system; if run as **root** user
+and some dependency is missing it will ask you if you want to install
+the required packages.
+
+By default it will install Rally in a virtualenv in ``~/rally`` when
+run as standard user, or install system wide when run as root. You can
+install Rally in a **venv** by using the option ``--target``:
+
+.. code-block:: bash
+
+    ./install_rally.sh --target /foo/bar
+
+You can also install Rally system wide by running script as root and
+without ``--target`` option:
+
+.. code-block:: bash
+
+    sudo ./install_rally.sh
+
+
+Run ``./install_rally.sh`` with option ``--help`` to have a list of all
+available options:
+
+.. code-block:: console
+
+     $ ./install_rally.sh --help
+     Usage: install_rally.sh [options]
+
+     This script will install rally either in the system (as root) or in a virtual environment.
+
+    Options:
+      -h, --help             Print this help text
+      -v, --verbose          Verbose mode
+      -s, --system           Instead of creating a virtualenv, install as
+                             system package.
+      -d, --target DIRECTORY Install Rally virtual environment into DIRECTORY.
+                             (Default: $HOME/rally).
+      -f, --overwrite        Remove target directory if it already exists.
+      -y, --yes              Do not ask for confirmation: assume a 'yes' reply
+                             to every question.
+      -D, --dbtype TYPE      Select the database type. TYPE can be one of
+                             'sqlite', 'mysql', 'postgres'.
+                             Default: sqlite
+      --db-user USER         Database user to use. Only used when --dbtype
+                             is either 'mysql' or 'postgres'.
+      --db-password PASSWORD Password of the database user. Only used when
+                             --dbtype is either 'mysql' or 'postgres'.
+      --db-host HOST         Database host. Only used when --dbtype is
+                             either 'mysql' or 'postgres'
+      --db-name NAME         Name of the database. Only used when --dbtype is
+                             either 'mysql' or 'postgres'
+      -p, --python EXE       The python interpreter to use. Default: /usr/bin/python.
+
+
+**Notes:** the script will check if all the software required by Rally
+is already installed in your system. If this is not the case, it will
+exit, suggesting you the command to issue **as root** in order to
+install the dependencies.
+
+You also have to set up the **Rally database** after the installation is
+complete:
+
+.. code-block:: bash
+
+   rally-manage db recreate
+
+.. include:: ../../../devstack/README.rst
+
+Rally & Docker
+--------------
+
+First you need to install Docker; Docker supplies `installation
+instructions for various OSes`_.
+
+You can either use the official Rally Docker image, or build your own
+from the Rally source. To do that, change directory to the root directory of
+the Rally git repository and run:
+
+.. code-block:: bash
+
+    docker build -t myrally .
+
+If you build your own Docker image, substitute ``myrally`` for
+``rallyforge/rally`` in the commands below.
+
+The Rally Docker image is configured to store local settings and the
+database in the user's home directory. For persistence of these data,
+you may want to keep this directory outside of the container. This may
+be done via the following steps:
+
+.. code-block:: bash
+
+   sudo mkdir /var/lib/rally_container
+   sudo chown 65500 /var/lib/rally_container
+   docker run -it -v /var/lib/rally_container:/home/rally rallyforge/rally
+
+.. note::
+
+   In order for the volume to be accessible by the Rally user
+   (uid: 65500) inside the container, it must be accessible by UID
+   65500 *outside* the container as well, which is why it is created
+   in ``/var/lib/rally``. Creating it in your home directory is only
+   likely to work if your home directory has excessively open
+   permissions (e.g., ``0755``), which is not recommended.
+
+You can find all task samples, docs and certification tasks at /opt/rally/.
+Also you may want to save the last command as an alias:
+
+.. code-block:: bash
+
+   echo 'alias dock_rally="docker run -it -v /var/lib/rally_container:/home/rally rallyforge/rally"' >> ~/.bashrc
+
+After executing ``dock_rally``, or ``docker run ...``, you will have
+bash running inside the container with Rally installed. You may do
+anything with Rally, but you need to create the database first:
+
+.. code-block:: console
+
+   user@box:~/rally$ dock_rally
+   rally@1cc98e0b5941:~$ rally-manage db recreate
+   rally@1cc98e0b5941:~$ rally deployment list
+   There are no deployments. To create a new deployment, use:
+   rally deployment create
+   rally@1cc98e0b5941:~$
+
+In case you have SELinux enabled and Rally fails to create the
+database, try executing the following commands to put SELinux into
+Permissive Mode on the host machine
+
+.. code-block:: bash
+
+   sed -i 's/SELINUX=enforcing/SELINUX=permissive/' /etc/selinux/config
+   setenforce permissive
+
+Rally currently has no SELinux policy, which is why it must be run in
+Permissive mode for certain configurations. If you can help create an
+SELinux policy for Rally, please contribute!
+
+More about docker: https://www.docker.com/
+
+.. references:
+
+.. _installation script: https://raw.githubusercontent.com/openstack/rally/master/install_rally.sh
+.. _installation instructions for various OSes: https://docs.docker.com/installation/