e7b40242f8
This is the start of an effort to both validate that drivers fully implement the expected minimum requirements as well as to create a clear place for driver developers to learn what needs to be implemented and get documentation explaining what is expected for each method. This also enables us to create tooling for documenting the available drivers and their capabilities, to some degree. A follow up patch will show some of what I'm thinking there, but it will make it possible to write scripts for different needs. This is somewhat a cleanup attempt to the ABC work that was started a while back. This does not aim to replace that effort, but give a mechanism for some of the things expected out of that effort that ended up not being possible with how it evolved. In most cases we do not really care if a driver is inherited from a certain base class, just that it conforms to the given interface. The interface/inheritance work really centers around two separate things: * Ensuring drivers conform to an expected interface * Allowing code reuse and common implementation This is really for the first item. Additional work is needed to complete the ABC work we've done, but that really focuses on the second item, and is out of scope for the intent of this patch. Change-Id: I4168225126fe88c31712d94f0a130e9e7ede3446
79 lines
2.5 KiB
Python
79 lines
2.5 KiB
Python
# Copyright 2016 Dell Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
#
|
|
|
|
"""
|
|
Core fibre channel zone manager driver interface.
|
|
|
|
All fczm drivers should support this interface as a bare minimum.
|
|
"""
|
|
|
|
from cinder.interface import base
|
|
|
|
|
|
class FibreChannelZoneManagerDriver(base.CinderInterface):
|
|
"""FCZM driver required interface."""
|
|
|
|
def add_connection(self, fabric, initiator_target_map, host_name=None,
|
|
storage_system=None):
|
|
"""Add a new initiator<>target connection.
|
|
|
|
All implementing drivers should provide concrete implementation
|
|
for this API.
|
|
|
|
:param fabric: Fabric name from cinder.conf file
|
|
:param initiator_target_map: Mapping of initiator to list of targets
|
|
|
|
.. code-block:: python
|
|
|
|
Example initiator_target_map:
|
|
|
|
{
|
|
'10008c7cff523b01': ['20240002ac000a50', '20240002ac000a40']
|
|
}
|
|
|
|
Note that WWPN can be in lower or upper case and can be ':'
|
|
separated strings.
|
|
"""
|
|
|
|
def delete_connection(self, fabric, initiator_target_map, host_name=None,
|
|
storage_system=None):
|
|
"""Delete an initiator<>target connection.
|
|
|
|
:param fabric: Fabric name from cinder.conf file
|
|
:param initiator_target_map: Mapping of initiator to list of targets
|
|
|
|
.. code-block:: python
|
|
|
|
Example initiator_target_map:
|
|
|
|
{
|
|
'10008c7cff523b01': ['20240002ac000a50', '20240002ac000a40']
|
|
}
|
|
|
|
Note that WWPN can be in lower or upper case and can be ':'
|
|
separated strings.
|
|
"""
|
|
|
|
def get_san_context(self, target_wwn_list):
|
|
"""Get SAN context for end devices.
|
|
|
|
:param target_wwn_list: Mapping of initiator to list of targets
|
|
|
|
Example initiator_target_map: ['20240002ac000a50', '20240002ac000a40']
|
|
Note that WWPN can be in lower or upper case and can be
|
|
':' separated strings.
|
|
"""
|