Modify dhcp agent for agent management extension

2nd part of blueprint quantum-scheduler

Remove openstack openstack listener on DHCP agent side.
Add DHCPagent notifier on quantum server side.

Change-Id: I196691650a99ba865bf06081a1fc4546f9fac7bd

quantum/api/rpc/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (c) 2013 OpenStack, LLC.
+#
+# 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.

quantum/api/rpc/agentnotifiers/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (c) 2013 OpenStack, LLC.
+#
+# 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.

quantum/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py

@@ -0,0 +1,70 @@
+# Copyright (c) 2013 OpenStack, LLC.
+#
+# 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.
+
+from quantum.common import topics
+from quantum.openstack.common import log as logging
+from quantum.openstack.common.rpc import proxy
+
+
+LOG = logging.getLogger(__name__)
+
+
+class DhcpAgentNotifyAPI(proxy.RpcProxy):
+    """API for plugin to notify DHCP agent."""
+    BASE_RPC_API_VERSION = '1.0'
+    # It seems dhcp agent does not support bulk operation
+    VALID_RESOURCES = ['network', 'subnet', 'port']
+    VALID_METHOD_NAMES = ['network.create.end',
+                          'network.update.end',
+                          'network.delete.end',
+                          'subnet.create.end',
+                          'subnet.update.end',
+                          'subnet.delete.end',
+                          'port.create.end',
+                          'port.update.end',
+                          'port.delete.end']
+
+    def __init__(self, topic=topics.DHCP_AGENT):
+        super(DhcpAgentNotifyAPI, self).__init__(
+            topic=topic, default_version=self.BASE_RPC_API_VERSION)
+
+    def _notification(self, context, method, payload):
+        """Notify all the agents that are hosting the network"""
+        # By now, we have no scheduling feature, so we fanout
+        # to all of the DHCP agents
+        self._notification_fanout(context, method, payload)
+
+    def _notification_fanout(self, context, method, payload):
+        """Fanout the payload to all dhcp agents"""
+        self.fanout_cast(
+            context, self.make_msg(method,
+                                   payload=payload),
+            topic=topics.DHCP_AGENT)
+
+    def notify(self, context, data, methodname):
+        # data is {'key' : 'value'} with only one key
+        if methodname not in self.VALID_METHOD_NAMES:
+            return
+        obj_type = data.keys()[0]
+        if obj_type not in self.VALID_RESOURCES:
+            return
+        obj_value = data[obj_type]
+        methodname = methodname.replace(".", "_")
+        if methodname.endswith("_delete_end"):
+            if 'id' in obj_value:
+                self._notification(context, methodname,
+                                   {obj_type + '_id': obj_value['id']})
+        else:
+            self._notification(context, methodname, data)

quantum/api/v2/base.py

@@ -18,6 +18,9 @@
 import netaddr
 import webob.exc
 
+from oslo.config import cfg
+
+from quantum.api.rpc.agentnotifiers import dhcp_rpc_agent_api
 from quantum.api.v2 import attributes
 from quantum.api.v2 import resource as wsgi_resource
 from quantum.common import exceptions
@@ -94,6 +97,7 @@ class Controller(object):
         self._policy_attrs = [name for (name, info) in self._attr_info.items()
                               if info.get('required_by_policy')]
         self._publisher_id = notifier_api.publisher_id('network')
+        self._dhcp_agent_notifier = dhcp_rpc_agent_api.DhcpAgentNotifyAPI()
         self._member_actions = member_actions
 
         if parent:
@@ -193,6 +197,10 @@ class Controller(object):
             policy.enforce(request.context, action, obj, plugin=self._plugin)
         return obj
 
+    def _send_dhcp_notification(self, context, data, methodname):
+        if cfg.CONF.dhcp_agent_notification:
+            self._dhcp_agent_notifier.notify(context, data, methodname)
+
     def index(self, request, **kwargs):
         """Returns a list of the requested entity"""
         parent_id = kwargs.get(self._parent_id_name)
@@ -298,11 +306,15 @@ class Controller(object):
                                          **kwargs)
 
         def notify(create_result):
+            notifier_method = self._resource + '.create.end'
             notifier_api.notify(request.context,
                                 self._publisher_id,
-                                self._resource + '.create.end',
+                                notifier_method,
                                 notifier_api.CONF.default_notification_level,
                                 create_result)
+            self._send_dhcp_notification(request.context,
+                                         create_result,
+                                         notifier_method)
             return create_result
 
         kwargs = {self._parent_id_name: parent_id} if parent_id else {}
@@ -348,11 +360,16 @@ class Controller(object):
 
         obj_deleter = getattr(self._plugin, action)
         obj_deleter(request.context, id, **kwargs)
+        notifier_method = self._resource + '.delete.end'
         notifier_api.notify(request.context,
                             self._publisher_id,
-                            self._resource + '.delete.end',
+                            notifier_method,
                             notifier_api.CONF.default_notification_level,
                             {self._resource + '_id': id})
+        result = {self._resource: self._view(obj)}
+        self._send_dhcp_notification(request.context,
+                                     result,
+                                     notifier_method)
 
     def update(self, request, id, body=None, **kwargs):
         """Updates the specified entity's attributes"""
@@ -398,11 +415,15 @@ class Controller(object):
             kwargs[self._parent_id_name] = parent_id
         obj = obj_updater(request.context, id, **kwargs)
         result = {self._resource: self._view(obj)}
+        notifier_method = self._resource + '.update.end'
         notifier_api.notify(request.context,
                             self._publisher_id,
-                            self._resource + '.update.end',
+                            notifier_method,
                             notifier_api.CONF.default_notification_level,
                             result)
+        self._send_dhcp_notification(request.context,
+                                     result,
+                                     notifier_method)
         return result
 
     @staticmethod