diff --git a/neutron/agent/dhcp_agent.py b/neutron/agent/dhcp_agent.py index 41633a1e76f..4e2063aea1f 100644 --- a/neutron/agent/dhcp_agent.py +++ b/neutron/agent/dhcp_agent.py @@ -48,6 +48,16 @@ LOG = logging.getLogger(__name__) class DhcpAgent(manager.Manager): + """DHCP agent service manager. + + Note that the public methods of this class are exposed as the server side + of an rpc interface. The neutron server uses + neutron.api.rpc.agentnotifiers.dhcp_rpc_agent_api.DhcpAgentNotifyApi as the + client side to execute the methods here. For more information about + changing rpc interfaces, see doc/source/devref/rpc_api.rst. + """ + target = messaging.Target(version='1.0') + OPTS = [ cfg.IntOpt('resync_interval', default=5, help=_("Interval to resync.")), diff --git a/neutron/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py b/neutron/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py index 775f41352a7..815444305c5 100644 --- a/neutron/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py +++ b/neutron/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py @@ -28,7 +28,12 @@ LOG = logging.getLogger(__name__) class DhcpAgentNotifyAPI(object): - """API for plugin to notify DHCP agent.""" + """API for plugin to notify DHCP agent. + + This class implements the client side of an rpc interface. The server side + is neutron.agent.dhcp_agent.DhcpAgent. For more information about changing + rpc interfaces, please see doc/source/devref/rpc_api.rst. + """ # It seems dhcp agent does not support bulk operation VALID_RESOURCES = ['network', 'subnet', 'port'] VALID_METHOD_NAMES = ['network.create.end',