cfn-hup

説明

cfn-hup ヘルパーは、リソースメタデータの変更を検出し、変更が検出された場合は、ユーザーが指定した操作を実行するデーモンです。これによって、UpdateStack API アクションを介して、実行中の Amazon EC2 インスタンスに構成を更新できます。

構文

cfn-hup --config|-c config.dir \
        --no-daemon \
        --verbose|-v

オプション

名前	説明	必須
--config|-c config.dir	cfn-hup スクリプトが cfn-hup.conf および hooks.d ディレクトリを探すパスを指定します。Windows では、デフォルトのパスは system_drive\cfn です。Linux では、デフォルトのパスは /etc/cfn です。	不可
--no-daemon	cfn-hup スクリプトを一度実行して終了するには、このオプションを指定します。	不可
-v, --verbose	詳細モードを使用するには、このオプションを指定します。	不可

cfn-hup.conf 構成ファイル

cfn-hup.conf ファイルは、cfn-hup デーモンのターゲットとなるスタックの名前と AWS 認証情報を格納します。

cfn-hup.conf ファイルでは、次の形式が使用されます。

[main]
stack=<stack-name-or-id>  

名前	説明	必須
stack	スタックの名前または ID です。 タイプ: 文字列	可能
credential-file	コマンドラインツールで使用するのと同じ形式の、所有者のみの認証情報ファイルです。 タイプ: 文字列 条件: role パラメータは、このパラメータより優先されます。	不可
role	インスタンスに関連付けられた IAM ロールの名前です。 タイプ: 文字列	不可
region	スタックを含む AWS リージョンの名前です。 例: us-east-2	不可
umask	cfn-hup デーモンによって使用される umask。 この値は、前に 0 を付けても、付けなくても指定できます。両方の場合も、8 進数として解釈されます (Linux の umask コマンドと同様)。このパラメータは Windows には影響しません。 タイプ : 0～0777 の 8 進数の整数 デフォルト: 022、バージョン 1.4–22 以上。022 のデフォルト値は、グループとワールド書き込み許可をマスクするため、cfn-hup デーモンによって作成されるファイルは、デフォルトでグループまたはワールドの書き込みができません。バージョン 1.4〜21 以前のデフォルト値は 0 で、何もマスクされません。	不可
interval	リソースメタデータへの変更を確認する間隔 (分単位)。 タイプ: 整数 デフォルト: 15	不可
verbose	詳細ログ記録を行うかどうかを指定します。 タイプ: ブール デフォルト: false	不可

hooks.conf 構成ファイル

cfn-hup デーモンが定期的に呼び出すユーザーアクションは、hooks.conf 構成ファイルに定義されています。hooks.conf ファイルでは、次の形式が使用されます。

[hookname]
triggers=post.add or post.update or post.remove
path=Resources.<logicalResourceId> (.Metadata or .PhysicalResourceId)(.<optionalMetadatapath>)
action=<arbitrary shell command>
runas=<runas user> 

オペレーションが実行されるとき、現在の環境のコピー (cfn-hup が所在する環境) で実行され、かつ CFN_OLD_METADATA はパスで指定された前のメタデータ値に設定され、CFN_NEW_METADATA は現在の値に設定されます。

フック構成ファイルは cfn-hup デーモンの開始時にのみロードされるため、新しいフックはデーモンを再起動する必要があります。以前のメタデータ値のキャッシュは、/var/lib/cfn-hup/data/metadata_db— に保存されます。このキャッシュを削除すると、cfn-hup に強制的にすべての post.add アクションを再実行させることができます。

名前	説明	必須
hookname	このフックの一意の名前。 タイプ: 文字列	可能
triggers	検出する条件のカンマ区切りのリストです。 有効な値: post.add、post.update、または post.remove 例: post.add, post.update	可能
path	メタデータオブジェクトへのパスです。メタデータブロック内の任意の深いパスをサポートします。 パス形式オプション リソース。<LogicalResourceId> — リソースの最終更新時間を監視します。リソースが変更されたらトリガーします。 リソース。<LogicalResourceId>.PhysicalResourceId — リソースの物理 ID を監視します。関連付けられているリソース ID が変化した場合にだけトリガーします (新しい EC2 インスタンスなど)。 リソース。<LogicalResourceId>.Metadata (.optional パス) — リソースのメタデータの変更を監視します (特定の値を監視するために、メタデータのサブパスが任意の深いレベルに指定される場合があります)。	可能
action	所定のものとして実行される任意のシェルコマンドです。	可能
runas	コマンドの実行者となるユーザーです。Cfn-hup は、ユーザーに切り替えるために su コマンドを使用します。	可能

hooks.d ディレクトリ

変更通知フックをデプロイする複数のアプリケーションの構成をサポートするために、cfn-hup はフック構成ディレクトリにある hooks.d という名前のディレクトリをサポートします。hooks.d ディレクトリには、1 つ以上の追加のフック構成ファイルを含めることもできます。追加のフックファイルは、hooks.conf ファイルと同じレイアウトを使用する必要があります。

cfn-hup デーモンは、このディレクトリの各ファイルを解析およびロードします。hooks.d ディレクトリのいずれかのフックが hooks.conf 内のフックと同じ名前である場合、フックはマージされます (つまり、両方のファイルで指定されている値では、hooks.d が hooks.conf を上書きします)。

例

次のテンプレートスニペットでは、CloudFormation は cfn-auto-reloader.conf フックファイルを、LaunchConfig リソースに関連付けられた AWS::CloudFormation::Init リソースが変更された時にトリガーします。

JSON

...
    "LaunchConfig": {
      "Type" : "AWS::AutoScaling::LaunchConfiguration",
      "Metadata" : {
        "QBVersion": {"Ref": "paramQBVersion"},
        "AWS::CloudFormation::Init" : {
...
              "/etc/cfn/hooks.d/cfn-auto-reloader.conf": {
                "content": { "Fn::Join": [ "", [
                  "[cfn-auto-reloader-hook]\n",
                  "triggers=post.update\n",
                  "path=Resources.LaunchConfig.Metadata.AWS::CloudFormation::Init\n",
                  "action=/opt/aws/bin/cfn-init -v ",
                          "         --stack ", { "Ref" : "AWS::StackName" },
                          "         --resource LaunchConfig ",
                          "         --configsets wordpress_install ",
                          "         --region ", { "Ref" : "AWS::Region" }, "\n",
                  "runas=root\n"
                ]]},          
                "mode"  : "000400",
                "owner" : "root",
                "group" : "root"
              }
...

YAML

...
  LaunchConfig:
    Type: "AWS::AutoScaling::LaunchConfiguration"
    Metadata:
      QBVersion: !Ref paramQBVersion
      AWS::CloudFormation::Init:
...
            /etc/cfn/hooks.d/cfn-auto-reloader.conf:
              content: !Sub |
                [cfn-auto-reloader-hook]
                triggers=post.update
                path=Resources.LaunchConfig.Metadata.AWS::CloudFormation::Init
                action=/opt/aws/bin/cfn-init -v --stack ${AWS::StackName} --resource LaunchConfig --configsets wordpress_install --region ${AWS::Region}
                runas=root
              mode: "000400"
              owner: "root"
              group: "root"
...

その他の例

サンプルテンプレートについては、「Amazon EC2 にアプリケーションをデプロイする」を参照してください。