commit ffc6ed50698bb658d001a5cac66709e56d11cdc8 Author: Sheel Rana Date: Mon Sep 28 08:38:18 2020 +0900 Updated install/manual_installation contents Aligned install/manual_installation.rst file contents for better readability/understanding. Change-Id: I7333ccf1c6b9408170967d2e2e6e7619002dae9c diff --git a/doc/source/install/manual_installation.rst b/doc/source/install/manual_installation.rst index abcab54..f18bbab 100644 --- a/doc/source/install/manual_installation.rst +++ b/doc/source/install/manual_installation.rst @@ -23,25 +23,26 @@ This document describes how to install and run Tacker manually. .. note:: - User is supposed to install on Ubuntu. Some examples are invalid on other - distirbutions. For example, you should replace ``/usr/local/bin/`` with - ``/usr/bin/`` on CentOS. + This installation guide contents are specific to Ubuntu distro. + Some steps in this installation guide may be invalid for other + distributions. For example, you should replace ``/usr/local/bin/`` + with ``/usr/bin/`` on CentOS. Pre-requisites -------------- #. Install required components. - Ensure that OpenStack components, Keystone, Mistral, Barbican and - Horizon are installed. Refer the list below for installation of - these OpenStack projects on different Operating Systems. + Ensure that all required OpenStack components i.e. Keystone, Mistral, + Barbican and Horizon are installed. Refer the list below for installation + of these OpenStack components on different Operating Systems. * https://docs.openstack.org/keystone/latest/install/index.html * https://docs.openstack.org/mistral/latest/admin/install/index.html * https://docs.openstack.org/barbican/latest/install/install.html * https://docs.openstack.org/horizon/latest/install/index.html -#. Create ``admin-openrc.sh`` for env variables. +#. Create ``admin-openrc.sh`` for environment variables. .. code-block:: shell @@ -62,8 +63,8 @@ Installing Tacker Server .. note:: - The ```` in command examples is replaced with specific branch - name, such as ``stable/ussuri``. + Make sure to replace the ```` in command examples with + specific branch name, such as ``stable/ussuri``. #. Create MySQL database and user. @@ -71,7 +72,7 @@ Installing Tacker Server $ mysql -uroot -p - Create database ``tacker`` and grant provileges for ``tacker`` user with + Create database ``tacker`` and grant privileges to ``tacker`` user with password ```` on all tables. .. code-block:: @@ -123,7 +124,7 @@ Installing Tacker Server $ openstack endpoint create --region RegionOne nfv-orchestration \ admin http://:9890/ - Or keystone v2: + For keystone v2: .. code-block:: console @@ -134,7 +135,7 @@ Installing Tacker Server #. Clone tacker repository. - You can use ``-b`` for specific release optionally. + You can use ``-b`` for specific release, optionally. .. code-block:: console @@ -151,7 +152,7 @@ Installing Tacker Server #. Create directories for tacker. - Directories log, VNF packages and csar files are required. + Directories for storing logs, vnf packages and csar files are required. .. code-block:: console @@ -261,6 +262,8 @@ Install Tacker Client #. Clone ``tacker-client`` repository. + You can use ``-b`` for specific release, optionally. + .. code-block:: console $ cd ~/ @@ -278,6 +281,8 @@ Install Tacker horizon #. Clone ``tacker-horizon`` repository. + You can use ``-b`` for specific release, optionally. + .. code-block:: console $ cd ~/ @@ -322,3 +327,4 @@ required because the console will be locked by a running process. .. code-block:: console $ sudo systemctl start tacker-conductor.service +