openstack/cloudkitty
Code Issues Proposed changes

Fix some mistake and format in docs

Browse Source 
Change-Id: I4280d50412c4915aa085c5c1d8f449d0dc323161
This commit is contained in:
Aaron-DH 2017-02-22 14:48:25 +08:00
parent b31b196f66
commit efa7e69154
3 changed files with 29 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/arch.rst
View File

@ -2,7 +2,7 @@
CloudKitty's Architecture CloudKitty's Architecture
========================= =========================
CloudKitty can be cut in four big parts: CloudKitty can be cut in five big parts:
* API * API
* Data collection (collector) * Data collection (collector)
@ -110,6 +110,10 @@ Example of minimal rating module (taken from the Noop module):
""" """
return True return True
@property
def priority(self):
return 1
def reload_config(self): def reload_config(self):
pass pass

14
doc/source/installation.rst
View File

@ -59,9 +59,9 @@ Install the dashboard module
PY_PACKAGES_PATH=`pip --version | cut -d' ' -f4` PY_PACKAGES_PATH=`pip --version | cut -d' ' -f4`
#. Add the enabled file to the horizon settings or installation. Depending on #. Add the enabled file to the horizon settings or installation.
your setup, you might need to add it to ``/usr/share`` or directly in the Depending on your setup, you might need to add it to ``/usr/share`` or
horizon python package:: directly in the horizon python package::
# If horizon is installed by packages: # If horizon is installed by packages:
ln -sf $PY_PACKAGES_PATH/cloudkittydashboard/enabled/_[0-9]*.py \ ln -sf $PY_PACKAGES_PATH/cloudkittydashboard/enabled/_[0-9]*.py \
@ -170,8 +170,8 @@ For keystone (identity) API v2 (deprecated)
Please note that: Please note that:
* `http://localhost:5000/v2.0`and `http://localhost:35357/v2.0` are your * `http://localhost:5000/v2.0` and `http://localhost:35357/v2.0` are your
identity endpoints. identity endpoints.
* the tenant named `service` is also commonly called `services` * the tenant named `service` is also commonly called `services`
@ -227,8 +227,8 @@ The following shows the basic configuration items:
Please note that: Please note that:
* `http://localhost:5000/v3`and `http://localhost:35357/v3` are your identity * `http://localhost:5000/v3` and `http://localhost:35357/v3` are your identity
endpoints. endpoints.
* the tenant named `service` is also commonly called `services` * the tenant named `service` is also commonly called `services`

18
doc/source/rating/introduction.rst
View File

@ -10,8 +10,24 @@ operator can set the priority for a module. The order in which the modules
process the data depends on their priority. The module with the highest process the data depends on their priority. The module with the highest
priority comes first. priority comes first.
List current modules
====================
List current rating modules:
.. code:: raw
$ cloudkitty module-list
+-----------+---------+----------+
| Module | Enabled | Priority |
+-----------+---------+----------+
| hashmap | False | 1 |
| noop | True | 1 |
| pyscripts | True | 1 |
+-----------+---------+----------+
Enable or disable module Enable or disable module
========================== ========================
Enable the hashmap rating module: Enable the hashmap rating module: