Browse Source

Merge "docs: Document all Pegleg lint codes"

changes/15/614015/14
Zuul 5 months ago
parent
commit
a019d131d1
2 changed files with 60 additions and 0 deletions
  1. 1
    0
      doc/source/index.rst
  2. 59
    0
      doc/source/lint-codes.rst

+ 1
- 0
doc/source/index.rst View File

@@ -50,4 +50,5 @@ Operator's Guide
50 50
    :maxdepth: 2
51 51
 
52 52
    cli/cli
53
+   lint-codes
53 54
    exceptions

+ 59
- 0
doc/source/lint-codes.rst View File

@@ -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
+
19
+Lint Codes
20
+==========
21
+
22
+Overview
23
+--------
24
+
25
+Below are the lint codes that are used by the :ref:`lint <linting>` Pegleg
26
+CLI command.
27
+
28
+Codes
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

Loading…
Cancel
Save