0Pricing
DevOps Bootcamp · レッスン

適切で文書化されたデフォルト値

すぐに安全に使える values を設計します。

「適切で文書化されたデフォルト値」はCoddyKit上の無料DevOps Bootcampレッスンです。 これはレッスン2/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはDevOps Bootcamp学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 DevOps Bootcampコースには全4レッスンが含まれています。

デフォルト値が第一印象を決める

多くの人はオーバーライドなしでチャートをインストールするため、values.yamlのデフォルト値によって、最初から正常に動作するか、分かりにくい形で失敗するかが決まります。

最初から安全に使える状態にする

予期しない問題なく、新しいクラスターに正常にインストールできるデフォルト値を目指してください。新しいユーザーがオプションなしでhelm installを実行しても、動作するリリースが得られるようにします。

すべてのキーを文書化する

各値の上に、その値の役割と指定可能な範囲を説明するコメントを追加してください。values.yamlはチャートの設定マニュアルも兼ねます。

# Number of pod replicas to run
replicaCount: 1

平坦で予測しやすいキーを優先する

imageやresourcesのような分かりやすい親キーの下に、関連する設定をまとめます。予測しやすい構造にすると、オーバーライドを簡単に記述してレビューできます。

image:
  repository: nginx
  tag: "1.27"
  pullPolicy: IfNotPresent

控えめなリソースのデフォルト値

小規模なクラスターにも収まるよう、控えめなリソースリクエストを設定して配布します。ただし、ユーザーが自分のワークロードに合わせて調整できるよう、リミットはコメントアウトするか空にしておきます。

オプション機能にはブール値を使う

Ingressなどのオプションリソースは有効化フラグで制御します。基本的なインストールを最小限かつ予測しやすく保つため、デフォルトでは無効にします。

ingress:
  enabled: false

可能な限り必須入力を避ける

required関数は、ドメイン名のように妥当なデフォルト値を設定できない値にだけ使用してください。必須入力が少ないほど、初回インストールがスムーズになります。

{{ required "ingress.host is required" .Values.ingress.host }}

型の一貫性

各値の型を一定に保ちます。tagが文字列なら常に引用符で囲み、1.27が数値として解析されてイメージ参照が壊れないようにしてください。

tag: "1.27"

公開して、ハードコードしない

ユーザーが変更する可能性のある設定は、テンプレートに埋め込むのではなくvalues.yamlで指定できるようにします。柔軟性はvaluesにあります。

ユーザーに設定項目を示す

helm show valuesを使えば、すべてのオプションを一覧表示できます。十分なコメントが付いたデフォルト値によって、このコマンドは即座に利用できる正確なドキュメントになります。

helm show values ./mychart

安全性のためにスキーマを追加する

values.schema.jsonファイルは、レンダリング前にユーザー入力を検証します。タイプミスや誤った型を、壊れたマニフェストではなく明確なエラーとして検出できます。🛡️

クイックチェック

要求されない限り表示されないオプションのIngressが必要です。最適なデフォルト値は何ですか?

まとめ

妥当なデフォルト値、明確なコメント、一貫した型、オプトイン機能によって、チャートを安全で扱いやすくできることを学びました。values.yamlはドキュメントと設定を兼ねています。✅

よくある質問

「適切で文書化されたデフォルト値」レッスンは無料ですか?

はい。「適切で文書化されたデフォルト値」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、DevOps Bootcampコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 DevOps Bootcampコースには全4レッスンが含まれています。

「適切で文書化されたデフォルト値」で何を学びますか?

すぐに安全に使える values を設計します。 ブラウザで直接実行するハンズオンコードでDevOps Bootcampを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

DevOps Bootcampを始めるのに経験は必要ですか?

事前経験は必要ありません。CoddyKitのDevOps Bootcampは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン2/4です。

「適切で文書化されたデフォルト値」レッスンにはどのくらい時間がかかりますか?

ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このDevOps Bootcampレッスンでコードを書いて実行できますか?

はい。すべてのDevOps Bootcampレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

  1. 標準ラベルと命名規則
  2. 適切で文書化されたデフォルト値
  3. securityContext による Pod の堅牢化
  4. バージョンの固定と latest の回避
← DevOps Bootcampに戻る