cinder/cinder/volume/targets/driver.py

68 lines
2.2 KiB
Python

# 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
from oslo_config import cfg
CONF = cfg.CONF
class Target(object, metaclass=abc.ABCMeta):
"""Target object for block storage devices.
Base class for target object, where target
is data transport mechanism (target) specific calls.
This includes things like create targets, attach, detach
etc.
Base class here does nothing more than set an executor and db as
well as force implementation of required methods.
"""
def __init__(self, *args, **kwargs):
self.db = kwargs.get('db')
self.configuration = kwargs.get('configuration')
self._root_helper = kwargs.get('root_helper',
'sudo cinder-rootwrap %s' %
CONF.rootwrap_config)
@abc.abstractmethod
def ensure_export(self, context, volume, volume_path):
"""Synchronously recreates an export for a volume."""
pass
@abc.abstractmethod
def create_export(self, context, volume, volume_path):
"""Exports a Target/Volume.
Can optionally return a Dict of changes to
the volume object to be persisted.
"""
pass
@abc.abstractmethod
def remove_export(self, context, volume):
"""Removes an export for a Target/Volume."""
pass
@abc.abstractmethod
def initialize_connection(self, volume, connector):
"""Allow connection to connector and return connection info."""
pass
@abc.abstractmethod
def terminate_connection(self, volume, connector, **kwargs):
"""Disallow connection from connector."""
pass