Updated operator guide documentation for 1. added indexing to list sections appropriately 2. populated CLI section using 'cliff.sphinxext' extension 3. removed 'Module Index' section since displaying 404 Change-Id: I17061a1e5456d027a555dc94dc8ac1a6dd802421
37 lines
973 B
ReStructuredText
37 lines
973 B
ReStructuredText
============
|
|
Installation
|
|
============
|
|
|
|
**Note:** The paths we are using for configuration files in these steps
|
|
are with reference to Ubuntu Operating System. The paths may vary for
|
|
other Operating Systems.
|
|
|
|
The branch_name which is used in commands, specify the branch_name
|
|
as stable/<branch> for any stable branch installation. For eg:
|
|
stable/queens, stable/pike. If unspecified the default will be
|
|
master branch.
|
|
|
|
Using python install
|
|
====================
|
|
Clone and install python-masakariclient repository.::
|
|
|
|
$ cd ~/
|
|
$ git clone https://github.com/openstack/python-masakariclient -b <branch_name>
|
|
$ cd python-masakariclient
|
|
$ sudo python setup.py install
|
|
|
|
|
|
Using pip
|
|
=========
|
|
|
|
You can also install the latest version by using ``pip`` command:::
|
|
|
|
$ pip install python-masakariclient
|
|
|
|
|
|
Or, if it is needed to install ``python-masakariclient`` from master branch,
|
|
type::
|
|
|
|
$ pip install git+https://github.com/openstack/python-masakariclient.git
|
|
|