Red Hat Satellite webhooks およびエラータ

Red Hat Satellite には、イベントの発生時に通知するかアクションを実行するための Webhook が含まれます。たとえば、Webhook は、 Red Hat Enterprise Linux (RHEL) ホストにエラータのインストールが完了した場合に (それ以外にも他に多数のイベントが発生した場合に) 通知できます。Webhook メカニズムは、Satellite と Red Hat Ansible Automation Platform、Splunk および ServiceNow など、多数のアプリケーションとの統合をサポートします。

Webhook とは

通常、Webhook は、HTTP プロトコルを使用する API 呼び出し (またはプログラムプロシージャー/関数) です。Satellite では、固有のイベントで、Webhook の実行をトリガーできます。特定のイベントとして、ホストの作成、新規 Satellite 管理ユーザー・アカウントの作成、リモート実行ジョブなど多数が含まれます。

上図では、Satellite イベントまたはジョブが完了すると、Webhook が実行されます。この Webhook は、ネットワーク上にあるアプリケーションで API 呼び出しを実行します。API 呼び出しを受信すると、アプリケーションは、ダッシュボードの更新または警告のトリガーなど、別のアクションを実行します。

Webhook がトリガーされると、事前設定されたリモートエンドポイント (Ansible Automation Platform など) に対して実行されます。つまり、Webhook には URL や Webhook をトリガーしたイベントなど、リモートエンドポイントの情報が含まれます。

Webhook は、サードパーティが定義した仕様に従い、サードパーティ・アプリケーションの API と対話できるように設定しておく必要があります。

Satellite になぜメールを送信させないのでしょうか？送信させることもできますが、Webhook を使用するとそれ以外に多数のことができ、Satellite イベントとサードパーティ・アプリケーションを統合できます。また、メールを読み込む必要がなく、Webhook が送信した API 呼び出しへの応答をより簡単に自動化できます。

エラータとは

エラータは、セキュリティの問題、バグ、または新機能の公開をもとにしたソフトウェアパッケージの修正や更新を参照します。Satellite を使用すると、RHEL ホストに一括してエラータを自動適用できます。

エラータの例

たとえば、RHSA-2023: 0832 など、セキュリティの脆弱性が新たに検出された場合、Satellite を使用してエラータを適用し、脆弱性を解決できます。Satellite がエラータのインストールを終えると、Webhook を実行して、対象イベントのセカンダリ・システムに通知できます。

以下は、テスト用の Satellite Server から https://webhook.site (Webhook のテストサイト) に送信された Webhook のスクリーンショットです。Webhook は、RHSA-2023：0832 エラータのインストール後に実行されました。

設定方法

webhook メニューでのナビゲーション

“Administer” と “Webhooks” をクリックします。

Webhook の新規作成

“Create new” をクリックします。

フィードの選択

Satellite イベントのフィードを選択する必要があります。選択したフィードからイベントが発生したら、Webhook が実行されます。

1. “Subscribe to” をクリックします。
2. フィードを選択します。この特定の例では、リモート実行ジョブが完了したら Webhook を送信します。

1. webhook に名前を指定します。
2. Give the webhook にターゲットの URL を指定します。この例では、テスト用にエンドポイントとして webhook.site を使用します。
3. イベントに含まれる情報をキャプチャーするテンプレートを選択します。
4. API 呼び出しを実行する HTTP メソッドを選択します。
5. webhook を有効化します。
6. “Submit” をクリックして、Webhook を保存します。

Webhook のテスト

これで webhook をテストできます。

“Test webhook” をクリックします。

“Submit” をクリックします。

webhook が正しく設定されている場合は、webhook.site でイベントが表示されるはずです。

Webhook を利用して Satellite 管理を効率化

Webhooks を使用すると、Satellite イベントを追跡し、プロセスと運用をより簡単に自動化できるように支援します。また、Satellite のイベントおよび Webhook は、お使いのインフラストラチャおよびアプリケーションが最新の状態を保てるように、リアルタイムでパッチを監査するための情報源となります。Satellite の Webhook は、Event-Driven Ansible と統合して、データセンターやクラウドベースのインフラストラクチャでさらにイベントに自動で対応できるようにします。

関連情報

• What is a webhook？
• Explaining Red Hat Errata
• Satellite 6.14 Using Webhooks
• RHSA-2023: 0832 - Security Advisory
• Event-Driven Ansible