armada/docs/source/operations/validation.rst
Felipe Monteiro 35b426db32 Add documentation for Armada schemas
This is to add documentation for Armada schemas that are
used for validating Chart, ChartGroup and Manifest documents.

Change-Id: If7bbc6a8c174ab15c553a278003f827337e2b860
2018-03-01 15:08:03 +00:00

1.9 KiB

Document Validation

Validations

Armada, like other UCP components, uses jsonschema to validate documents passed to it. This includes dedicated schemas for Chart, ChartGroup and Manifest.

Validation Schemas

Below are the schemas Armada uses to validate documents.

Armada Schemas

  • Chart schema.

    Chart schema against which all Armada Chart documents are validated.

    ../../../armada/schemas/armada-chart-schema.yaml

    This schema is used to sanity-check all Chart documents.

  • ChartGroup schema.

    ChartGroup schema against which all Armada ChartGroup documents are validated.

    ../../../armada/schemas/armada-chartgroup-schema.yaml

    This schema is used to sanity-check all ChartGroup documents.

  • Manifest schema.

    Manifest schema against which all Armada Manifest documents are validated.

    ../../../armada/schemas/armada-manifest-schema.yaml

    This schema is used to sanity-check all Manifest documents.