SyntaxHighlighter

2012/12/26

build-essential

Cookbook情報

概要

各プラットフォームに対して、ビルドパッケージ群をまとめて導入する。

解説

Ubuntu Serverではgcc,libcmakeを使えるようにするために、とりあえずbuild-essentialをインストールします。 この感覚を複数のOS、ディストリビューションで再現するためのCookbookです。

Readmeから対応プラットフォームを抜粋。

  • Linux (fedora redhat centos ubuntu debian amazon scientific)
  • Darwin (macosx 10.6+)
  • SmartOs

SmartOSはcookbook[pkgin]に依存しているので一緒にChefServerに入れておけば動作します。

Recipes

レシピは一つ。Ohaiがプラットフォームを判断して適当なパッケージをinstallするだけです。

default

パッケージインストール部分をチェック、ディストリビューション毎にパッケージの配列を分岐させていますね。

packages = case node['platform_family']
  when "debian"
    %w{build-essential binutils-doc}
  when "rhel", "fedora"
    %w{gcc gcc-c++ kernel-devel make}
  when "suse"
    %w{gcc gcc-c++ kernel-default-devel make m4} # in SLES there is no kernel-devel
  end

packages.each do |pkg|
  r = package pkg do
    action ( compiletime ? :nothing : :install )
  end
  r.run_action(:install) if compiletime
end

%w{autoconf flex bison}.each do |pkg|
  r = package pkg do
    action ( compiletime ? :nothing : :install )
  end
  r.run_action(:install) if compiletime
end

このあとSmartOSやMacOSの記述ですが割愛します。

Attributes

設定が必要なデーモンなどの導入ではないので、特に気にするものはないです。

実行ログ1: CentOSに適用

sshが繋がる状態のCentOSをChef-clientに仕立ててついでにレシピを適用します。

$ knife bootstrap #{server} -r "recipe[build-essential]"

クラウドベンダに対応したknifeのプラグインを使ってインスタンスの作成から一発でやってもよいです。

$ knife zcloudjp machine create -I sdc:jpc:centos-6:1.3.0 -N cent66 -r "recipe[build-essential]"

検出されたプラットフォームに対応して、chef-clientによるコンバージェンスが行われます。

INFO: Loading cookbooks [build-essential]
INFO: Processing package[gcc] action install (build-essential::default line 51)
INFO: package[gcc] installing gcc-4.4.6-4.el6 from base repository
INFO: Processing package[gcc-c++] action install (build-essential::default line 51)
INFO: package[gcc-c++] installing gcc-c++-4.4.6-4.el6 from base repository
INFO: Processing package[kernel-devel] action install (build-essential::default line 51)
INFO: package[kernel-devel] installing kernel-devel-2.6.32-279.19.1.el6 from updates repository
INFO: Processing package[make] action install (build-essential::default line 51)
INFO: Processing package[autoconf] action install (build-essential::default line 58)
INFO: package[autoconf] installing autoconf-2.63-5.1.el6 from base repository
INFO: Processing package[flex] action install (build-essential::default line 58)
INFO: package[flex] installing flex-2.5.35-8.el6 from base repository
INFO: Processing package[bison] action install (build-essential::default line 58)
INFO: package[bison] installing bison-2.4.1-5.el6 from base repository

ビルド関連ツールがインストールされた状態にしてくれました。

実行ログ2: SmartOSに適用

Joyent SmartOSに対して行います、cookbook[pkgin]を添えます。

$ knife bootstrap #{server} -r "recipe[pkgin],recipe[build-essential]"

クラウドベンダに対応したknifeプラグインなら。

$ knife zcloudjp machine create -I sdc:sdc:base64:1.8.4 -N smart184 -r "recipe[pkgin],recipe[build-essential]"

検出されたプラットフォームに対応して、chef-clientによるコンバージェンスが行われます。

INFO: Loading cookbooks [build-essential, pkgin]
INFO: Processing pkgin_package[gcc47] action install (build-essential::default line 67)
INFO: Processing pkgin_package[gcc47-runtime] action install (build-essential::default line 67)
INFO: Processing pkgin_package[scmgit-base] action install (build-essential::default line 67)
INFO: Processing pkgin_package[gmake] action install (build-essential::default line 67)
INFO: Processing pkgin_package[pkg-config] action install (build-essential::default line 67)
INFO: Processing pkgin_package[binutils] action install (build-essential::default line 67)

こちらもビルド関連ツールがインストールされた状態にしてくれました。

あとがき

Chefはクロスプラットフォームの対応を進めており、少々モノが違っても大体同じことが出来るように作られています。
サーバの役割は外部に対してサービスを提供することであり、構築に付随する負担を削減しようという思想がこのCookbookにシンプルに現れているような気がします。

多くの人にとって、サーバ環境構築は目的でなくサービスを展開する手段なのですから。

2012/12/19

Package Installer

Cookbook情報

概要

