helm get notes で Notes を読む

インストール後、Helmは次に行うとよい手順を表示します。同じテキストは、いつでもhelm get notesで取得できます。📝

テキストはチャートのtemplates/NOTES.txtファイルにあります。通常のテンプレートと同じように、リリースのvaluesを使ってレンダリングされます。

NOTESには通常、アプリへの接続方法が説明されています。サービスURL、パスワードの取得方法、ポートフォワードの対象ポートなどです。純粋な案内情報です。🧭

テンプレートなので、Notesには実際の値が表示されます。チャートはプレースホルダーではなく、実際のリリース名やnamespaceを出力できます。

先週使った接続コマンドを忘れてしまいましたか。helm get notesなら、デプロイメントに一切触れずに再表示できます。

Notesはリリースごとに管理されます。リリースが別のnamespaceにある場合は、-nを渡してHelmが見つけられるようにしてください。

以前の時点で表示されたNotesを確認したい場合は、--revisionを使って特定のリビジョン番号のメッセージを読み取ります。

get notesは複数あるhelm getサブコマンドの一つです。values、manifest、hooksと並び、それぞれリリースの異なる情報を取り出します。

全体を確認したい場合は、helm get allを使います。Notes、values、manifest、hooksを一つの出力にまとめて取得できます。

インストールまで待つ必要はありません。--dry-runを使うとNOTESもレンダリングして表示されるため、先に案内内容を確認できます。

リリースを引き継いだものの使い方が分からないとき、helm get notesが答えにたどり着く最も早い方法であることがよくあります。💡

インストール時にチャートが表示した使用方法のヒントを、もう一度読みたいとします。

これでhelm get notesを使って、レンダリング済みのリリースのNOTES.txtにある案内を、過去のリビジョンを含めていつでも再表示できるようになりました。便利なリマインダーツールです。🎯