diff --git a/doc/source/users/guides/telemetry.rst b/doc/source/users/guides/telemetry.rst index 8aff342af..cf7acae04 100644 --- a/doc/source/users/guides/telemetry.rst +++ b/doc/source/users/guides/telemetry.rst @@ -1,6 +1,9 @@ Using OpenStack Telemetry ========================= +.. caution:: + BETA: This API is a work in progress and is subject to change. + Before working with the Telemetry service, you'll need to create a connection to your OpenStack cloud by following the :doc:`connect` user guide. This will provide you with the ``conn`` variable used in the examples below. diff --git a/doc/source/users/proxies/telemetry.rst b/doc/source/users/proxies/telemetry.rst index def33157b..ebd8d88de 100644 --- a/doc/source/users/proxies/telemetry.rst +++ b/doc/source/users/proxies/telemetry.rst @@ -1,6 +1,9 @@ Telemetry API ============= +.. caution:: + BETA: This API is a work in progress and is subject to change. + For details on how to use telemetry, see :doc:`/users/guides/telemetry` .. automodule:: openstack.telemetry.v2._proxy diff --git a/openstack/telemetry/v2/_proxy.py b/openstack/telemetry/v2/_proxy.py index 2ec224c03..87e5e8e9b 100644 --- a/openstack/telemetry/v2/_proxy.py +++ b/openstack/telemetry/v2/_proxy.py @@ -21,6 +21,7 @@ from openstack.telemetry.v2 import statistics class Proxy(proxy.BaseProxy): + """.. caution:: This API is a work in progress and is subject to change.""" def create_alarm(self, **attrs): """Create a new alarm from attributes diff --git a/openstack/telemetry/v2/alarm.py b/openstack/telemetry/v2/alarm.py index 04f2f23c8..0738f1164 100644 --- a/openstack/telemetry/v2/alarm.py +++ b/openstack/telemetry/v2/alarm.py @@ -16,6 +16,7 @@ from openstack import utils class Alarm(resource.Resource): + """.. caution:: This API is a work in progress and is subject to change.""" id_attribute = 'alarm_id' base_path = '/alarms' service = telemetry_service.TelemetryService() diff --git a/openstack/telemetry/v2/alarm_change.py b/openstack/telemetry/v2/alarm_change.py index c06d86ae6..1bf726ede 100644 --- a/openstack/telemetry/v2/alarm_change.py +++ b/openstack/telemetry/v2/alarm_change.py @@ -15,6 +15,7 @@ from openstack.telemetry import telemetry_service class AlarmChange(resource.Resource): + """.. caution:: This API is a work in progress and is subject to change.""" id_attribute = 'event_id' resource_key = 'alarm_change' base_path = '/alarms/%(alarm_id)s/history' diff --git a/openstack/telemetry/v2/capability.py b/openstack/telemetry/v2/capability.py index a76f844d4..70e706b11 100644 --- a/openstack/telemetry/v2/capability.py +++ b/openstack/telemetry/v2/capability.py @@ -17,6 +17,7 @@ from openstack.telemetry import telemetry_service class Capability(resource.Resource): + """.. caution:: This API is a work in progress and is subject to change.""" resource_key = 'capability' resources_key = 'capabilities' base_path = '/capabilities' diff --git a/openstack/telemetry/v2/meter.py b/openstack/telemetry/v2/meter.py index f27e8b5ad..80d1e4404 100644 --- a/openstack/telemetry/v2/meter.py +++ b/openstack/telemetry/v2/meter.py @@ -15,6 +15,7 @@ from openstack.telemetry import telemetry_service class Meter(resource.Resource): + """.. caution:: This API is a work in progress and is subject to change.""" id_attribute = 'meter_id' resource_key = 'meter' base_path = '/meters' diff --git a/openstack/telemetry/v2/resource.py b/openstack/telemetry/v2/resource.py index aca75413a..e9c7cc0c4 100644 --- a/openstack/telemetry/v2/resource.py +++ b/openstack/telemetry/v2/resource.py @@ -15,6 +15,7 @@ from openstack.telemetry import telemetry_service class Resource(resource.Resource): + """.. caution:: This API is a work in progress and is subject to change.""" id_attribute = 'resource_id' base_path = '/resources' service = telemetry_service.TelemetryService() diff --git a/openstack/telemetry/v2/sample.py b/openstack/telemetry/v2/sample.py index bc6f09561..914ab91cb 100644 --- a/openstack/telemetry/v2/sample.py +++ b/openstack/telemetry/v2/sample.py @@ -14,6 +14,7 @@ from openstack.telemetry import telemetry_service class Sample(resource.Resource): + """.. caution:: This API is a work in progress and is subject to change.""" id_attribute = 'sample_id' base_path = '/meters/%(counter_name)s' service = telemetry_service.TelemetryService() diff --git a/openstack/telemetry/v2/statistics.py b/openstack/telemetry/v2/statistics.py index be4672f14..170a9bf26 100644 --- a/openstack/telemetry/v2/statistics.py +++ b/openstack/telemetry/v2/statistics.py @@ -15,6 +15,7 @@ from openstack.telemetry import telemetry_service class Statistics(resource.Resource): + """.. caution:: This API is a work in progress and is subject to change.""" id_attribute = 'meter_name' resource_key = 'statistics' base_path = '/meters/%(meter_name)s/statistics'