Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI

このセクションは tazuna バイナリが提供するすべてのサブコマンドの仕様を、 1 コマンド 1 ページで網羅します。

ページは規約書として読まれることを想定しています。 コマンドの選び方や運用上の使い分けは ガイド を、 そもそも各コマンドが何を解いているかは 概念 を参照してください。

サブコマンド一覧

  • tazuna init — includes ベースの tazuna.yaml 雛形を生成する
  • tazuna applytazuna.yaml をクラスタに反映する(state を書き戻す)
  • tazuna build — クラスタに触らずにレンダリング結果を出力する
  • tazuna checktazuna.yaml の妥当性を検証する
  • tazuna destroy — Tazuna 管理リソースをクラスタから削除する
  • tazuna plan — Build 結果とライブクラスタをフィールド単位で diff する
  • tazuna status — State に記録された managed リソースの readiness を出す
  • tazuna state list — State に記録されているリソースを一覧する
  • tazuna state diff — Build 結果と State の差分を出す
  • tazuna state drift — State とライブクラスタの drift を検知する
  • tazuna secret-to-genesissecret — 既存 Secret を 1Password と GenesisSecret に書き出す
  • tazuna tagstazuna.yaml に書かれているタグを一覧する
  • tazuna version — バージョン情報を出力する

グローバルフラグ

すべてのサブコマンドが継承する persistent フラグです。

フラグエイリアスデフォルト説明
--file-path-fstringtazuna.yamltazuna.yaml のパス。
--log-level-lstringinfoログレベル。debug / info / warn / error のいずれか。
--otlp-endpoint-string""OpenTelemetry の OTLP/gRPC エンドポイント(例: localhost:4317)。空文字なら no-op tracer が使われ外部依存ゼロのまま動く。
--otlp-insecure-booltrueOTLP exporter でプレーンテキスト gRPC を使う(TLS 無し)。
--version---ルートコマンドにのみ付くフラグ。バージョン情報を出して終了する。tazuna version と等価。

共通の振る舞い

kubeconfig

クラスタアクセスを行うサブコマンドは、起動時に kubeconfig をロードし、 current-context が指すクラスタ に対して動作します。 KUBECONFIG 環境変数や --kubeconfig 相当のフラグは Tazuna 側では持たず、 kubectl と同じ解決ルールに従います。

context_matches の評価

tazuna.yamlspec.context_matches が設定されている場合、 クラスタに触る直前 に current-context 名と照合します。

  • 評価が走るコマンド: apply / destroy
  • 評価が走らないコマンド: build / check / plan / status / state list / state diff / state drift / tags / version / secret-to-genesissecret

評価モードは spec.context_match_modeor / and、デフォルト or)に従います。 詳細は tazuna.yaml スキーマ - context_matches を参照。

tazuna.yaml のバリデーション

apply / build / destroy / check / tags は、いずれも実行の最初に tazuna.yaml をロードしてバリデーションします。 バリデーションで失敗するとクラスタには触れません。 チェック項目の一覧は tazuna.yaml スキーマ - バリデーションのまとめ を参照。

加えて、tazuna.yaml をロードする すべて のコマンド(上記に plan / status / state list / state diff / state drift を含む)で、ロード時点で spec.minimumSupportedTazunaVersion と実行中の tazuna のバージョンが比較されます。 実行中のバージョンが下回る場合はその場でエラー終了します。詳細は tazuna.yaml スキーマ - minimumSupportedTazunaVersion を参照。

終了コード

終了コード意味
0成功
非ゼロ失敗。標準エラーに error: ... 形式でエラーが出力されます。

非ゼロ終了は CI でそのまま失敗扱いにできます。 コマンドごとに異なる終了コードを返すような区別は現状ありません。

環境変数

CLI フラグに加えて、Tazuna が参照する環境変数を一覧にしておきます。

環境変数影響するコマンド効果
TAZUNA_DESTROY_EXECUTABLEtruedestroyこれが true に設定されていない限り、destroy は実体の削除を行いません。プロンプトで Yes と答えても、この環境変数が無ければ何も起こりません。
KUBECONFIGパスクラスタを触る全コマンド通常の kubectl と同じ kubeconfig 解決ルールに従います。

TAZUNA_STATE_SYNC_DELETE 環境変数は、tazuna state sync の削除に伴って廃止されています。 removed 分類のリソースを削除したい場合は tazuna apply --sync --prune を使ってください。