├── .banditrc ├── test ├── not-k8s.yaml ├── bad-deployment.yaml ├── deployment.yaml └── ingress.yaml ├── .flake8 ├── .pre-commit-hooks.yaml ├── setup.py ├── README.md ├── .pre-commit-config.yaml ├── pre-commit-hooks └── k8svalidate └── LICENSE-2.0 /.banditrc: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/not-k8s.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | foo: bar 3 | -------------------------------------------------------------------------------- /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 89 3 | -------------------------------------------------------------------------------- /.pre-commit-hooks.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | - id: k8svalidate 3 | name: k8svalidate 4 | description: A pre-commit hook to validate Kubernetes YAML files 5 | entry: k8svalidate 6 | language: python 7 | types: 8 | - yaml 9 | -------------------------------------------------------------------------------- /test/bad-deployment.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: apps/v1 3 | kind: Deployment 4 | metadata: 5 | name: nginx-deployment 6 | labels: 7 | app: nginx 8 | spec: 9 | replicas: 3 10 | template: 11 | metadata: 12 | labels: 13 | app: nginx 14 | spec: 15 | containers: 16 | - name: nginx 17 | image: nginx:1.14.2 18 | ports: 19 | - containerPort: 80 20 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """Fake setup for pre-commit hook.""" 2 | 3 | from setuptools import setup 4 | 5 | setup( 6 | name="k8svalidate", 7 | description="A pre-commit hook to validate Kubernetes YAML files", 8 | url="https://github.com/Agilicus/pre-commit-hook-k8svalidate", 9 | version="0.1.1", 10 | install_requires=["ruamel.yaml>=0.16.10", "kubernetes-validate>=1.21.0"], 11 | scripts=["pre-commit-hooks/k8svalidate"], 12 | ) 13 | -------------------------------------------------------------------------------- /test/deployment.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: apps/v1 3 | kind: Deployment 4 | metadata: 5 | name: nginx-deployment 6 | labels: 7 | app: nginx 8 | spec: 9 | replicas: 3 10 | selector: 11 | matchLabels: 12 | app: nginx 13 | template: 14 | metadata: 15 | labels: 16 | app: nginx 17 | spec: 18 | containers: 19 | - name: nginx 20 | image: nginx:1.14.2 21 | ports: 22 | - containerPort: 80 23 | -------------------------------------------------------------------------------- /test/ingress.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: agilicus/v1 3 | kind: IstioIngressGenerator 4 | metadata: 5 | name: not-used-ingress 6 | namespace: egov 7 | name: admin 8 | hostname: admin.egov.__ROOT_DOMAIN__ 9 | issuer: letsencrypt-istio 10 | match_routes: 11 | http: 12 | - match: 13 | - uri: 14 | prefix: / 15 | headers: 16 | cookie: 17 | regex: ^(.*;[\s]?)?(ver=master)(;.*)?$ 18 | route: 19 | - destination: 20 | host: portal.portal.svc.cluster.local 21 | subset: master 22 | port: 23 | number: 5000 24 | - match: 25 | - uri: 26 | prefix: / 27 | route: 28 | - destination: 29 | host: portal.portal.svc.cluster.local 30 | subset: stable 31 | port: 32 | number: 5000 33 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## k8svalidate 2 | 3 | This is a [pre-commit](https://pre-commit.com/) hook to validate input YAML 4 | against the Kubernetes API specification. 5 | 6 | It will ignore input YAML which are not Kubernetes 7 | types (including unknown CRD and unknown other files). 8 | If they do match a known API, they are checked. 9 | 10 | It uses [kubernetes-validate](https://github.com/willthames/kubernetes-validate) 11 | as an upstream. 12 | 13 | ## Usage: 14 | 15 | ``` 16 | k8s-validate [--kubernetes-version X.X.X] [--exclude glob-pattern] files 17 | ``` 18 | 19 | Add a section similar to this to your .pre-commit-hooks.yaml: 20 | 21 | ``` 22 | repos: 23 | - repo: https://github.com/Agilicus/pre-commit-hook-k8svalidate.git 24 | rev: v0.0.8 25 | hooks: 26 | - id: k8svalidate 27 | args: [--exclude, "**/*.patch.yaml"] 28 | files: .yaml$ 29 | ``` 30 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | repos: 3 | - repo: https://github.com/psf/black-pre-commit-mirror 4 | rev: 23.11.0 5 | hooks: 6 | - id: black 7 | 8 | - repo: https://github.com/pycqa/flake8 9 | rev: 6.1.0 10 | hooks: 11 | - id: flake8 12 | additional_dependencies: [flake8-docstrings, darglint, flake8-bugbear, 13 | flake8-commas, flake8-mutable, flake8-pytest-style, 14 | flake8-walrus, pep8-naming] 15 | 16 | - repo: https://github.com/pre-commit/mirrors-isort 17 | rev: v5.10.1 18 | hooks: 19 | - id: isort 20 | additional_dependencies: [toml] 21 | exclude: ^.*/?setup\.py$ 22 | 23 | - repo: https://github.com/pre-commit/mirrors-autopep8 24 | rev: v2.0.4 25 | hooks: 26 | - id: autopep8 27 | 28 | - repo: https://github.com/pre-commit/pre-commit-hooks 29 | rev: v4.5.0 30 | hooks: 31 | - id: trailing-whitespace 32 | exclude: ^tests/.*/fixtures/.* 33 | - id: end-of-file-fixer 34 | exclude: ^tests/.*/fixtures/.* 35 | - id: debug-statements 36 | - id: check-merge-conflict 37 | - id: check-yaml 38 | 39 | - repo: https://github.com/talos-systems/conform 40 | rev: v0.1.0-alpha.27 41 | hooks: 42 | - id: conform 43 | stages: 44 | - commit-msg 45 | 46 | - repo: https://github.com/Lucas-C/pre-commit-hooks-safety 47 | rev: v1.3.2 48 | hooks: 49 | - id: python-safety-dependencies-check 50 | 51 | - repo: https://github.com/PyCQA/bandit 52 | rev: 1.7.5 53 | hooks: 54 | - id: bandit 55 | -------------------------------------------------------------------------------- /pre-commit-hooks/k8svalidate: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """Validate input Kubernetes YAML against API specification. 3 | 4 | SPDX-License-Identifier: Apache-2.0. 5 | """ 6 | 7 | import argparse 8 | import glob 9 | import itertools 10 | import sys 11 | 12 | import jsonschema 13 | import kubernetes_validate.utils as utils 14 | from ruamel.yaml import YAML 15 | 16 | 17 | def unskipped(i_files, exclude): 18 | """Take a list of input files, and a list of globs to exclude, subtract. 19 | 20 | Args: 21 | i_files (list): list of input files 22 | exclude (list): list of globs 23 | 24 | Returns: 25 | list: list of filenames 26 | """ 27 | e_files = [] 28 | if exclude: 29 | for f in exclude: 30 | e_files.append(glob.glob(f, recursive=True)) 31 | e_files = list(itertools.chain.from_iterable(e_files)) 32 | o_files = list(set(i_files).difference(set(e_files))) 33 | return o_files 34 | 35 | 36 | def is_valid_type(doc): 37 | """If apiVersion exists, as does kind.... accept. 38 | 39 | Args: 40 | doc: single YAML document 41 | 42 | Returns: 43 | bool: true if we should process 44 | """ 45 | valid = True 46 | if not doc or "apiVersion" not in doc or "kind" not in doc: 47 | valid = False 48 | return valid 49 | 50 | 51 | def main(): 52 | """Parse and do all files. 53 | 54 | Returns: 55 | shell: 0 for success, 1 for error 56 | """ 57 | parser = argparse.ArgumentParser( 58 | description="Validate Kubernetes resource definitions", 59 | ) 60 | parser.add_argument( 61 | "-k", 62 | "--kubernetes-version", 63 | action="append", 64 | help="version of Kubernetes to validate against. Defaults to %s" 65 | % utils.latest_version(), 66 | ) 67 | parser.add_argument("-e", "--exclude", action="append", help="files to exclude") 68 | parser.add_argument( 69 | "--strict", 70 | action="store_true", 71 | default=False, 72 | help="whether to use strict validation, rejecting unexpected properties", 73 | ) 74 | parser.add_argument("files", nargs=argparse.REMAINDER) 75 | 76 | args = parser.parse_args() 77 | 78 | if not args.files: 79 | parser.print_help() 80 | return 0 81 | 82 | overall_result = True 83 | version = args.kubernetes_version or utils.latest_version() 84 | for input in unskipped(args.files, args.exclude): 85 | try: 86 | with open(input, "r") as i_file: 87 | data = i_file.read() 88 | docs = list(YAML().load_all(data)) 89 | for doc in docs: 90 | result = "Valid" 91 | valid = True 92 | operation = "" 93 | if is_valid_type(doc): 94 | try: 95 | utils.validate(doc, version, args.strict) 96 | operation = " PASS" 97 | except utils.SchemaNotFoundError: 98 | result = "Skipped [Unknown Schema]" 99 | operation = " SKIP" 100 | except jsonschema.exceptions.ValidationError as e: 101 | result = f"FAIL [{e.args[0]}]" 102 | valid = False 103 | operation = "*FAIL" 104 | else: 105 | result = "Skipped [Not Kubernetes YAML]" 106 | operation = " SKIP" 107 | if not valid: 108 | overall_result = False 109 | print(f"{operation}: file {input} -> {result}") 110 | except FileNotFoundError: 111 | print(f"SKIP: file {input} -> Does not exist") 112 | 113 | return overall_result 114 | 115 | 116 | if __name__ == "__main__": 117 | rc = main() 118 | if not rc: 119 | print("Overall result: fail", file=sys.stderr) 120 | sys.exit(1) 121 | else: 122 | sys.exit(0) 123 | -------------------------------------------------------------------------------- /LICENSE-2.0: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------