125 lines
3.5 KiB
ReStructuredText
125 lines
3.5 KiB
ReStructuredText
..
|
|
Copyright 2018 AT&T Intellectual Property.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
.. _armada-documents:
|
|
|
|
Armada Documents
|
|
================
|
|
|
|
Below are the schemas Armada uses to validate :ref:`Charts`,
|
|
:ref:`Chart Groups`, and :ref:`Manifests`.
|
|
|
|
.. _Charts:
|
|
|
|
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:
|
|
|
|
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:
|
|
|
|
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.
|
|
|
|
.. _Deckhand DataSchema: https://airshipit.readthedocs.io/projects/deckhand/en/latest/document-types.html?highlight=dataschema#dataschema
|
|
.. _Helm charts: https://docs.helm.sh/developing_charts/
|
|
.. _layering: https://airshipit.readthedocs.io/projects/deckhand/en/latest/layering.html
|
|
.. _substitution: https://airshipit.readthedocs.io/projects/deckhand/en/latest/substitution.html
|
|
|
|
Schemas
|
|
^^^^^^^
|
|
|
|
* ``Chart`` schema.
|
|
|
|
JSON schema against which all documents with ``armada/Chart/v1``
|
|
``metadata.name`` are validated.
|
|
|
|
.. literalinclude::
|
|
../../../armada/schemas/armada-chart-schema.yaml
|
|
:language: yaml
|
|
:lines: 15-
|
|
:caption: Schema for ``armada/Chart/v1`` documents.
|
|
|
|
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.
|
|
|
|
.. literalinclude::
|
|
../../../armada/schemas/armada-chartgroup-schema.yaml
|
|
:language: yaml
|
|
:lines: 15-
|
|
:caption: Schema for ``armada/ChartGroup/v1`` documents.
|
|
|
|
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.
|
|
|
|
.. literalinclude::
|
|
../../../armada/schemas/armada-manifest-schema.yaml
|
|
:language: yaml
|
|
:lines: 15-
|
|
:caption: Schema for ``armada/Manifest/v1`` documents.
|
|
|
|
This schema is used to sanity-check all ``Manifest`` documents that are passed
|
|
to Armada.
|
|
|
|
.. _authoring-guidelines:
|
|
|
|
Authoring Guidelines
|
|
--------------------
|
|
|
|
All Armada documents must use the ``deckhand/DataSchema/v1`` schema.
|
|
|
|
.. todo::
|
|
|
|
Expand on this section.
|