Chefのビルトインリソースpackageをラップして、各種パッケージの構成をAttributeとして管理できるCookbook。

解説

レシピが内部DSLで良かったと思える一品、packageリソースが対応するプラットフォームすべてに有効だ。

パッケージの導入&削除およびバージョン指定&自動更新をEnvironmentRoleのメタデータとして管理できるので多少の構成変更ならCookbookの変更が不要になることも大きい。
もしパッケージをインストール/アンインストールするだけのCookbookを書いていたらpackage_installerに統合したらよい。

recipe

defaultが一つだけ、そして10行しか無いのでまるごと掲載する。

余談だがattributeの指定にシンボルを使うのはFoodcritic FC001に引っかかるので、一応覚えておこう。

default

node[:package_installer][:packages].each do |pkg_name, pkg_info|
  if(pkg_info)
    pkg_action = pkg_info[:action] || :install
    pkg_version = pkg_info[:version]
  end
  package pkg_name do
    action pkg_action
    version pkg_version if pkg_version
  end
end

バージョンを貰えば指定つきで、各種パッケージを指定したactionで構成するだけと非常にシンプルだ。

Attributes

  • ['package_installer']['packages']
  • ['package_installer']['packages']['$pkgname']
    • ['action']:省略時は:install
    • ['version']: 省略可

Attribute設定の例

このCookbookに限った話ではないが、packages以下の要素を複数のRole,Environmentで同じように指定した場合上書きでなくマージされる

あるRoleでvimを指定して、

"package_installer": {
  "packages": {
    "vim": nill
  } 
}

ほかのRoleでtmuxを指定したとする。

"package_installer": {
  "packages": {
    "tmux": {"action": "upgrade"}
  }
}

Nodeの持つ最終的なAttributesはこのようになる。

"package_installer": {
  "packages": {
    "vim": null,
    "tmux": {"action": "upgrade"}
  }
}

当然どこかでrun_listrecipe[package_installer]を一度入れておけば、Chef-clientサーバの状態をそのようにしておいてくれる。

適用例1

ubuntu_baseというRoleを作って、よく使うユーティリティをdefault_attiributesにて指定するというような使い方が便利だろう。

{"name": "base_ubuntu",
  "description": "Server Basic Settings",
  "json_class": "Chef::Role",
  "default_attributes": {
    "package_installer": {
      "packages": {
        "dstat": null,
        "vim": null,
        "curl": {
          "action": "upgrade"
        },
        "yajl-tools": null,
        "tmux": null,
        "iotop": null,
        "nano": {
          "action": "remove"
        },
        "bsd-mailx": null
      }
    }
  },
  "override_attributes": {},
  "chef_type": "role",
  "run_list": [
    "recipe[package_installer::default]"
  ],
  "env_run_lists": {}
}

例ではopscodeのaptのCookbookも入れている、Chefサーバかcookbookのパスに一緒に入れておくことをお勧め。

実行ログ例1

INFO: Processing package[curl] action upgrade (package_installer::default line 7) 
INFO: package[curl] upgraded from uninstalled to 7.22.0-3ubuntu4 
INFO: Processing package[tmux] action install (package_installer::default line 7) 
INFO: Processing package[bsd-mailx] action install (package_installer::default line 7) 
INFO: Processing package[yajl-tools] action install (package_installer::default line 7) 
INFO: Processing package[nano] action remove (package_installer::default line 7) 
INFO: package[nano] removed INFO: Processing package[dstat] action install (package_installer::default line 7) 
INFO: Processing package[iotop] action install (package_installer::default line 7) 
INFO: Processing package[vim] action install (package_installer::default line 7) 

適用例2

syslog-ngのレシピを適用したいが、他のsyslog系を止めたい。これをRoleに書くことでCookbook修正の手間を軽減できる。

-- snip --
"default_attributes": {
  "package_installer": {
    "packages": {
      "rsyslog": { "action": "remove" },
      "syslog": { "action": "remove" }
    }
  }
},
"run_list": [ "recipe[syslog-ng::default]" ]
-- snip -- 

この場合はもちろん、How to write a good Chef cookbookのようにレシピ内で書いても良いが。

あとがき

このCookbookはOpscode作でなくコミュニティでShareされているもので、なおかつ1コミットで終了してライセンス表記もない。
しかし『Chef導入≠レシピ書く』を印象付けるのにとてもわかりやすいため紹介することにした。

このブログについて

『Opscode ChefのCookbookレビュー』は、OpsCodeの構成管理ツールChefについて、主にOpscodeコミュニティで入手できるCookbooksの解説と使い方を投稿するブログです。

汎用的に作られたCookbookを使うためには、EnvironmentRoleAttribute重ねがけすることになります。
Chefを導入してしばらく経ちますが、特にAttributeが重要だと気付いてからはコミュニティのCookbooksを積極的に利用しています。

レビューによってCookbookの使い方、書き方のコツを身につけつつ、ついでに情報公開することが目的です。