airship
/
shipyard
Code Issues Proposed changes
shipyard/src/bin/shipyard_airflow/shipyard_airflow/control/helpers
History
Smruti Soumitra Khuntia 9c5270b616 User context tracing through logging 
This PS adds entry in log for user id and passes on the context
maker to other Airship components from Shipyard during API call.

This will ensure easy tracing of user and context through log
tracing.

Change-Id: Ib9bfa8f20b641f8bb6c2dca967d9388e30d5735c
 		2019-04-04 13:19:02 +00:00
..
README.rst Add deployment group validation to shipyard 2018-05-09 09:18:16 -05:00
__init__.py Add deployment group validation to shipyard 2018-05-09 09:18:16 -05:00
action_helper.py Add notes processing to the Shipyard API+CLI 2018-10-11 15:36:22 -05:00
configdocs_helper.py User context tracing through logging 2019-04-04 13:19:02 +00:00
deckhand_client.py User context tracing through logging 2019-04-04 13:19:02 +00:00
design_reference_helper.py [FIX] Correct design ref use with Drydock client 2018-08-22 09:51:34 -05:00
notes.py Add notes common code for Shipyard 2018-10-05 15:40:48 -05:00
status_helper.py User context tracing through logging 2019-04-04 13:19:02 +00:00
workflow_helper.py Add deployment group validation to shipyard 2018-05-09 09:18:16 -05:00

README.rst

Helper Modules

A home for the helper modules used by the various apis. While mostly the helpers are used by the api that encompasses the function - e.g. configdocs uses the configdocs helper, there are multiple cases where there's a need to cross between functions. One such example is the need for the action api's to need to use functionality related to configdocs. Rather than having depenedencies between the functional sections, this package serves as a place for the common dependencies encompassed into helper modules.

One major difference between the helpers and the api controllers is that helpers should never raise API errors, but rather App Errors or other non-http focused errors.

Note: The deckhand client module found in this package is intended to be (largely) replaced by use of the Deckhand client, when that refactoring can be accomplished.