Merge "Clean up README.rst"
This commit is contained in:
Zuul
Gerrit Code Review
commit
acb6a580ec
133
README.rst
133
README.rst
|
|
@ -10,128 +10,21 @@ Team and repository tags
|
|||
Python bindings to the Monasca API
|
||||
==================================
|
||||
|
||||
.. image:: https://img.shields.io/pypi/v/python-monascaclient.svg
|
||||
:target: https://pypi.python.org/pypi/python-monascaclient/
|
||||
:alt: Latest Version
|
||||
|
||||
This is a client library for Monasca built to interface with the Monasca API.
|
||||
It provides a Python API (the ``monascaclient`` module) and a command-line tool
|
||||
(``monasca``).
|
||||
|
||||
The Monasca Client was written using the OpenStack Heat Python client as a
|
||||
framework.
|
||||
* License: Apache License, Version 2.0
|
||||
* `PyPi`_ - package installation
|
||||
* `Online Documentation`_
|
||||
* `Bugs`_ - issue tracking (we use *bug* tag to differentiate from new features)
|
||||
* `Source`_
|
||||
|
||||
.. contents:: Contents:
|
||||
:local:
|
||||
|
||||
Ubuntu Install
|
||||
--------------
|
||||
Requires::
|
||||
|
||||
pip - version >= 1.4. python get-pip.py
|
||||
|
||||
See versions on PYPI:
|
||||
https://pypi.org/project/python-monascaclient/
|
||||
|
||||
Install It::
|
||||
|
||||
sudo pip install python-monascaclient
|
||||
|
||||
Alternative Manual Install Steps::
|
||||
|
||||
cd <path to your python-monascaclient repo>
|
||||
|
||||
sudo pip install -r requirements.txt
|
||||
|
||||
python setup.py install
|
||||
|
||||
Building and Packaging
|
||||
----------------------
|
||||
Install the tool dependencies::
|
||||
|
||||
sudo apt-get install python-pip python-virtualenv
|
||||
|
||||
In the python-monascaclient source directory::
|
||||
|
||||
virtualenv --no-site-packages .venv
|
||||
|
||||
source ./.venv/bin/activate
|
||||
|
||||
pip install wheel
|
||||
|
||||
python setup.py bdist_wheel
|
||||
|
||||
pip install $(ls -1rt dist/*.whl | tail -1) --upgrade
|
||||
|
||||
Command-line API
|
||||
----------------
|
||||
Installing this distribution gets you a shell command, ``monasca``, that you
|
||||
can use to interact with the Monitoring API server.
|
||||
|
||||
Usage:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
monasca
|
||||
|
||||
monasca help
|
||||
|
||||
monasca help <command>
|
||||
|
||||
This outputs the results in json format. Normally output is in table format.
|
||||
|
||||
|
||||
The monascaclient CLI needs the Monasca API endpoint url and the OS_AUTH_TOKEN
|
||||
to pass to the Monasca API RESTful interface. This is provided through
|
||||
environment or CLI parameters.
|
||||
|
||||
Environmental Variables
|
||||
=======================
|
||||
|
||||
Environmental variables can be sourced, or optionally passed in as CLI
|
||||
arguments. It is easiest to source them first and then use the CLI.
|
||||
|
||||
When token and endpoint are known::
|
||||
|
||||
export OS_AUTH_TOKEN=XXX
|
||||
export MONASCA_API_URL=http://192.168.10.4:8070/v2.0/
|
||||
|
||||
When using Keystone to obtain the token and endpoint::
|
||||
|
||||
export OS_USERNAME=
|
||||
export OS_PASSWORD=
|
||||
export OS_USER_DOMAIN_NAME=
|
||||
export OS_PROJECT_NAME=
|
||||
export OS_AUTH_URL=
|
||||
export OS_REGION_NAME=
|
||||
# Optional(specific version added to OS_AUTH_URL if (v2.0 or v3) not present already)
|
||||
export OS_AUTH_VERSION=
|
||||
|
||||
When OS_USER_DOMAIN_NAME is not set, then 'Default' is assumed. Alternatively
|
||||
IDs can be used instead of names.
|
||||
Although *deprecated*, but OS_TENANT_NAME and OS_TENANT_ID can be used for
|
||||
OS_PROEJCT_NAME and OS_PROJECT_ID respectively.
|
||||
|
||||
When using Vagrant Environment with middleware disabled::
|
||||
|
||||
export OS_AUTH_TOKEN=82510970543135
|
||||
export OS_NO_CLIENT_AUTH=1
|
||||
export MONASCA_API_URL=http://192.168.10.4:8070/v2.0/
|
||||
|
||||
The Monasca API will treat the auth token as the tenant ID when Keystone is not
|
||||
enabled.
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
(C) Copyright 2014-2016 Hewlett Packard Enterprise Development LP
|
||||
Copyright 2017 Fujitsu LIMITED
|
||||
|
||||
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.
|
||||
.. _PyPi: https://pypi.python.org/pypi/python-monascaclient
|
||||
.. _Online Documentation: https://docs.openstack.org/python-monascaclient/latest/
|
||||
.. _Bugs: https://storyboard.openstack.org/#!/project/880
|
||||
.. _Source: https://git.openstack.org/cgit/openstack/python-monascaclient
|
||||
|
|
|
|||
|
|
@ -25,6 +25,7 @@ User Documentation
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
installation
|
||||
cli/index
|
||||
reference/index
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
At the command line, from PyPI::
|
||||
|
||||
$ pip install python-monascaclient
|
||||
|
||||
Or, if you have virtualenvwrapper installed::
|
||||
|
||||
$ mkvirtualenv python-monascaclient
|
||||
$ pip install python-monascaclient
|
||||
|
||||
Or, you can build it manually::
|
||||
|
||||
$ mkvirtualenv python-monascaclient
|
||||
$ git clone git://git.openstack.org/openstack/python-monascaclient
|
||||
$ cd python-monascaclient
|
||||
$ pip install -r ./requirements.txt
|
||||
$ python setup.py install
|
||||
Loading…
Reference in New Issue