Merge "Base class for a configuration driver"

oslo_config/sources/__init__.py

@@ -0,0 +1,42 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+import abc
+import six
+
+
+@six.add_metaclass(abc.ABCMeta)
+class ConfigurationSourceDriver(object):
+    """A config driver option for Oslo.config.
+
+    Represents an oslo.config driver to allow store configuration data in
+    other places, such as secret stores managed by a proper key management
+    store solution.
+
+    """
+
+    @abc.abstractmethod
+    def open_source_from_opt_group(self, conf, group_name):
+        """Return an open option source.
+
+        Use group_name to find the configuration settings for the new
+        source then open the source and return it.
+
+        If a source cannot be open, raise an appropriate exception.
+
+        :param conf: The active configuration option handler from which
+                     to seek configuration values.
+        :type conf: ConfigOpts
+        :param group_name: The configuration option group name where the
+                           options for the source are stored.
+        :type group_name: str
+        :returns: an instance of a subclass of ConfigurationSource
+        """