Change the documentation layout
This changes the documentation layout according to the previously submitted spec. Change-Id: I9aa879af23ae4e993da60186eddaef8d22f59e79 Story: 2004179 Task: 28152
This commit is contained in:
parent
884977fbcf
commit
4b794472a8
@ -125,7 +125,7 @@ without modifying source code or Cloudkitty configuration file.
|
|||||||
|
|
||||||
The ``/etc/cloudkitty/metrics.yml`` file looks like this:
|
The ``/etc/cloudkitty/metrics.yml`` file looks like this:
|
||||||
|
|
||||||
.. literalinclude:: ../../../etc/cloudkitty/metrics.yml
|
.. literalinclude:: ../../../../etc/cloudkitty/metrics.yml
|
||||||
:language: yaml
|
:language: yaml
|
||||||
|
|
||||||
Conversion information is included in the yaml file.
|
Conversion information is included in the yaml file.
|
@ -5,4 +5,4 @@ policy.yaml
|
|||||||
Use the ``policy.yaml`` file to define additional access controls that apply to
|
Use the ``policy.yaml`` file to define additional access controls that apply to
|
||||||
the Rating service:
|
the Rating service:
|
||||||
|
|
||||||
.. literalinclude:: ../../_static/policy.yaml.sample
|
.. literalinclude:: ../../../_static/policy.yaml.sample
|
@ -5,6 +5,7 @@ Administration Guide
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
|
|
||||||
rating/introduction.rst
|
architecture
|
||||||
rating/hashmap.rst
|
quick_deployment/index
|
||||||
rating/pyscripts.rst
|
install/index
|
||||||
|
configuration/index
|
||||||
|
@ -35,7 +35,7 @@ etc/apache2/cloudkitty
|
|||||||
The ``etc/apache2/cloudkitty`` file contains example settings that
|
The ``etc/apache2/cloudkitty`` file contains example settings that
|
||||||
work with a copy of cloudkitty installed via devstack.
|
work with a copy of cloudkitty installed via devstack.
|
||||||
|
|
||||||
.. literalinclude:: ../../../etc/apache2/cloudkitty
|
.. literalinclude:: ../../../../etc/apache2/cloudkitty
|
||||||
|
|
||||||
1. On deb-based systems copy or symlink the file to
|
1. On deb-based systems copy or symlink the file to
|
||||||
``/etc/apache2/sites-available``. For rpm-based systems the file will go in
|
``/etc/apache2/sites-available``. For rpm-based systems the file will go in
|
@ -1,6 +1,5 @@
|
|||||||
#####################
|
|
||||||
DevStack installation
|
DevStack installation
|
||||||
#####################
|
=====================
|
||||||
|
|
||||||
Add the following lines in your ``local.conf`` file to enable CloudKitty with
|
Add the following lines in your ``local.conf`` file to enable CloudKitty with
|
||||||
gnocchi collector::
|
gnocchi collector::
|
6
doc/source/admin/quick_deployment/index.rst
Normal file
6
doc/source/admin/quick_deployment/index.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
Quick Deployment
|
||||||
|
================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
|
||||||
|
devstack
|
9
doc/source/api-reference/index.rst
Normal file
9
doc/source/api-reference/index.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
========================
|
||||||
|
CloudKitty API reference
|
||||||
|
========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
root
|
||||||
|
v1
|
@ -1,6 +1,5 @@
|
|||||||
=======================
|
|
||||||
HashMap Module REST API
|
HashMap Module REST API
|
||||||
=======================
|
-----------------------
|
||||||
|
|
||||||
.. rest-controller:: cloudkitty.rating.hash.controllers.root:HashMapConfigController
|
.. rest-controller:: cloudkitty.rating.hash.controllers.root:HashMapConfigController
|
||||||
:webprefix: /v1/rating/module_config/hashmap
|
:webprefix: /v1/rating/module_config/hashmap
|
@ -1,6 +1,5 @@
|
|||||||
=========================
|
|
||||||
PyScripts Module REST API
|
PyScripts Module REST API
|
||||||
=========================
|
-------------------------
|
||||||
|
|
||||||
.. rest-controller:: cloudkitty.rating.pyscripts.controllers.root:PyScriptsConfigController
|
.. rest-controller:: cloudkitty.rating.pyscripts.controllers.root:PyScriptsConfigController
|
||||||
:webprefix: /v1/rating/module_config/pyscripts
|
:webprefix: /v1/rating/module_config/pyscripts
|
@ -67,6 +67,9 @@ Rating
|
|||||||
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyResourceCollection
|
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyResourceCollection
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
.. include:: rating/hashmap.rst
|
||||||
|
|
||||||
|
.. include:: rating/pyscripts.rst
|
||||||
|
|
||||||
Report
|
Report
|
||||||
======
|
======
|
@ -1,10 +0,0 @@
|
|||||||
#############
|
|
||||||
API Reference
|
|
||||||
#############
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
|
|
||||||
webapi/root
|
|
||||||
webapi/v1
|
|
||||||
webapi/rating/*
|
|
@ -1,59 +0,0 @@
|
|||||||
digraph "CloudKitty's Architecture" {
|
|
||||||
|
|
||||||
// Graph parameters
|
|
||||||
label="CloudKitty's Internal Architecture";
|
|
||||||
node [shape=box];
|
|
||||||
compound=true;
|
|
||||||
|
|
||||||
// API
|
|
||||||
api [label="API"];
|
|
||||||
|
|
||||||
// Orchestrator
|
|
||||||
subgraph cluster_3 {
|
|
||||||
label="Orchestrator";
|
|
||||||
node[shape=none, width=1.3, height=0, label=""];
|
|
||||||
{rank=same; o1 -> o2 -> o3 [style=invis];}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Collector
|
|
||||||
ceilometer [label="Ceilometer"];
|
|
||||||
vendor [label="Vendor specific", style=dotted];
|
|
||||||
subgraph cluster_0 {
|
|
||||||
label="Collector";
|
|
||||||
style=dashed;
|
|
||||||
ceilometer -> vendor [style=invis];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rating
|
|
||||||
hashmap [label="HashMap module"];
|
|
||||||
r_others [label="Other modules...", style=dotted];
|
|
||||||
subgraph cluster_1 {
|
|
||||||
label="Rating engines";
|
|
||||||
style=dashed;
|
|
||||||
hashmap -> r_others [style=invis];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Write Orchestrator
|
|
||||||
w_orchestrator [label="Write Orchestrator"];
|
|
||||||
tdb [label="Transient DB"];
|
|
||||||
|
|
||||||
//Writers
|
|
||||||
osrf [label="OpenStack\nReference Format\n(json)"];
|
|
||||||
w_others [label="Other modules...", style=dotted];
|
|
||||||
subgraph cluster_2 {
|
|
||||||
label="Writers";
|
|
||||||
style=dashed;
|
|
||||||
osrf -> w_others [style=invis];
|
|
||||||
}
|
|
||||||
|
|
||||||
// Relations
|
|
||||||
api -> hashmap;
|
|
||||||
api -> r_others;
|
|
||||||
o1 -> ceilometer [dir=both, ltail=cluster_3, lhead=cluster_0];
|
|
||||||
o2 -> hashmap [dir=both, ltail=cluster_3, lhead=cluster_1];
|
|
||||||
o3 -> w_orchestrator [ltail=cluster_3];
|
|
||||||
w_orchestrator -> osrf [constraint=false];
|
|
||||||
w_orchestrator -> w_others [style=dotted, constraint=false];
|
|
||||||
w_orchestrator -> tdb;
|
|
||||||
}
|
|
||||||
|
|
@ -10,13 +10,32 @@ Welcome to CloudKitty's documentation!
|
|||||||
CloudKitty is a Rating As A Service project aimed at translating metrics
|
CloudKitty is a Rating As A Service project aimed at translating metrics
|
||||||
to prices.
|
to prices.
|
||||||
|
|
||||||
.. toctree::
|
.. list-table::
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
|
* - Documentation type
|
||||||
|
- Table of contents
|
||||||
|
|
||||||
|
* - **End User**
|
||||||
|
- .. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
user/index
|
||||||
|
|
||||||
|
* - **Admin / Operator**
|
||||||
|
- .. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
install/index
|
|
||||||
configuration/index
|
|
||||||
admin/index
|
admin/index
|
||||||
|
|
||||||
|
* - **Developer**
|
||||||
|
- .. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
developer/index
|
developer/index
|
||||||
devstack
|
|
||||||
arch
|
* - **API Reference**
|
||||||
api
|
- .. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
api-reference/index
|
||||||
|
8
doc/source/user/index.rst
Normal file
8
doc/source/user/index.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
==================
|
||||||
|
User documentation
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
rating/index
|
10
doc/source/user/rating/index.rst
Normal file
10
doc/source/user/rating/index.rst
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
======
|
||||||
|
Rating
|
||||||
|
======
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
introduction.rst
|
||||||
|
hashmap.rst
|
||||||
|
pyscripts.rst
|
Loading…
Reference in New Issue
Block a user