8e98f42349
The update_service_capabilities method of this class has been unused since it was disabled as a periodic task in commit 674ef05b0ac668e16529a3ddc2b8fe26dc729dad. The compute manager's update to a v3 rpc api removed the last references to publishing capabilities, so this can now be completely removed. After removing the capabilities bits, the only value left in this class was providing an instance of the scheduler rpcapi class. This seemed like overkill, so I removed this class completely and added the scheduler rpcapi instance to the compute manager directly. Related to blueprint rpc-major-version-updates-icehouse Related to blueprint no-compute-fanout-to-scheduler Change-Id: I72fd16fc96938a9ea9d509e24319a5273de900a9
130 lines
4.9 KiB
Python
130 lines
4.9 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# 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 nova import baserpc
|
|
from nova.db import base
|
|
from nova import notifier
|
|
from nova.objects import base as objects_base
|
|
from nova.openstack.common import log as logging
|
|
from nova.openstack.common import periodic_task
|
|
from nova.openstack.common.rpc import dispatcher as rpc_dispatcher
|
|
|
|
|
|
CONF = cfg.CONF
|
|
CONF.import_opt('host', 'nova.netconf')
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class Manager(base.Base, periodic_task.PeriodicTasks):
|
|
# Set RPC API version to 1.0 by default.
|
|
RPC_API_VERSION = '1.0'
|
|
|
|
def __init__(self, host=None, db_driver=None, service_name='undefined'):
|
|
if not host:
|
|
host = CONF.host
|
|
self.host = host
|
|
self.backdoor_port = None
|
|
self.service_name = service_name
|
|
self.notifier = notifier.get_notifier(self.service_name, self.host)
|
|
super(Manager, self).__init__(db_driver)
|
|
|
|
def create_rpc_dispatcher(self, backdoor_port=None, additional_apis=None):
|
|
'''Get the rpc dispatcher for this manager.
|
|
|
|
If a manager would like to set an rpc API version, or support more than
|
|
one class as the target of rpc messages, override this method.
|
|
'''
|
|
apis = []
|
|
if additional_apis:
|
|
apis.extend(additional_apis)
|
|
base_rpc = baserpc.BaseRPCAPI(self.service_name, backdoor_port)
|
|
apis.extend([self, base_rpc])
|
|
serializer = objects_base.NovaObjectSerializer()
|
|
return rpc_dispatcher.RpcDispatcher(apis, serializer)
|
|
|
|
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):
|
|
"""Hook to do additional manager initialization when one requests
|
|
the service be started. This is called before any service record
|
|
is created.
|
|
|
|
Child classes should override this method.
|
|
"""
|
|
pass
|
|
|
|
def pre_start_hook(self):
|
|
"""Hook to provide the manager the ability to do additional
|
|
start-up work before any RPC queues/consumers are created. This is
|
|
called after other initialization has succeeded and a service
|
|
record is created.
|
|
|
|
Child classes should override this method.
|
|
"""
|
|
pass
|
|
|
|
def post_start_hook(self):
|
|
"""Hook to provide the manager the ability to do additional
|
|
start-up work immediately after a service creates RPC consumers
|
|
and starts 'running'.
|
|
|
|
Child classes should override this method.
|
|
"""
|
|
pass
|