From 177853a37107dcd568ae6ba34cc8217ef96e4c54 Mon Sep 17 00:00:00 2001 From: Eric K Date: Wed, 25 Jul 2018 13:22:08 -0700 Subject: [PATCH] Mark some drivers as unstable schema or unofficial Warn user that some new drivers have unstable schemas that can change in future releases. Unofficial drivers are those that interface with third party services but are not tested in CI. Change-Id: Ib5ded08166995a46ed21df9e7dc81fc503d41783 --- congress/datasources/monasca_driver.py | 4 ++++ congress/datasources/vitrage_driver.py | 4 ++++ doc/source/user/cloudservices.rst | 9 ++++++--- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/congress/datasources/monasca_driver.py b/congress/datasources/monasca_driver.py index b61727bf8..c01bfd078 100644 --- a/congress/datasources/monasca_driver.py +++ b/congress/datasources/monasca_driver.py @@ -206,6 +206,10 @@ class MonascaWebhookDriver(datasource_driver.PushedDataSourceDriver): TRANSLATORS = [alarm_notification_translator] def __init__(self, name='', args=None): + LOG.warning( + 'The Monasca webhook driver is classified as having unstable ' + 'schema. The schema may change in future releases in ' + 'backwards-incompatible ways.') super(MonascaWebhookDriver, self).__init__(name, args=args) if args is None: args = {} diff --git a/congress/datasources/vitrage_driver.py b/congress/datasources/vitrage_driver.py index c6a695b82..1cde174ff 100644 --- a/congress/datasources/vitrage_driver.py +++ b/congress/datasources/vitrage_driver.py @@ -80,6 +80,10 @@ class VitrageDriver(datasource_driver.PushedDataSourceDriver): TRANSLATORS = [webhook_alarm_translator] def __init__(self, name='', args=None): + LOG.warning( + 'The Vitrage driver is classified as having unstable schema. ' + 'The schema may change in future releases in ' + 'backwards-incompatible ways.') super(VitrageDriver, self).__init__(name, args=args) if args is None: args = {} diff --git a/doc/source/user/cloudservices.rst b/doc/source/user/cloudservices.rst index 1f30f83d9..fc9d87537 100644 --- a/doc/source/user/cloudservices.rst +++ b/doc/source/user/cloudservices.rst @@ -120,15 +120,18 @@ has a differing degree of coverage for the available API calls. - OpenStack Keystone (v2 & v3) - OpenStack Mistral - OpenStack Monasca + - OpenStack Monasca Webhook (unstable schema: may change in future release) - OpenStack Murano - OpenStack Neutron (v2) - OpenStack Neutron QoS - OpenStack Nova - OpenStack Swift - - Cloud Foundry - - Plexxi - - vCenter + - OpenStack Vitrage (unstable schema: may change in future release) - OPNFV Doctor + - Cloud Foundry (unofficial) + - Plexxi (unofficial) + - vCenter (unofficial) + Using the API or CLI, you can review the list of tables and columns that a driver supports. Roughly, you can think of each table as a collection of objects (like networks or servers),