a75fe3d7cc
"storage_availability_zone" in the [DEFAULT] section of manila's configuration file has allowed deployers to configure and manage both service (scheduler, share manager) and storage system availability. However, quite often manila's services (api, scheduler, share and data managers) are run on a dedicated control plane that is a different failure domain from that of the storage that manila manages. Also, when using share replication, deployers would need to run multiple manila share manager services with different configuration files, each with their own "storage_availability_zone". To allow flexibility of separating service and storage availability zones, we introduce a new configuration option "backend_availability_zone" within the share driver/backend section. When this option is used, it will override the value of the "storage_availability_zone" from the [DEFAULT] section. Change-Id: Ice99a880dd7be7af94dea86b31a6db88be3d7d9b Implements: bp per-backend-availability-zones
149 lines
5.3 KiB
Python
149 lines
5.3 KiB
Python
# Copyright 2010 United States Government as represented by the
|
|
# Administrator of the National Aeronautics and Space Administration.
|
|
# 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.
|
|
|
|
"""Base Manager class.
|
|
|
|
Managers are responsible for a certain aspect of the system. It is a logical
|
|
grouping of code relating to a portion of the system. In general other
|
|
components should be using the manager to make changes to the components that
|
|
it is responsible for.
|
|
|
|
For example, other components that need to deal with volumes in some way,
|
|
should do so by calling methods on the VolumeManager instead of directly
|
|
changing fields in the database. This allows us to keep all of the code
|
|
relating to volumes in the same place.
|
|
|
|
We have adopted a basic strategy of Smart managers and dumb data, which means
|
|
rather than attaching methods to data objects, components should call manager
|
|
methods that act on the data.
|
|
|
|
Methods on managers that can be executed locally should be called directly. If
|
|
a particular method must execute on a remote host, this should be done via rpc
|
|
to the service that wraps the manager
|
|
|
|
Managers should be responsible for most of the db access, and
|
|
non-implementation specific data. Anything implementation specific that can't
|
|
be generalized should be done by the Driver.
|
|
|
|
In general, we prefer to have one manager with multiple drivers for different
|
|
implementations, but sometimes it makes sense to have multiple managers. You
|
|
can think of it this way: Abstract different overall strategies at the manager
|
|
level(FlatNetwork vs VlanNetwork), and different implementations at the driver
|
|
level(LinuxNetDriver vs CiscoNetDriver).
|
|
|
|
Managers will often provide methods for initial setup of a host or periodic
|
|
tasks to a wrapping service.
|
|
|
|
This module provides Manager, a base class for managers.
|
|
|
|
"""
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log
|
|
from oslo_service import periodic_task
|
|
|
|
from manila.db import base
|
|
from manila.scheduler import rpcapi as scheduler_rpcapi
|
|
from manila import version
|
|
|
|
CONF = cfg.CONF
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
class PeriodicTasks(periodic_task.PeriodicTasks):
|
|
def __init__(self):
|
|
super(PeriodicTasks, self).__init__(CONF)
|
|
|
|
|
|
class Manager(base.Base, PeriodicTasks):
|
|
|
|
@property
|
|
def RPC_API_VERSION(self):
|
|
"""Redefine this in child classes."""
|
|
raise NotImplementedError
|
|
|
|
@property
|
|
def target(self):
|
|
"""This property is used by oslo_messaging.
|
|
|
|
https://wiki.openstack.org/wiki/Oslo/Messaging#API_Version_Negotiation
|
|
"""
|
|
if not hasattr(self, '_target'):
|
|
import oslo_messaging as messaging
|
|
self._target = messaging.Target(version=self.RPC_API_VERSION)
|
|
return self._target
|
|
|
|
def __init__(self, host=None, db_driver=None):
|
|
if not host:
|
|
host = CONF.host
|
|
self.host = host
|
|
self.additional_endpoints = []
|
|
self.availability_zone = CONF.storage_availability_zone
|
|
super(Manager, self).__init__(db_driver)
|
|
|
|
def periodic_tasks(self, context, raise_on_error=False):
|
|
"""Tasks to be run at a periodic interval."""
|
|
return self.run_periodic_tasks(context, raise_on_error=raise_on_error)
|
|
|
|
def init_host(self):
|
|
"""Handle initialization if this is a standalone service.
|
|
|
|
Child classes should override this method.
|
|
|
|
"""
|
|
pass
|
|
|
|
def service_version(self, context):
|
|
return version.version_string()
|
|
|
|
def service_config(self, context):
|
|
config = {}
|
|
for key in CONF:
|
|
config[key] = CONF.get(key, None)
|
|
return config
|
|
|
|
|
|
class SchedulerDependentManager(Manager):
|
|
"""Periodically send capability updates to the Scheduler services.
|
|
|
|
Services that need to update the Scheduler of their capabilities
|
|
should derive from this class. Otherwise they can derive from
|
|
manager.Manager directly. Updates are only sent after
|
|
update_service_capabilities is called with non-None values.
|
|
|
|
"""
|
|
|
|
def __init__(self, host=None, db_driver=None, service_name='undefined'):
|
|
self.last_capabilities = None
|
|
self.service_name = service_name
|
|
self.scheduler_rpcapi = scheduler_rpcapi.SchedulerAPI()
|
|
super(SchedulerDependentManager, self).__init__(host, db_driver)
|
|
|
|
def update_service_capabilities(self, capabilities):
|
|
"""Remember these capabilities to send on next periodic update."""
|
|
self.last_capabilities = capabilities
|
|
|
|
@periodic_task.periodic_task
|
|
def _publish_service_capabilities(self, context):
|
|
"""Pass data back to the scheduler at a periodic interval."""
|
|
if self.last_capabilities:
|
|
LOG.debug('Notifying Schedulers of capabilities ...')
|
|
self.scheduler_rpcapi.update_service_capabilities(
|
|
context,
|
|
self.service_name,
|
|
self.host,
|
|
self.last_capabilities)
|