ChefsMeetingNagoya Vol.1 - 単純な Cookbook の作成

基本的な用語

Chef でのプロビジョニングを行うには、まず Resource、Recipe、Cookbook という単語をおさえておきましょう。
これは、Chef を使うにあたって最低限作らなければいけないものです。 

Cookbook

Cookbook とは

Chef の Recipe（ソースコード）をとりまとめたものです。
一般的に、ひとつのアプリケーションやサービスに対し、ひとつの Cookbook が用意されることが多いです。 

ひな形の生成

ChefDK の chef generate cookbook コマンドで Cookbook のひな形を生成します。

$ cd workspace
$ chef generate cookbook <Cookbook 名>

生成されたもの

コマンドを実行すると、以下のファイルが作成されます。

• .kitchen.yml
  Kitchen の設定ファイル
  テスト用のインスタンスや実行するプロビジョニングの設定を記述
   
• Berksfile
  Berkshelf の設定ファイル
  Kitchen でプロビジョニングを行うときの依存する Cookbook を記述
   
• README.md
  Cookbook の説明書
   
• chefignore
  ChefClient に転送しないファイルを定義
   
• metadata.rb
  Cookbook の基本情報を記述
   
• recipes/default.rb
  デフォルトで実行する Recipe

Eclipse プロジェクトに変換

Cookbook を編集するうえで、Eclipse が特に有利になる点は、実はありません。
2014/06 時点で RHEL 系の日本語環境で比較的マシに利用できるのが Eclipse しかなかっただけです。
好みのエディタで編集してください。（おすすめあれば教えてください）

.project を生成

スクリプトを実行し .project を生成します。

$ cd <Cookbook 名>
$ gen-eclipse

<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
        <name>${cookbook_name}</name>
        <comment></comment>
        <projects>
        </projects>
        <buildSpec>
                <buildCommand>
                        <name>org.eclipse.dltk.core.scriptbuilder</name>
                        <arguments>
                        </arguments>
                </buildCommand>
        </buildSpec>
        <natures>
                <nature>org.eclipse.dltk.ruby.core.nature</nature>
        </natures>
</projectDescription>

プロジェクトをインポート

Eclipse を起動し、次の手順でプロジェクトをインポートします。
 

Package Explorer に隠しファイルも表示させる

標準では .kitchen.yml が見えないので、次の手順で隠しファイルを表示します。
 

Recipe

Recipe とは

Chef では、サーバーのあるべき状態を Recipe（ソースコード）として記述します。
Recipe は「ファイルのダウンロード」や「コマンドの実行」など、さまざまな機能をもつ Resource から構成されます。

Resource は Chef 公式のものだけで40種類以上ありますが、基本的な構文はどれも同じで、
次のように、ユニークな Name をもち、１つ以上の Attribute によりパラメータを指定でき、実行時の動作を Action で指定します。

resource "name" do
  attributeA "valueA"
  attributeB "valueB"
  action :action
end

次の Recipe は「'/tmp' ディレクトリで、 'tar zxf archive.tar.gz' というスクリプトを、bash で実行する、'extract tar file' という名前の Resource」を定義したものです。

bash 'extract tar file' do
  cwd '/tmp'
  code 'tar zxf archive.tar.gz'
  action :run
end

ここでは Chef 標準の bash Resource をベースに、cwd Attribute に実行時のディレクトリを、code Attribute に実行するスクリプトを指定し、
Action には Resource の実行時にスクリプトが実行されるように :run を指定していて、
これらの指定を行った Resource に 'extract tar file'  という Name をつけています。

指定できる Action や Attribute は Resource ごとに異なるので、Resource のドキュメントを逐一確認するようにしてください。
bash Resource であれば ここ です。

Resource の実行順序

Recipe は上から順に解釈され、Resource は基本的には Recipe に定義した順で実行されます。
たとえば、「ファイルをダウンロード」してから「ダウンロードしたファイルを解凍」したい場合は、次のように記述できます。 

remote_file '/tmp/archive.tar.gz' do
  source 'http://path/to/archive.tar.gz'
  action :create
end

bash 'extract tar file' do
  cwd '/tmp'
  code 'tar zxf archive.tar.gz'
  action :run
end

冪等性を確保する

Chef では何度 Recipe を実行しても同じ結果になることが望まれています。
これは Chef 標準の package Resource などを使用していれば Resource 側で確保してくれるのですが、
bash Resource などでは自力でがんばって確保するしかありません。 

冪等性を確保するには、not_if や only_if を使用して Resource にガード条件を設定します。

例えば、特定のファイルが存在しないときだけ Resource を実行するには次のように書きます。

exexute 'install peco'
  command 'cp /tmp/peco_linux_amd64/peco /usr/local/bin/peco'
  not_if { File.exists?('/usr/local/bin/peco') }
end

この例では、Resource が実行される直前に not_if ブロックの Ruby コードが実行され、結果が false のときだけ Resource が実行されます。
逆に結果が true のときだけ Resource が実行されるようにしたい場合は only_if を使います。

また、Ruby のブロックでなく、文字列を直接わたすこともできます。

exexute 'install peco'
  command 'cp /tmp/peco_linux_amd64/peco /usr/local/bin/peco'
  not_if "test -e '/usr/local/bin/peco'"
end

この場合は not_if にわたした文字列がシェルスクリプトとして実行され、実行結果が 0 以外のときだけ Resource が実行されます。
さきほどと同じように、結果が 0 のときだけ Resource が実行されるようにするには only_if を使います。 

Recipe を書く手順 

1. 具体的に何をしたいのかを明らかにする
2. 使えそうな Resource をさがす
3. 実際に Recipe を書く

はじめは、目的に対して適切な Resource をさがせることがいちばん大事です。

Google で検索してもいいですし、Dash を使ってもいいですし、Chef実践入門 や Chef活用ガイド のような書籍を利用するのも手です。

実際に作ってみる

ここまでの手順がなんとなくわかったら、次は実際に Cookbook を作ってみます。

次のページ に進んでください。