161326fe06
Readthedocs failed to render Drydock exceptions with error: > WARNING: autodoc: failed to import exception xxx from module > 'drydock_provisioner'; the following exception was raised: No module > named 'drydock_provisioner' Trying to add Drydock requirements to the installed requirements list, so that Readthedocs has all modules, including those needed for the Drydock itself. Unify docs building by utilizing Zuul docs-on-readthedocs template job. Cosmetic readability changes: 1. combined all Makefile .PHONY targets into one 2. merged multiple LABEL instructions in Dockerfile into one Change-Id: I6a9b47cffc66d739968fa886c51e25b1e09ef124
34 lines
881 B
ReStructuredText
34 lines
881 B
ReStructuredText
.. _validatedesign:
|
|
|
|
Validate Design
|
|
===============
|
|
|
|
The Drydock Validation API is a set of logic checks that must be passed before any information from the YAMLs will be
|
|
processed by Drydock. These checks are performed synchronously and will return a message list with a success or
|
|
failures for each check.
|
|
|
|
Formatting
|
|
----------
|
|
|
|
This document can be POSTed to the Drydock validatedesign to validate a set of documents that have been
|
|
processed by Deckhand::
|
|
|
|
{
|
|
rel : "design",
|
|
href: "deckhand+https://{{deckhand_url}}/revisions/{{revision_id}}/rendered-documents",
|
|
type: "application/x-yaml"
|
|
}
|
|
|
|
v1.0
|
|
----
|
|
|
|
Validation Checks
|
|
^^^^^^^^^^^^^^^^^
|
|
|
|
These checks are meant to check the business logic of documents sent to the validatedesign API.
|
|
|
|
.. currentmodule:: drydock_provisioner.orchestrator.validations.validator
|
|
|
|
.. autoclass:: Validator
|
|
:members:
|