RPC: Add documentation and namespaces to interfaces

Registered by Russell Bryant on 2014-12-08

This blueprint aims to enhance the existing usage of oslo.messaging to make the
version scheme more clear to developers. Several people have expressed that the
current code is difficult to understand, so this spec aims to improve that.

Blueprint information

Status:
Complete
Approver:
Kyle Mestery
Priority:
Low
Drafter:
Russell Bryant
Direction:
Approved
Assignee:
Russell Bryant
Definition:
Approved
Series goal:
Accepted for kilo
Implementation:
Implemented
Milestone target:
milestone icon 2015.1.0
Started by
Kyle Mestery on 2014-12-18
Completed by
Kyle Mestery on 2015-02-13

Related branches

Sprints

Whiteboard

Once these two reviews merge, I would consider this complete. --russellb, Feb 10
 - https://review.openstack.org/149735
 - https://review.openstack.org/154670

Feb 4 (russellb): There are more patches. I'll wrap it up in kilo-3. How about I put this in "Good Progress" and move to "needs code review" when all patches are posted.

February-3 (mestery): Moving this to Kilo-3, looks like one patch is left according to LP, but I'm not sure if Russell has more patches after that.

December-18 (mestery): Kilo-2.

Gerrit topic: https://review.openstack.org/#q,topic:bp/rpc-docs-and-namespaces,n,z

Addressed by: https://review.openstack.org/140510
    Update rpc_api docs with example version update

Addressed by: https://review.openstack.org/140511
    Move dhcp rpc api into a namespace

Addressed by: https://review.openstack.org/142564
    Provide doc string pointers for the dhcp agent rpc api

Addressed by: https://review.openstack.org/142898
    Scope metadata rpc api using a messaging namespace

Addressed by: https://review.openstack.org/147900
    Create SecurityGroupServerRpcApi and add some docs

Addressed by: https://review.openstack.org/147901
    bigswitch: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/147902
    hyperv: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/147903
    nec: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/147904
    ofagent: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/147905
    oneconvergence: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/147906
    ovs: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/147907
    tests: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/149022
    linuxbridge: untangle SecurityGroupAgentRpcMixin

Addressed by: https://review.openstack.org/149023
    linuxbridge: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/149033
    mlnx: untangle SecurityGroupAgentRpcMixin

Addressed by: https://review.openstack.org/149034
    mlnx: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/149052
    sriovnicagent: untangle SecurityGroupAgentRpcMixin

Addressed by: https://review.openstack.org/149053
    sriovnicagent: drop usage of SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/149054
    Drop SecurityGroupServerRpcApiMixin

Addressed by: https://review.openstack.org/149348
    Add SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149349
    linuxbridge: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149350
    openvswitch: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149351
    mlnx: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149352
    nec: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149353
    ofagent: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149354
    oneconvergence: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149355
    sriovnicagent: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149356
    bigswitch: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149377
    hyperv: drop useless messaging.Target on HyperVSecurityAgent

Addressed by: https://review.openstack.org/149378
    hyperv: use SecurityGroupAgentRpc

Addressed by: https://review.openstack.org/149379
    Remove SecurityGroupAgentRpcMixin

Addressed by: https://review.openstack.org/149390
    Scope secgroup rpc api using a messaging namespace

Addressed by: https://review.openstack.org/149734
    Use DVRServerRpcApi instead of a mixin

Addressed by: https://review.openstack.org/149735
    Scope dvr rpc api using a messaging namespace

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.