Merge "Add telemetry resource docs"
This commit is contained in:
@@ -100,6 +100,7 @@ The following services have exposed *Resource* classes.
|
|||||||
Network <resources/network/index>
|
Network <resources/network/index>
|
||||||
Orchestration <resources/orchestration/index>
|
Orchestration <resources/orchestration/index>
|
||||||
Object Store <resources/object_store/index>
|
Object Store <resources/object_store/index>
|
||||||
|
Telemetry <resources/telemetry/index>
|
||||||
Volume <resources/volume/index>
|
Volume <resources/volume/index>
|
||||||
|
|
||||||
Low-Level Classes
|
Low-Level Classes
|
||||||
|
|||||||
13
doc/source/users/resources/telemetry/index.rst
Normal file
13
doc/source/users/resources/telemetry/index.rst
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
Telemetry Resources
|
||||||
|
===================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
v2/alarm
|
||||||
|
v2/alarm_change
|
||||||
|
v2/capability
|
||||||
|
v2/meter
|
||||||
|
v2/resource
|
||||||
|
v2/sample
|
||||||
|
v2/statistics
|
||||||
12
doc/source/users/resources/telemetry/v2/alarm.rst
Normal file
12
doc/source/users/resources/telemetry/v2/alarm.rst
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
openstack.telemetry.v2.alarm
|
||||||
|
============================
|
||||||
|
|
||||||
|
.. automodule:: openstack.telemetry.v2.alarm
|
||||||
|
|
||||||
|
The Alarm Class
|
||||||
|
---------------
|
||||||
|
|
||||||
|
The ``Alarm`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
.. autoclass:: openstack.telemetry.v2.alarm.Alarm
|
||||||
|
:members:
|
||||||
12
doc/source/users/resources/telemetry/v2/alarm_change.rst
Normal file
12
doc/source/users/resources/telemetry/v2/alarm_change.rst
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
openstack.telemetry.v2.alarm_change
|
||||||
|
===================================
|
||||||
|
|
||||||
|
.. automodule:: openstack.telemetry.v2.alarm_change
|
||||||
|
|
||||||
|
The AlarmChange Class
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
The ``AlarmChange`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
.. autoclass:: openstack.telemetry.v2.alarm_change.AlarmChange
|
||||||
|
:members:
|
||||||
12
doc/source/users/resources/telemetry/v2/capability.rst
Normal file
12
doc/source/users/resources/telemetry/v2/capability.rst
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
openstack.telemetry.v2.capability
|
||||||
|
=================================
|
||||||
|
|
||||||
|
.. automodule:: openstack.telemetry.v2.capability
|
||||||
|
|
||||||
|
The Capability Class
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
The ``Capability`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
.. autoclass:: openstack.telemetry.v2.capability.Capability
|
||||||
|
:members:
|
||||||
12
doc/source/users/resources/telemetry/v2/meter.rst
Normal file
12
doc/source/users/resources/telemetry/v2/meter.rst
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
openstack.telemetry.v2.meter
|
||||||
|
============================
|
||||||
|
|
||||||
|
.. automodule:: openstack.telemetry.v2.meter
|
||||||
|
|
||||||
|
The Meter Class
|
||||||
|
----------------
|
||||||
|
|
||||||
|
The ``Meter`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
.. autoclass:: openstack.telemetry.v2.meter.Meter
|
||||||
|
:members:
|
||||||
12
doc/source/users/resources/telemetry/v2/resource.rst
Normal file
12
doc/source/users/resources/telemetry/v2/resource.rst
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
openstack.telemetry.v2.resource
|
||||||
|
===============================
|
||||||
|
|
||||||
|
.. automodule:: openstack.telemetry.v2.resource
|
||||||
|
|
||||||
|
The Resource Class
|
||||||
|
------------------
|
||||||
|
|
||||||
|
The ``Resource`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
.. autoclass:: openstack.telemetry.v2.resource.Resource
|
||||||
|
:members:
|
||||||
12
doc/source/users/resources/telemetry/v2/sample.rst
Normal file
12
doc/source/users/resources/telemetry/v2/sample.rst
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
openstack.telemetry.v2.sample
|
||||||
|
=============================
|
||||||
|
|
||||||
|
.. automodule:: openstack.telemetry.v2.sample
|
||||||
|
|
||||||
|
The Sample Class
|
||||||
|
----------------
|
||||||
|
|
||||||
|
The ``Sample`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
.. autoclass:: openstack.telemetry.v2.sample.Sample
|
||||||
|
:members:
|
||||||
12
doc/source/users/resources/telemetry/v2/statistics.rst
Normal file
12
doc/source/users/resources/telemetry/v2/statistics.rst
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
openstack.telemetry.v2.statistics
|
||||||
|
=================================
|
||||||
|
|
||||||
|
.. automodule:: openstack.telemetry.v2.statistics
|
||||||
|
|
||||||
|
The Statistics Class
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
The ``Statistics`` class inherits from :class:`~openstack.resource.Resource`.
|
||||||
|
|
||||||
|
.. autoclass:: openstack.telemetry.v2.statistics.Statistics
|
||||||
|
:members:
|
||||||
Reference in New Issue
Block a user