CNDO 2021、YAMLの加工ツールyttをVMwareのソリューションアーキテクトが解説

CloudNative Days ONLINE 2021から、YAMLファイルの加工ツールであるytt（YAML template tool）についてデモを交えて解説するセッションを紹介する。昨今YAMLファイルは、Kubernetesの設定ファイルを始めとして広く利用されている。このセッションは、元Pivotalのエンジニアで今はVMwareのソリューションアーキテクトである槙俊明氏によるものだ。

k14s（Carvel）の一部であるytt

「yttでYAML王に俺はなる！」というワンピースを意識したタイトル

yttはCarvelというオープンソースソフトウェアのツール群の一部である。元々Carvelは、Pivotalが開発していたk14s（Kubernetes Tools）というツールの一部であり、VMwareによるPivotal買収完了後に改名されたものだ。yttは複数のツールで構成されているものの一つという位置づけになる。このような経緯から、VMwareがyttの開発を支援しているというわけだ。

参考：Introducing k14s (Kubernetes Tools): Simple and Composable Tools for Application Deployment

このブログ記事は2019年6月にPivotalチームによって書かれたもので、k14sの生い立ちの背景が良くわかる内容になっている。ここで重要なポイントは、Pivotalのエンジニアが強烈にHelmを意識しているということだろう。それはyttの説明に「複雑で多目的なツールであるHelmを使った経験からk14sを開発した。シンプルで一機能だけを実装したツール群を連携させたほうが、オールインワンのHelmよりも理解しやすくデバッグも簡単になる」とあることからも見て取れる。

k14sとは何かをHelmを比較対象として説明

ここではアプリケーション開発から実装までのステップを例に、yttを含むk14sがどのように位置付けられているのかを解説している。アプリケーションはソースコードを書くだけではなく、その構成ファイルの作成、パッケージの作成、実装のための操作が必要になる。k14sでは構成ファイルの作成をytt、パッケージ作成をkbld、実装をkappが受け持つ形でツールが構成されている。他にも、開発用のPCからKubernetesのクラスターにアクセスするためのkwtというツールも公開されている。kwtはTelepresenceと同じような機能を果たすツールだが、Telepresenceが多機能化に向かっているのに比べると、機能はシンプルさを保っている。

YAMLをテンプレート化するツールの比較表

ここではOverlayとTemplateという単語が簡単に解説されている。OverlayはベースのYAMLを元に変更を加える機能、Templateは変数の代入や「if - then」などのロジックを加える機能と説明した。比較されているソフトウェアにはそれぞれ特徴があるが、普及度という面ではkubectlに採用されたKustomizeと、Microsoftが強力にバックアップするHelmが圧倒的と言えるだろう。Helmは元々Deisが開発していたKubernetesのパッケージマネージャーで、MicrosoftがDeisを買収した後にCNCFのプロジェクトとして採用され、2020年4月にインキュベーションプロジェクトからのGraduationとなったプロジェクトだ。

なおKustomizeについては、2018年のKubeCon Chinaのレポートでも紹介しているので参照されたい。この時点ではKustomizeはOverlayではなく「Patchを当てる」という表現を使っており、用語の使い方も変化したのかもしれない。Kustomizeの概要は後半に記載されている。

参考：KubeConChinaで見たKubernetesエコシステムを支えるツールたち

yttの特徴

HelmやKustomizeを使う上での問題点を解説

その問題点を解決するツールとして紹介したのがyttだ。

Carvelの一部として紹介されたytt

YAMLファイルを加工するためにYAMLを使うというアプローチだが、特殊なDSL（Domain Specific Language）を使わずに行うとは言いつつも、Pythonに似たStarlarkという言語を使ってロジックを記述するというのが解説された。

Helm、Kustomizeなどとの比較表にyttを追加

Kustomizeと比べると、テンプレート言語を使えて機能が高く、Kubernetes専用でもないが、普及度、知名度では圧倒的に遅れをとっていると言うのが、客観的な評価と言えるだろう。

yttのテンプレート機能

ここからはyttのテンプレート機能を、例を挙げて説明するフェーズとなった。ここで、CarvelのサイトにあるPlaygroundと呼ばれるページが紹介された。これは、実際にyttを使ってYAMLファイルに対する加工をブラウザー上で確認できるというものだ。Playgroundには多くの例が含まれており、yttで何ができるのかを実体験できる強力なツールとなっているので、ぜひ体験して欲しい。

CarvelのサイトにあるyttのPlayground：Carvel - ytt

#@で始まる文を使ってPythonに似た構文でロジックを記述

この例では「#@」で始まる変数の記述がyttの処理を経てYAMLの記述に変換されていることがわかる。

関数もPythonのように記述できるが「end」を明示的に書く必要があると説明

この例では関数の記述に明示的にendを書く必要があるという部分を説明し、yttならではの違いを強調した。

Overlayの例。YAML内のデータを書き換える

この例ではmetadataのnameがdemoを検索し、その値を100から500に変更するという記述を解説した。

リストの中の値も変更することができる

この例ではリストの中のデータを検索して、値を変更するやり方を説明している。

yttの特徴は元になるYAMLファイルを一切変更せずに書き換えられる点であり、これ以降はレシピの紹介としてKubernetesのManifestを書き換える例を紹介していくフェーズとなった。

yttの魅力はOverlayとTemplateの機能を使ってYAMLを自由に書き換えること

この例ではKubernetesのPodのレプリカ数を変える例を紹介した。先ほどの例のYAML内の変数を検索し、その属性であるReplicasを書き換えている例だ。

コンテナのイメージ名の書き換えを行う例

この例ではコンテナのイメージ名にレジストリーの名前を追加するという書き換えを紹介している。

実際に書き換えられた例。イメージ名にレジストリー名が追加されている

最後にまとめとしてyttの強力なカスタマイズ機能を紹介してセッションを終えた。yttの公式サイトは以下を参照して欲しい。

ytt公式サイト：Carvel - ytt

YAMLファイルの運用管理は、多くのツールがKubernetesネイティブになるに従って、これからニーズが高まってくる領域と言える。CarvelなどのPivotalの資産やHeptioを上手く活用できるかどうかは、VMwareの舵取りに掛かっている。TanzuがVMwareのクラウドネイティブの新しいブランドとしてオープンソースも商用ソフトもまとめられている形だが、VMwareがリードするオープンソースプロジェクトは別枠で存在し、VeleroやHarborなどと同様にCarvelはその中に含まれるという形態のようだ。

VMwareのOSSプロジェクト：VMware® Open Source Software