airship/armada
Code Issues Proposed changes
armada/doc/source/operations/documents.rst
Felipe Monteiro 46c0ec93e3 Add documentation on Armada documents 
This patchset adds documentation on the 3 Armada documents
(Charts, Chart Groups and Manifests). A brief introduction
is given on each document type.

In a follow-up documentation on authoring patterns (how
to use the 3 types of Armada documents) will be added.

Change-Id: I41bd9c9107b083a2e231e4aae61f70798e86cd3c
2018-05-29 22:20:16 -04:00

3.5 KiB
Raw Blame History

Armada Documents

Below are the schemas Armada uses to validate Charts, Chart Groups, and Manifests.

Charts

Charts consist of the smallest building blocks in Armada. A Chart is comparable to a Helm chart. Charts consist of all the labels, dependencies, install and upgrade information, hooks and additional information needed to convey to Tiller.

Chart Groups

A Chart Group consists of a list of charts. Chart Group documents are useful for managing a group of Chart documents together.

Manifests

A Manifest is the largest building block in Armada. Manifest documents are responsible for managing collections of Chart Group documents.

Validation Schemas

Introduction

All schemas below are Deckhand DataSchema documents, which are essentially JSON schemas, with additional metadata useful for Deckhand to perform layering and substitution.

The validation schemas below are used by Armada to validate all ingested Charts, Chart Groups, and Manifests. Use the schemas below as models for authoring Armada documents.

Schemas

  • Chart schema.

    JSON schema against which all documents with armada/Chart/v1 metadata.name are validated.

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

    This schema is used to sanity-check all Chart documents that are passed to Armada.

  • Chart Group schema.

    JSON schema against which all documents with armada/Chart/v1 metadata.name are validated.

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

    This schema is used to sanity-check all Chart Group documents that are passed to Armada.

  • Manifest schema.

    JSON schema against which all documents with armada/Manifest/v1 metadata.name are validated.

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

    This schema is used to sanity-check all Manifest documents that are passed to Armada.

Authoring Guidelines

All Armada documents must use the deckhand/DataSchema/v1 schema.

Expand on this section.