From 35b426db32a7440d862c88e7ac3eef3a453acfc9 Mon Sep 17 00:00:00 2001
From: Felipe Monteiro <felipe.monteiro@att.com>
Date: Thu, 1 Mar 2018 15:08:03 +0000
Subject: [PATCH] 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
---
 docs/source/operations/index.rst      | 17 ++++---
 docs/source/operations/validation.rst | 71 +++++++++++++++++++++++++++
 2 files changed, 80 insertions(+), 8 deletions(-)
 create mode 100644 docs/source/operations/validation.rst

diff --git a/docs/source/operations/index.rst b/docs/source/operations/index.rst
index 4c2e6053..b1a7ff65 100644
--- a/docs/source/operations/index.rst
+++ b/docs/source/operations/index.rst
@@ -10,12 +10,13 @@ Operations Guide
    :maxdepth: 2
    :caption: Contents:
 
-   guide-api.rst
-   guide-build-armada-yaml.rst
-   guide-configure.rst
-   guide-troubleshooting.rst
-   guide-use-armada.rst
+   guide-api
+   guide-build-armada-yaml
+   guide-configure
+   guide-troubleshooting
+   guide-use-armada
+   validation
    exceptions/index
-   guide-helm-plugin.rst
-   sampleconf.rst
-   samplepolicy.rst
+   guide-helm-plugin
+   sampleconf
+   samplepolicy
diff --git a/docs/source/operations/validation.rst b/docs/source/operations/validation.rst
new file mode 100644
index 00000000..17ba2789
--- /dev/null
+++ b/docs/source/operations/validation.rst
@@ -0,0 +1,71 @@
+..
+  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.
+
+.. _validation:
+
+===================
+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.
+
+  .. literalinclude:: ../../../armada/schemas/armada-chart-schema.yaml
+    :language: yaml
+    :lines: 15-
+    :caption: Armada Chart schema.
+
+  This schema is used to sanity-check all ``Chart`` documents.
+
+* ChartGroup schema.
+
+  ChartGroup schema against which all Armada ``ChartGroup`` documents are
+  validated.
+
+  .. literalinclude:: ../../../armada/schemas/armada-chartgroup-schema.yaml
+    :language: yaml
+    :lines: 15-
+    :caption: Armada ChartGroup schema.
+
+  This schema is used to sanity-check all ``ChartGroup`` documents.
+
+* Manifest schema.
+
+  Manifest schema against which all Armada ``Manifest`` documents are
+  validated.
+
+  .. literalinclude:: ../../../armada/schemas/armada-manifest-schema.yaml
+    :language: yaml
+    :lines: 15-
+    :caption: Armada Manifest schema.
+
+  This schema is used to sanity-check all ``Manifest`` documents.