ページ履歴

基本的な用語

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

Cookbook をつくる

Cookbook のひな形の生成

まずは Cookbook を作成しましょう。 

ChefDK の chef generate cookbook コマンドを使えば簡単に Cookbook のひな形を生成できます。

$ cd workspace
$ chef generate cookbook <Cookbook 名>

Cookbook を Eclipse で編集しよう

Eclipse のプロジェクトファイル ".project" をつくっておけば、Cookbook を Eclipse プロジェクトとして開けます。
ツリービューとタブエディタ（だけ）は便利なので、 他によいエディタがない場合は、次の手順で Eclipse プロジェクトをインポートしましょう。

.project を生成

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

...

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

Eclipse を起動し、プロジェクトをインポートします。

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

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

Recipe

...

を書く

default 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 の実行順序

...

chef generate cookbook コマンドを実行すると、./recipes/default.rb というファイルができていると思います。
それが Cookbook がデフォルトで適用する Recipe です。
基本的には、このファイルに Recipe を書いていきます。

ヒント
default Recipe 以外の Recipe は chef generate recipe コマンドで追加できます。 コード ブロック $ chef generate recipe <Cookbook のパス> <Recipe の名前>

Resource の要素

Recipe には Resource を定義していきます。
Resource とは、プロビジョニング先の ”ある部分” の ”あるべき状態” を宣言する DSL で、具体的には以下の要素で構成されます。

Resource の実行順序

Recipe は上から順にコンパイルされ、Resource Collection に格納されます。
基本的には Resource Collection に格納された順で Resource が収束されますので、
たとえば、「ファイルをダウンロード」してから「そのファイルを解凍」したい場合は、次のように記述できます。 

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では Resource の収束結果は何度実行しても常に同じでなければいけません。
yum_package などであれば、何も考えなくとも冪等性が確保されるのですが、
execute や bash、ruby_block などではサーバーにどのような変更が行われるのか Chef が判断できないので、
自力で冪等性を確保する必要があります。 

冪等性を確保するためのひとつの手段として、ガード条件 があります。
これは、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 のブロックでなく、文字列を直接わたすこともできます。

...

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

Recipe を書く手順 

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

...

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

実際に作ってみる

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

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