summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelipe Monteiro <felipe.monteiro@att.com>2018-10-29 19:23:15 +0000
committerFelipe Monteiro <felipe.monteiro@att.com>2018-11-25 17:36:16 +0000
commite405dc4fd7c95fe4085cda150548db8cbc9f29b7 (patch)
tree036bab523cc6c3e60d6d37567ae51b39d0fb01c4
parenta3da86e3119d150a4f36fd93657455e6ec0c51ed (diff)
docs: Document all Pegleg lint codes
This adds Pegleg's lint codes to the operator documentation to obviously assist operators with figuring out failing Pegleg lint checks. Change-Id: I6742af48c563f6dd4b4f1d363b678cdcd000347e
Notes
Notes (review): Code-Review+1: Tin Lam <tin@irrational.io> Code-Review+2: Aaron Sheffield <ajs@sheffieldfamily.net> Code-Review+1: Lev Morgan <morgan.lev@gmail.com> Code-Review+1: Drew Walters <drewwalters96@gmail.com> Workflow+1: Felipe Monteiro <felipe.monteiro@att.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 01 Jan 2019 18:13:08 +0000 Reviewed-on: https://review.openstack.org/614013 Project: openstack/airship-pegleg Branch: refs/heads/master
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/lint-codes.rst59
2 files changed, 60 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 9981cee..f86ed6d 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -50,4 +50,5 @@ Operator's Guide
50 :maxdepth: 2 50 :maxdepth: 2
51 51
52 cli/cli 52 cli/cli
53 lint-codes
53 exceptions 54 exceptions
diff --git a/doc/source/lint-codes.rst b/doc/source/lint-codes.rst
new file mode 100644
index 0000000..2120372
--- /dev/null
+++ b/doc/source/lint-codes.rst
@@ -0,0 +1,59 @@
1..
2 Copyright 2018 AT&T Intellectual Property.
3 All Rights Reserved.
4
5 Licensed under the Apache License, Version 2.0 (the "License"); you may
6 not use this file except in compliance with the License. You may obtain
7 a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 License for the specific language governing permissions and limitations
15 under the License.
16
17.. _lint-codes:
18
19Lint Codes
20==========
21
22Overview
23--------
24
25Below are the lint codes that are used by the :ref:`lint <linting>` Pegleg
26CLI command.
27
28Codes
29-----
30
31* P001 - Document has storagePolicy cleartext (expected is encrypted) yet
32 its schema is a mandatory encrypted type.
33
34 Where mandatory encrypted schema type is one of:
35
36 * ``deckhand/CertificateAuthorityKey/v1``
37 * ``deckhand/CertificateKey/v1``
38 * ``deckhand/Passphrase/v1``
39 * ``deckhand/PrivateKey/v1``
40
41 See the `Deckhand Utility Document Kinds`_ documentation for more
42 information.
43
44* P003 - All repos contain expected directories.
45* P004 - Duplicate Deckhand `DataSchema`_ document detected.
46* P005 - Deckhand rendering exception.
47* P006 - YAML file missing document header (``---``).
48* P007 - YAML file is not valid YAML.
49* P008 - Document ``metadata.layeringDefinition.layer`` does not match its
50 location in the site manifests tree (e.g. document with ``site`` layer should
51 be found in folder named ``site``).
52* P009 - Document found in ``secrets`` folder in site manifests repository
53 but doesn't have ``storagePolicy: encrypted`` set.
54* P010 - Site folder in manifests repository is missing
55 :file:`site-definition.yaml`
56* P011 - :file:`site-definition.yaml` failed Pegleg schema validation.
57
58.. _DataSchema: https://airship-deckhand.readthedocs.io/en/latest/document-types.html?highlight=dataschema#dataschema
59.. _Deckhand Utility Document Kinds: https://airship-deckhand.readthedocs.io/en/latest/users/document-types.html#provided-utility-document-kinds