airship
/
shipyard
Code Issues Proposed changes
shipyard/src/bin/shipyard_airflow/shipyard_airflow/control/helpers
History
Carter, Matthew (mc981n) 0761099337 Validate existence of "deployment-version" during create configdocs 
This PS adds funtionality to Shipyard to validate the existence of
the Pegleg-generated "deployment-version" document (Pegleg change id:
I7919b02d70c9797f689cdad85066d3953b978901) when a user runs create
configdocs. This validation only checks the presence of the document
(by name and schema) and does not care about the document's other
contents.
The severity of a failed validation is configurable through the
"validations" config section in shipyard.conf. The default severity
is "Skip", meaning the validation is not ran at all.

Note that with the default configuration of new validation, Shipyard
functionality should be unchanged.

Change-Id: I754617de81f628a24232e890b12b157ba6731c25
 		2019-05-09 08:33:52 -05: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 Validate existence of "deployment-version" during create configdocs 2019-05-09 08:33:52 -05: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.