Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DevOpsHiveHQ/kustomize-plugin-kubeconform
A plugin built around Kubeconform to validate manifests schema within Kusomize.
https://github.com/DevOpsHiveHQ/kustomize-plugin-kubeconform
kubernetes kustomize kustomize-plugin kustomize-validator validation
Last synced: 26 days ago
JSON representation
A plugin built around Kubeconform to validate manifests schema within Kusomize.
- Host: GitHub
- URL: https://github.com/DevOpsHiveHQ/kustomize-plugin-kubeconform
- Owner: DevOpsHiveHQ
- License: apache-2.0
- Created: 2023-04-07T16:12:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-09T22:32:11.000Z (over 1 year ago)
- Last Synced: 2024-05-19T03:22:21.105Z (7 months ago)
- Topics: kubernetes, kustomize, kustomize-plugin, kustomize-validator, validation
- Language: Go
- Homepage:
- Size: 67.4 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KubeconformValidator
A wrapper for [Kubeconform](https://github.com/yannh/kubeconform)
to work as a Kustomize validator plugin via KRM functions.
Note: This is still a playground.
## Build
```sh
go build -o 'dist/kubeconformvalidator' .
```
## Example
```yaml
apiVersion: validators.kustomize.aabouzaid.com/v1alpha1
kind: KubeconformValidator
metadata:
name: validate
annotations:
config.kubernetes.io/function: |
# Exec KRM functions.
exec:
path: ../dist/kubeconformvalidator
# # Containerized KRM functions.
# container:
# image: aabouzaid/kubeconformvalidator
# network: true
spec:
# Configure Kubeconform.
config:
output: json
skip:
- AlertmanagerConfig
# Also, direct Kubeconform args could be used but "spec.args" has lower priority over "spec.config".
# https://github.com/yannh/kubeconform#Usage
# args:
# - -output
# - json
# - -skip
# - AlertmanagerConfig
```
## Try
```sh
# Make sure to build bin first.
kustomize build --enable-alpha-plugins --enable-exec ./example
```
The Kustomize output if the validation failed (there are schema errors):
```
Kubeconform validation output: {
"resources": [
{
"filename": "stdin",
"kind": "Service",
"name": "validated-core-resource",
"version": "v1",
"status": "statusInvalid",
"msg": "problem validating schema. Check JSON formatting: jsonschema: '/spec/ports/0/port' does not validate with https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master-standalone/service-v1.json#/properties/spec/properties/ports/items/properties/port/type: expected integer, but got string",
"validationErrors": [
{
"path": "/spec/ports/0/port",
"msg": "expected integer, but got string"
}
]
}
]
}
Error: couldn't execute function: exit status 1
```
The Kustomize output if the validation succeeded (there are no schema errors):
```
apiVersion: v1
kind: Service
metadata:
name: validated-core-resource
spec:
ports:
- port: 8080
protocol: TCP
targetPort: 8080
type: ClusterIP
---
apiVersion: monitoring.coreos.com/v1alpha1
kind: AlertmanagerConfig
metadata:
name: skipped-custom-resource
spec:
receivers:
- name: webhook
webhookConfigs:
- url: http://example.com/
```