https://github.com/franckrst/helm-values-validator

This tool allows you to validate the format of your Helm values using a JSONSchema with the Helm pre-install & pre-upgrade hooks. 👌 (for helm hook exemple)
https://github.com/franckrst/helm-values-validator

distroless helms jsonschema

Last synced: about 1 month ago
JSON representation

This tool allows you to validate the format of your Helm values using a JSONSchema with the Helm pre-install & pre-upgrade hooks. 👌 (for helm hook exemple)

• Host: GitHub
• URL: https://github.com/franckrst/helm-values-validator
• Owner: Franckrst
• Created: 2024-02-09T21:00:02.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-16T20:35:29.000Z (11 months ago)
• Last Synced: 2024-11-28T12:53:14.452Z (about 1 month ago)
• Topics: distroless, helms, jsonschema
• Language: JavaScript
• Homepage:
• Size: 227 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-FR.md

Awesome Lists containing this project

README

        
# 👌 Helm Values Validator (pour faire un exemple de hook helm)

**Outil de validation de format de valeurs Helm**

Cet outil vous permet de valider le format de vos valeurs Helm à l'aide d'un [JSONSchema](https://json-schema.org/) avec

les hooks Helm `pre-install` & `pre-upgrade`. Comme [Schema Files](https://helm.sh/docs/topics/charts/#schema-files)

[![helm-3.14.0](https://img.shields.io/badge/helm-3.14.0-informational?style=flat-square)](https://helm.sh/docs/)

[![jsonschema-1.4.2](https://img.shields.io/badge/jsonschema-1.4.2-informational?style=flat-square)](https://json-schema.org/)

[![distroless~60mo](https://img.shields.io/badge/🥑%20distroless-~60mo-informational?style=flat-square)](https://github.com/GoogleContainerTools/distroless)

*[French Readme](./README-FR.md) - [English Readme](./README.md)*

> **Fonctionnalités**

> * Validation du format des valeurs Helm

> * Affichage des messages d'erreur en cas de problème

> * Exécution manuelle possible

![Terminal demo](./terminal-min.gif)

---

## 🚀 Installation

1. Copier le fichier `exemple/templates/tests/helm-values-validator.yaml` dans votre stack Helm.

2. Ajouter votre `schema.json` à la racine de votre chart Helm (même niveau que le `values.yaml`).

3. Installer le chart Helm avec la commande `helm install`.

4. (Optionnel) Convertir votre fichier `values.yaml` en `JSONSchema`

   sur  [jsonformater.org](https://jsonformatter.org/yaml-to-jsonschema)

## 📝 Logs

Pour voir les messages d'erreur de validation, vous pouvez utiliser les commandes suivantes :

```shell

# Les logs

kubectl logs nom-de-la-release-helm-values-validator

# Les messages d'erreur

kubectl get pod -n demo-test test-demo-helm-values-validator -o go-template="{{range .status.containerStatuses}}{{.state.terminated.message}}{{end}}"

```

## 🧑‍🔧 Exécution manuelle

Si vous voulez exécuter la validation sans lancer d'installation Helm, vous pouvez exécuter le conteneur avec les

fichiers et variables comme dans la commande suivante :

```bash

docker run -it -v $(pwd)/values.json:/values.json -v $(pwd)/schema.json:/schema.json -e SCHEMA_FILE=/schema.json -e VALUES_FILE=/values.json franckrst/helm-values-validator:0.0.0-alpha

```

## 📐 Architecture

Simple hook Helm pre-install et pre-upgrade qui déploie :

- Une ConfigMap qui comporte le fichier schema.json et un fichier values.json qui comporte la variable .Values

- Un Pod qui lance le conteneur de validation dans lequel est montée la ConfigMap

## Licence

MIT

## Thx

- [Github Action multiarch docker](https://dev.to/cloudx/multi-arch-docker-images-the-easy-way-with-github-actions-4k54)