c69f29e92f
This PS updates all Deckhand documentation to be sphinx-compliant so that it can be rendered into HTML automatically for hosting. This PS also removes deprecated/redundant/unhelpful documentation and upates README to a bit more informative and helpful. The design.md file has been broken up into different sections with deckhand/docs for easier consumption. Change-Id: I44afcd22a7f5f05e44563342bb98b30fd806f598
2.4 KiB
Document Validation
Validations
The validation system provides a unified approach to complex validations that require coordination of multiple documents and business logic that resides in consumer services.
Services can report success or failure of named validations for a
given revision. Those validations can then be referenced by many
ValidationPolicy control documents. The intended purpose
use is to allow a simple mapping that enables consuming services to be
able to quickly check whether the configuration in Deckhand is in a
valid state for performing a specific action.
Deckhand-Provided Validations
In addition to allowing 3rd party services to report configurable validation statuses, Deckhand provides a few internal validations which are made available immediately upon document ingestion.
Here is a list of internal validations:
deckhand-document-schema-validation- All concrete documents in the revision successfully pass their JSON schema validations. Will cause this to report an error.deckhand-policy-validation- All required policy documents are in-place, and existing documents conform to those policies. E.g. if a 3rd party document specifies alayerthat is not present in the layering policy, that will cause this validation to report an error.
Externally Provided Validations
As mentioned, other services can report whether named validations
that have been registered by those services as success or failure.
DataSchema control documents are used to register a new
validation mapping that other services can reference to verify whether a
Deckhand bucket is in a valid configuration. For more information, refer
to the DataSchema section in document-types.