airship/armada
Code Issues Proposed changes
085d9887e0
armada/doc/source/operations/validation.rst
Felipe Monteiro 085d9887e0 Rename docs to doc to align with OpenStack standard 
This patchset updates docs to doc to align with OpenStack
standard. Follow-up patchset will be needed to publish
documentation to OpenStack [0].

TODO: Update Armada documentation job to align with [1].

[0] https://docs.openstack.org/doc-contrib-guide/project-guides.html
[1] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I100541611ddfcd5c42f09da631346cb8ef3de5e7
2018-05-17 21:39:01 +00:00

1.9 KiB
Raw Blame History

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.