Ask Your Question

Quantum API Call Chain Mechanism

asked 2013-04-02 02:54:07 -0600

anonymous user


updated 2013-06-05 01:18:03 -0600

fifieldt gravatar image

I want to know the exact call chain that occurs when an api call is made on quantum and how it is executed by the quantum server. For example, how is the quantum net-create net1 command executed What is the call chain that follows is something that i am looking for. Also, i would be interested in knowing the exact files that are used in this process. Thank you.

edit retag flag offensive close merge delete



Have you looked a the source code, the answer should be there for you.

smaffulli gravatar imagesmaffulli ( 2013-04-03 19:50:15 -0600 )edit

1 answer

Sort by ยป oldest newest most voted

answered 2013-04-04 06:00:57 -0600

Salvatore gravatar image

Unfortunately Quantum does not have detailed developer documentation that help understand what's going on without having to analyse the code.

I would dare to say that an easy way to look at Quantum API call stacks it to look at the logs. There's already plenty of logging when debug mode is enabled, and that might help you identifying the modules which participate in dispatching API calls. Further, you can add your own logging to get even more details. I remember I used this approach a loooong time ago to understand how the garbage collector worked inside the JVM, and quantum is an awful lot simpler than that!

However, in a nutshell the mechanism works as follows:

  • The main binary, quantum-server does a series of calls which create and start a wsgi server:
  • The application that the server will run is created using pastedeploy:
  • api-paste.ini specifies the factory method which creates the app:
  • The above method return an instance of the APIRouter class: This class wires instance of the generic Controller class to the various Quantum core API resources using the routes package.

NOTE: the init mechanism for extension is similar, even if the code paths are different

The last step (the mapping performed by the RouteMapper) is what allow a REST call like POST /networks to be dispatched onto a call to the create() method in the instance of the Controller class for the 'networks' resource.

Once the method is dispatched to the controller, several things happen, which can be summarized as follow: - Request authorization using policy engine - Input validation - Dispatch to plugin - for instance create() on 'networks' resource gets converted into create_network() on the plugin class - Output view formatting

Note that serialization/deserialization is performed in the WSGI layer. Requests sent to API controller are already deserialized; the API controller return un-serialized data.

edit flag offensive delete link more

Get to know Ask OpenStack

Resources for moderators

Question Tools

1 follower


Asked: 2013-04-02 02:54:07 -0600

Seen: 283 times

Last updated: Apr 04 '13