starlingx/distcloud
Code Issues Proposed changes
9bf56e9e30
distcloud/distributedcloud/dcorch/api
History
Hugo Brito 591726bea6 Remove the use_usm flag 
With the creation of the new CLI [1] command software-deploy-strategy,
the use_usm flag is no longer needed.

The following commits will be reverted after this is merged:
- https://review.opendev.org/c/starlingx/stx-puppet/+/890326
- https://review.opendev.org/c/starlingx/stx-puppet/+/891343

Test Plan:
PASS: Execute the software orchestration successfully.
- Use the new CLI [1] to execute software orchestration
- Verify create, show, apply, abort, and delete for new strategy type: software
- Software, load, and patching audits working properly.
PASS: Execute the upgrade orchestration
- Verify create, show, apply, abort, and delete for type: upgrade

1: https://review.opendev.org/c/starlingx/distcloud-client/+/908539

Story: 2010676
Task: 49556

Change-Id: I38c3868e054cf22dd986016ae5226aaf0e70dd67
Signed-off-by: Hugo Brito <hugo.brito@windriver.com>
2024-02-15 16:45:21 -03:00
..
controllers Update tox pylint/pep8 for dcorch 2024-01-18 10:48:08 -03:00
policies Implement access control for DC API 2022-09-22 18:26:35 -03:00
proxy Remove the use_usm flag 2024-02-15 16:45:21 -03:00
__init__.py Move content to subdir to support relocated packaging 2019-11-04 13:57:02 -05:00
api_config.py Move content to subdir to support relocated packaging 2019-11-04 13:57:02 -05:00
app.py Update tox pylint/pep8 for dcorch 2024-01-18 10:48:08 -03:00
policy.py Update tox pylint/pep8 for dcorch 2024-01-18 10:48:08 -03:00
README.rst Move content to subdir to support relocated packaging 2019-11-04 13:57:02 -05: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