構築した StackStorm 環境に対して、以下のように AWS で発生したイベントを検知してアクション core.local を実行する環境を構築します（'core.local' がどんな処理を行うかについては以降で解説します）。
ここでは Amazon CloudWatch で検出された Amazon EC2 のリソース変更のイベントを検知し、core.local アクションを実行させます。
core.local は Worker ノードにおいて任意のコマンドを実行するアクションになります。StackStorm では次のように、アクションを単体実行することもできます。
パラメータ cmd で受けたコマンド date を、ローカルノード st2-node で実行しています。実行結果の result.stdout パラメータから、当該アクションで得られた標準出力の結果を確認できます。また status から、当該アクションが正常終了 (succeeded) したことが確認できます。
以下では、このアクションを冒頭の図で示したように 'aws.sqs_new_message' トリガが引かれた際に実行する方法を解説します。
ここでは以下の設定を行い、AWS のイベントが呼ばれた際に core.local アクションが実行されるようにします。
- aws pack のインストール
- aws pack の設定
- Amazon SQS, CloudWatch の設定
- Rule の設定
サードパーティの様々な pack が StackStorm Exchange に登録されており、ここに登録されている pack を以下のコマンドでインストールできます。ここでは aws の最新の pack をインストールします。
$ st2 pack install aws
インストールされた pack は以下のコマンドで確認できます。
$ st2 pack list
インストールされた pack に関連するファイルは、通常 /opt/stackstorm/packs 配下に展開されます。今回インストールした aws pack の場合は /opt/stackstorm/packs/aws になります。
また各 pack の設定ファイル 'config.yaml' が、pack のディレクトリのトップに配置されます。ここで aws の設定ファイルを次のように編集してください。
---
aws_access_key_id: "*****"
aws_secret_access_key: "******"
region: "ap-northeast-1"
interval: 20
st2_user_data: "/opt/stackstorm/packs/aws/actions/scripts/bootstrap_user.sh"
service_notifications_sensor:
host: "localhost"
port: 12345
path: "/my-path"
sqs_sensor:
input_queues: "notification_queue"
sqs_other:
max_number_of_messages: 1冒頭の aws_access_key_id, aws_secret_access_key 及び region で認証情報とリージョンを設定しています。aws_access_key_id と aws_secret_access_key の取得方法については AWS のドキュメント を参照してください。リージョンは東京リージョン 'ap-northeast-1' を指定します。
またイベントメッセージが通知される Amazon SQS のキュー名 'notification_queue' を指定します。ここで指定したキューはこの後で AWS マネジメントコンソール から作成します。
最後に、更新した設定を読み込ませるため、センサを再起動させます。
$ sudo st2ctl restart-component st2sensorcontainer
AmazonSQS は Amazon が提供するフルマネージの MQ サービスで、CloudWatch はモニタリングサービスです。ここでは CloudWatch において EC2 や S3 などのリソースが変更された際に、AmazonSQS に通知メッセージを送るように設定します。
StackStorm は SQS に送られたメッセージを取得することで、間接的に AWS のイベントをハンドリングできます。StackStorm は SQS を利用する方法の他に、Amazon SNS を利用して通知を取得することもできます。後者の設定方法については、本稿では割愛します。
では、それぞれの設定を実施します。
まず以下のように AmazonSQS のコンソール から、pack の設定ファイルの sqs_sensor.input_queues で指定した名前のキューを作成します。
続いて CloudWatch のコンソール で EC2 のイベントを SQS のキュー 'notification_queue' に送るルールを作成します。
ここまでの設定で EC2 のイベントを aws pack のセンサ AWSSQSSensor で検知する準備が整いました。
次に、センサ AWSSQSSensor がトリガ aws.sqs_new_message を引いた際に、アクション core.local を実行するルールを定義します。
以下がルール定義の全文になります。ルール定義は YAML 形式で記述します。これをホームディレクトリに ec2_event_handling.yaml という名前でに保存します。
---
name: 'ec2_event_handling'
description: 'A rule to get events on Amazon EC2'
enabled: True
trigger:
type: aws.sqs_new_message
action:
ref: 'core.local'
parameters:
cmd: 'echo "{{trigger.body}}" >> /tmp/results'
criteria:
trigger.queue:
pattern: 'notification_queue'
type: 'equals' 冒頭の name と description は、それぞれルールのラベルと説明文を表します。enabled パラメータは、当該ルールを有効化するかどうかを設定するためのもので、False を指定した場合には、ルールで指定したトリガが引かれてもアクションを実行しません。
また trigger と action パラメータによって、トリガとアクションの紐付けを行っています。それぞれ trigger.type と action.ref パラメータでどのトリガが引かれたら、どのアクションを実行するかを指定しています。
末尾の criteria では、アクションを実行する条件を記述することができます。StackStorm のルールエンジン (RuleEngine) は、trigger.type で指定したトリガが引かれ、かつ criteria で指定した条件に合致した場合に action.ref で指定したパラメータを実行します。ここでは、以下で示すトリガパラメータの queue の値が notification_queue だった場合に、アクションを実行する設定を記述しています。
なお criteria パラメータは省略可能です。その際は trigger.type のトリガが引かれた場合に action.ref のアクションを実行します。
アクションの指定に関してもう少し詳しく解説します。action.parameters では、トリガからの出力パラメータとアクションへの入力パラメータの変換設定を行っています。ここでは、トリガの出力 body パラメータを echo コマンドの引数に指定しています。
トリガとアクションがそれぞれがどういったパラメータを持っているかについては st2 action get と st2 trigger getコマンドで確認できます。以下は、それぞれのパラメータを確認した結果です。
トリガ aws.sqs_new_message の出力として queue と body のパラメータがあり、そしてアクション core.local の入力として cmd と sudo パラメータがあることがわかります。またアクションの入力パラメータのうち cmd は required: true となっており、必須パラメータであることを表しています。
ここでいよいよルールを登録して EC2 にインスタンスを作成し、そのイベントを検知できるか確認します。
まずは以下のコマンドで、先ほど作成したルールを登録します。
続いて EC2 のコンソール から、インスタンス 'test-instance' を作成します。
程なくして、ルールで記述した echo コマンドのリダイレクト先のファイル /tmp/results に CloudWatch の出力が表示されることが確認できます。
ここまで EC2 のイベントを StackStorm で受け取り、ユーザ定義のルールに沿って処理する方法について解説してきました。ここまでの内容を応用することで、様々なアプリケーションサービスと連携する処理を簡単に設定することができます。
尚、本章の内容を実際に動かして確認するにはクレジットカード登録を行った AWS アカウントが必要になり、手軽に試すことができないユーザもいるかもしれません。そうした方は ツチノコブログ に別の例 (GitHub と RabbitMQ を利用したイベントハンドリング) を示しましたので、併せてご参照ください。