Add admonition to telemetry code

This code is subject to change in the near future.  The alarm
class is probably moving out of here and many of the resource
property have aliases.  We have agreed not to support the old
aliases going forward, because it doesn't work well.  The
admonition can be pulled after these issues are fixed.

Closes-Bug: #1468086
Change-Id: Ica464a6c1e2281f4acbd25a121a399b6b0c81376

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.

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

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

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()

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'

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'

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'

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()

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()

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'