JSONスキーマを使用した値の検証
Helm 3では、JSONスキーマに従ったスキーマファイルを使用した値のバリデーションがサポートされました。 このリポジトリにあるHelmチャートも、各サブチャートにvalues.schema.json
ファイルを定義することで、この機能を利用しています。
スキーマファイルの使用に関する開発者のためのガイドライン:
- サブチャートの
values.yml
ファイルに新しいエントリーを追加したり、既存のエントリーを変更したりする場合は、この変更に合わせてそれぞれのvalues.schema.json
ファイルを更新する必要があります。 - このタスクの最初のイテレーションは、すべてのサブチャートにスキーマ・ファイルが装備された時点で完了する予定です。 最初のイテレーションの進捗状況は、関連エピックで確認できます。 今後のイテレーションでは、これらのスキーマ・ファイルを改善・改良し、効率性と使いやすさを高めることに焦点を当てます。
-
values.yml
で設定可能なすべての設定は、values.schema.json
ファイルに型バリデーション(値として正しいデータ型のみを受け入れるようにする)を実装する必要があります。 これは最初の反復で完了する必要があります。 - 最初の反復では、必須フィールドの検証は、ユーザーが
values.yml
ファイルで定義した設定が、そのコンポーネントだけでポッドをスピンアップするのに十分であり、ログにエラーが報告されないことを確認する程度にとどめることができます。 将来の反復では、これを拡大して、ポッドが実際に機能することを確認する必要があります。 これには、より深いテストが必要です。