History

Sun Austin bb65ec36e6 FIX: module rename issue for Python 2/3 compatible code import six.moves to fix rename of urlparse and Queue Change-Id: Iee1b6053e4c1a174c40cfa858bf62557d308194a Story: 2004585 Task: 28446 Signed-off-by: Sun Austin <austin.sun@intel.com>		2019-01-15 00:33:13 +00:00
..
controllers	StarlingX open source release updates	2018-08-07 11:51:21 -04:00
proxy	FIX: module rename issue for Python 2/3 compatible code	2019-01-15 00:33:13 +00:00
README.rst	StarlingX open source release updates	2018-08-07 11:51:21 -04:00
__init__.py	StarlingX open source release updates	2018-08-07 11:51:21 -04:00
api_config.py	StarlingX open source release updates	2018-08-07 11:51:21 -04:00
app.py	StarlingX open source release updates	2018-08-07 11:51:21 -04:00
enforcer.py	StarlingX open source release updates	2018-08-07 11:51:21 -04:00

README.rst

api

DC Orchestrator API is Web Server Gateway Interface (WSGI) applications to receive and process API calls, including keystonemiddleware to do the authentication, parameter check and validation, convert API calls to job rpc message, and then send the job to DC Orchestrator Engine through the queue. If the job will be processed by DC Orchestrator Engine in synchronous way, the DC Orchestrator API will wait for the response from the DC Orchestrator Engine. Otherwise, the DC Orchestrator API will send response to the API caller first, and then send the job to DC Orchestrator Engine in asynchronous way.

Multiple DC Orchestrator API could run in parallel, and also can work in multi-worker mode.

Multiple DC Orchestrator API will be designed and run in stateless mode, persistent data will be accessed (read and write) from the DC Orchestrator Database through the DAL module.

Setup and encapsulate the API WSGI app

app.py:: Setup and encapsulate the API WSGI app, including integrate the keystonemiddleware app
apicfg.py:: API configuration loading and init
enforcer.py: Enforces policies on the version2 API's