お題: Jenkins の Cookbook をつくる
Jenkins とは
手動でインストールするときの手順
Cookbook のひな形をつくる
ChefDK 内包の chef コマンドで Cookbook のひな形を生成します。
| 目次 |
|---|
基本的な用語
Chef でのプロビジョニングを行うには、まず Resource、Recipe、Cookbook という単語をおさえておきましょう。
これは、Chef を使うにあたって最低限作らなければいけないものです。
| Section | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Cookbook をつくる
Cookbook のひな形の生成
まずは Cookbook を作成しましょう。
ChefDK の chef generate cookbook コマンドを使えば簡単に Cookbook のひな形を生成できます。
| コード ブロック |
|---|
$ cd workspace $ chef generate cookbook <Cookbook 名> |
| 情報 |
|---|
Cookbook |
...
のディレクトリ構成 |
...
|
コマンドを実行すると、以下のファイルが作成されます。
.kitchen.yml
Kitchen の設定ファイル
テスト用のインスタンスや実行するプロビジョニングの設定を記述
Berksfile
|
...
chefignore
ChefClient に転送しないファイルを定義
metadata.rb
Cookbook の基本情報を記述
|
Cookbook を Eclipse で編集しよう
Eclipse のプロジェクトファイル ".project" をつくっておけば、Cookbook を Eclipse プロジェクトとして開けます。
ツリービューとタブエディタ（だけ）は便利なので、 他によいエディタがない場合は、次の手順で Eclipse プロジェクトをインポートしましょう。
.project を生成
スクリプトを実行し .project を生成します。
| コード ブロック |
|---|
$ cd <Cookbook 名>
$ gen-eclipse |
| 注意 |
|---|
"gen-eclipse" は開発環境の ~/bin/gen-eclipse に置いてある .project 生成用のスクリプトです。 |
プロジェクトをインポート
Eclipse を起動し、プロジェクトをインポートします。
| 1 | 2 | 3 |
|---|---|---|
File -> Import... |
General -> Existing Projects into Workspace Next |
「/home/vagrant/workspace/<Cookbook 名>」を追加 Finish |
Package Explorer に隠しファイルも表示させる
標準では .kitchen.yml が見えないので、次の手順で隠しファイルを表示します。
| 1 | 2 |
|---|---|
Package Explorer の ▽ を選択 -> Filters… |
「.*resources」のチェックを外す OK |
Recipe を書く
default Recipe
chef generate cookbook コマンドを実行すると、./recipes/default.rb というファイルができていると思います。
それが Cookbook
...
がデフォルトで適用する Recipe です。
基本的には、このファイルに Recipe を書いていきます。
| ヒント | ||
|---|---|---|
default Recipe 以外の Recipe は chef generate recipe コマンドで追加できます。
|
Resource の要素
Recipe には Resource を定義していきます。
Resource とは、プロビジョニング先の ”ある部分” の ”あるべき状態” を宣言する DSL で、具体的には以下の要素で構成されます。
| Section | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| ヒント |
|---|
ResourceType についての公式ドキュメントは Chef の公式ドキュメントから辿ると非常に見つけにくいです。 |
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 |
| ヒント |
|---|
notifies などを利用して、Resource の実行順序を制御することも可能です。 |
| ヒント |
|---|
Recipe に書いたコードは Recipe がコンパイルされるときに実行されます。 |
冪等性を確保する
Chef では 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 のブロックでなく、文字列を直接わたすこともできます。
| コード ブロック |
|---|
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 を書く手順
- 具体的に何をしたいのかを明らかにする
- 使えそうな Resource をさがす
- 実際に Recipe を書く
はじめは、目的に対して適切な Resource をさがせることがいちばん大事です。
Google で検索してもいいですし、Dash を使ってもいいですし、Chef実践入門 や Chef活用ガイド のような書籍を利用するのも手です。
実際に作ってみる
ここまでの手順がなんとなくわかったら、次は実際に Cookbook を作ってみます。
次のページ に進んでください。