Menu Close

Red Hat Hybrid Cloud Console での通知および統合の設定

Red Hat Hybrid Cloud Console 2022

アカウントユーザーが RHEL システムに関するイベントによってトリガーされる通知を受信するように Hybrid Cloud Console を設定する

概要

通知を使用して、発生した特定のイベントと、これが組織に影響を与える可能性について確認します。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージ をご覧ください。

Red Hat Hybrid Cloud Console ドキュメントへのフィードバック

弊社ドキュメントに対するご意見をお聞かせください。ドキュメントの改善点はございませんか。これを行うには、Bugzilla のチケットを作成します。

  1. Bugzilla の Web サイトに移動します。
  2. Component で Documentation を選択します。
  3. Description フィールドに、ドキュメントの改善に関するご意見を記入してください。ドキュメントの該当部分へのリンクも記入してください。
  4. Submit Bug をクリックします。

1. Red Hat Hybrid Cloud Console の通知および統合の概要

Red Hat Hybrid Cloud Console の通知サービスにより、ユーザーは、イベントによってトリガーされる通知がないかどうか、ユーザーインターフェイスを定期的にチェックする必要がなくなります。代わりに、イベントが発生すると、サービスが自動的にアクションを実行して、イベントに関する通知をユーザーに送信します。

重要

通知管理者ロールを含むグループおよびロールは、電子メールおよび統合でイベントを報告するために、組織管理者によって設定される必要があります。

Red Hat Hybrid Cloud Console プラットフォームでのユーザーアクセスの詳細は、User Access Configuration Guide for Role-based Access Control (RBAC) を参照してください。

1.1. 通知サービスの機能

通知サービスを通じて、Red Hat Hybrid Cloud Console アプリケーションおよびサービスには、ユーザーにイベントを通知する標準化された方法があります。動作グループを設定することにより、通知管理者は通知配信方法を指定し、イベント通知をアカウントのすべてのユーザーに送信するか、組織管理者のみに送信するかを指定します。

たとえば、通知管理者は、システムでの (アドバイザーサービスの) 新しい推奨ヒットのメール通知を送信するようにサービスを設定できます。同様に、管理者は、webhook 統合タイプを使用して、メッセージをサードパーティーのアプリケーションに送信する通知をトリガーすることを決定する場合があります。

組織管理者は、通知管理者ロールでユーザーアクセスグループを作成し、そのグループにアカウントメンバーを追加して、通知管理者を指定します。次に、通知管理者は、サービス固有のイベントが発生したときに実行されるアクションを定義する通知動作グループを設定します。

通知サービスは、イベントによってトリガーされる通知をユーザーのメールアカウントに、または webhook を使用してサードパーティーのアプリケーションに送信します。Hybrid Cloud Console アカウントのユーザーは、メール通知を受信する独自の設定を行います。各ユーザーは、User preferences > Notifications > application bundle で個人設定を行い、イベント通知のメールを即時通知または毎日のダイジェストとして受け取るように設定します。

重要

サービスの 即時通知 を選択すると、大量のメールを受け取る可能性があります。

1.2. 通知および統合の概念

以下の表では、通知サービスの仕組みを理解する際に重要な用語を定義しています。

表1 通知の概念

概念説明

アクション

イベントに応答して実行される操作。例としては、電子メールの送信や webhook などの統合エンドポイントへの通知の転送があります。アクションは、通知管理者によって設定された動作グループで定義されます。

アプリケーションバンドル

アプリケーションバンドルは、Red Hat Enterprise Linux (Insights for RHEL) や OpenShift などの Hybrid Cloud Console 内のアプリケーショングループを参照します。

動作グループ

動作グループは、イベントが発生したときに実行するアクションと、すべてのアカウントユーザーに通知するか、指定された管理者のみに通知するかを決定します。通知管理者が動作グループを作成すると、それをイベントタイプに関連付け、通知管理者がすべてのアプリケーション固有のイベントに同じアクションを適用できるようにします。

注記: 通知管理者は、アプリケーションバンドルごとに通知動作グループを別々に設定します。

メール設定

Hybrid Cloud Console でアプリケーションにアクセスできる個々のユーザーは、個人のメール設定を行います。ユーザーは、個人の電子メール通知をイベントが発生するとすぐに受信するように設定したり、すべてのアカウントで毎日のダイジェストに統合して深夜 (協定世界時 (UTC) 00:00) に受信するように設定したりできます。

重要: いずれかのサービスの即時通知を選択すると、大量のメールを受信することになる可能性があります。

イベントタイプ

イベントタイプは、アプリケーション固有のシステム変更で、アプリケーションやサービスをトリガーして通知アクションを開始します。イベントタイプは、Red Hat でアプリケーション開発者が作成し、アプリケーションバンドルごとに固有です。Insights for RHEL (Red Hat Enterprise Linux) アプリケーションバンドルの例は次のとおりです。

* ポリシーサービス: ポリシーがトリガーされました。

* ドリフトサービス: ベースラインからのドリフトが検出されました。

* アドバイザーサービス: 新しい推奨事項。解決した推奨事項。

統合

統合は、通知管理者が設定したサードパーティーアプリケーションへの通知の配信方法を定義します。設定が完了すると、通知サービスが HTTP POST メッセージをエンドポイントに送信します。現時点では、webhook タイプのみがサポートされます。

ユーザーアクセスロール

以下のユーザーアクセスロールは、通知と対話します。

* 組織管理者

* 通知管理者

* 通知ビューアー

2. ユーザーアクセスの設定

アカウントユーザーが通知および統合設定を設定する前に、通知管理者ロールを持つグループを組織管理者がユーザーアクセスで設定する必要があります。組織管理者は、User Access > Groups で以下の基本手順を実施します。

  • 通知管理者のユーザーアクセス グループ を作成します。

    • 通知管理者 ロール をグループに追加します。
    • メンバー (アカウントアクセスを持つユーザー) をグループに追加します。

組織管理者

組織管理者は、通知管理者のユーザーアクセスグループを設定してから、通知管理者ロールおよびユーザーをグループに追加します。

通知管理者ロール

通知管理者は、アプリケーションが通知と対話する方法を設定します。通知管理者は、動作グループを設定して、アプリケーションがイベントについてユーザーに通知する方法を定義します。管理者は、追加の統合が利用可能になったときに設定したり、既存の統合を編集、無効化、および削除したりできます。

通知ビューアーロール

通知ビューアーロールは、アカウントのすべてのユーザーに自動的に付与され、ユーザーが通知サービスビューおよび設定と対話する方法を制限します。ビューアーは通知設定を表示できますが、変更または削除できません。また、ビューアーは、統合を設定、修正、削除できません。

Red Hat Hybrid Cloud Console プラットフォームでのユーザーアクセスの詳細は、User Access Configuration Guide for Role-based Access Control (RBAC) を参照してください。

2.1. ユーザーアクセスでの通知グループの作成および設定

以下の手順では、アカウントの 組織管理者 が、通知管理者 ロールを持つグループを作成し、メンバーをグループに追加する方法を示しています。

前提条件

  • 組織管理者として Red Hat Hybrid Cloud Console アカウントにログインしている。

手順

  1. アプリケーションウィンドウの右上にある ギアアイコン をクリックし、Settings を選択します。

    img hcc toolbar settings

  2. 左側の Settings メニューから User Access をクリックし、Groups を選択します。
  3. Create Group をクリックします。
  4. 通知管理者などのグループ名と説明を入力してから、Next をクリックします。
  5. このグループに追加するロールを選択します (この場合は Notifications administrator)。そのロールのチェックボックスをクリックしてから、Next をクリックします。
  6. グループにメンバーを追加します。個々のユーザーを検索するか、ユーザー名、メール、またはステータスでフィルタリングします。対象となる各メンバーの名前の横にあるチェックボックスにチェックを入れてから、Next をクリックします。
  7. 詳細を確認して、すべてが正しいことを確認します。戻って変更する必要がある場合は Back をクリックします。
  8. Submit をクリックしてグループの作成を終了します。

2.2. ユーザーアクセスグループの編集または削除

ユーザーアクセスグループを編集または削除する必要がある場合は、以下の手順を実行します。

前提条件

  • 組織管理者として Red Hat Hybrid Cloud Console アカウントにログインしている。

手順

  1. User Access > Groups でグループ名を見つけます。
  2. グループ名の行右端のメニューオプションアイコン ( img hcc icons options ) をクリックし、Edit または Delete をクリックします。
  3. 変更して保存するか、グループを削除します。

3. 統合の設定

Red Hat Hybrid Cloud Console の通知および統合サービスは、トリガーするイベントが発生すると連携して、インスタントメッセージングプラットフォームや外部チケットシステムなどのサードパーティーアプリケーションエンドポイントにメッセージを送信します。

これにより、通知管理者は Hybrid Cloud Console 機能を組織で使用される運用ワークフローに統合できます。統合は、通知管理者によって Red Hat Red Hat Hybrid Cloud Console > Settings > Integrations のエンドポイントとして設定されます。

注記

Webhook は、Red Hat Hybrid Cloud Console プラットフォームでサポートされる現在の統合タイプです。これを設定すると、サービスは HTTP POST メッセージを指定のサードパーティーアプリケーションエンドポイントに送信します。

3.1. HTTP POST メッセージ

以下のスクリーンショットは、サードパーティーのアプリケーションエンドポイントに送信される HTTP POST メッセージの例です。イベントタイプはサービスまたはアプリケーションに固有のものです。たとえば、Insights for RHEL アプリケーションバンドルは現在、ポリシー、アドバイザー、ドリフトサービスからのイベントを設定済みユーザーに通知します。Insights for RHEL アドバイザーサービスからの以下の通知例は、ホストシステムの新しい推奨事項によりトリガーされました。

img hcc notif schema

この例では、ブロックには以下の情報が含まれます。

  1. 通知を送信するバンドルおよびアプリケーションに関する情報

    • bundle: アプリケーションバンドルの名前
    • application: イベントによってトリガーされる通知を送信する個々のアプリケーションまたはサービスの名前
    • event_type: 通知をトリガーしたイベントタイプ
    • account_id: 通知が送信された Red Hat アカウント
    • timestamp: 通知が送信された日時を示す ISO-8601 形式の日付
  2. アプリケーションまたはサービス固有のイベントに関する情報

    • payload: アプリケーションペイロード (アプリケーションによって送信されたすべてのデータを含む JSON 文字列)
  3. イベントが発生したシステムに関する情報以下に例を示します。

    • inventory_id: システム ID
    • hostname: システム名
    • rhel_version: システムで実行している RHEL バージョン

メタデータフィールドは現在使用されていません。

3.2. 統合の設定

通知管理者は、組織の統合を設定します。通知管理者は、新しい統合を追加するだけでなく、統合名の右側にあるその他のオプションメニューアイコン img hcc icons options をクリックして、適切なオプションをクリックすることで、リストされている統合を編集、削除、または無効にすることができます。

前提条件

  • 以下の手順を実行するために、ユーザーアクセスで設定した通知管理者権限で Red Hat Hybrid Cloud Console プラットフォームにログインしている。

手順

  1. Red Hat Hybrid Cloud Console > Settings > Integrations に移動します。
  2. Add integration をクリックします。

    1. Integration name を入力します。
    2. webhook などの統合 Type を選択します。
    3. エンドポイント URL を指定します。
    4. SSL 検証を有効にするチェックボックスはデフォルトで選択されています。

      重要

      SSL は、統合エンドポイントに送信されるデータを保護するために不可欠です。Red Hat Hybrid Cloud Console をサードパーティーアプリケーションに統合する場合は、SSL を常に使用する必要があります。

    5. 必要に応じてシークレットトークンを提供します。

      注記

      定義された場合、シークレットトークンは POST HTTP リクエストの ‘X-Insight-Token’ ヘッダーとして使用されます。

    6. Save をクリックします。

新しい統合は、通知管理者が通知サービスで動作グループを設定するとデフォルトで有効になり、統合オプションとして利用できます。統合を無効にするには、統合リストの Enabled 列でトグルボタンを使用します。

4. 通知動作グループの設定

通知管理者は、動作グループを介してアカウントの通知を設定します。通知管理者は、動作グループを作成したら、各アプリケーションバンドルに固有のトリガーされるイベントに関連付けます。

イベントが発生すると、ユーザー設定で通知の受信を選択したアカウントのすべてのユーザーと、動作グループの統合アクションとして指定されたすべてのサードパーティアプリケーションが通知を受け取ります。

4.1. 動作グループの作成

新規の通知動作グループを作成するには、以下の手順を使用します。

前提条件

  • 組織管理者が、ユーザーアクセスで通知グループ、ロール、およびメンバーを設定している。
  • ユーザーが、通知管理者権限で、Red Hat Hybrid Cloud Consoleプラットフォームにログインしている。

手順

  1. Red Hat Hybrid Cloud Console > Settings に移動します。
  2. 設定メニューで Notifications を展開し、Red Hat Enterprise Linux または OpenShift などの application bundle を選択します。
  3. Create new group をクリックします。
  4. グループ名を入力します。Actions ドロップダウンリストで、以下のオプションから選択します。

    1. Send an email を選択し、電子メール通知を組織内の すべてのユーザー に送信する必要があるか、受信者を組織内の 管理者 のみに制限するかを選択します。
    2. Integration: Webhook を選択し、ドロップダウンリストからオプションを選択します。これは、Settings > Integrations で設定されるエンドポイントによって設定されます。
    3. 必要に応じて、すべての組織の統合エンドポイントに通知する追加のアクションを追加できます。
  5. アプリケーションバンドルの通知ページの Behavior groups 一覧で動作グループを見つけ、オプションメニュー img hcc icons options をクリックし、Edit または Delete をクリックして、必要に応じてこれを編集したり削除したりします。

    注記

    Delete をクリックすると、イベントタイプに割り当てられた動作グループを削除する影響についてユーザーに警告が出されます。

4.2. 動作グループのイベントとの関連付け

以下の手順を使用して、通知サービスの動作グループを、トリガーするイベントに関連付けます。

前提条件

  • 以下の手順を実行するために、ユーザーアクセスで設定した通知管理者権限で Red Hat Hybrid Cloud Console プラットフォームにログインしている。
  • 通知管理者が、すでに動作グループを作成している。

手順

  1. Red Hat Hybrid Cloud Console > Settings に移動します。
  2. 設定メニューで Notifications を展開し、Red Hat Enterprise Linux または OpenShift などの動作グループが作成された application bundle を選択します。
  3. イベントを関連付ける動作グループを選択します。検索ボックスにグループの名前を入力するか、動作グループカードをスクロールできます。
  4. アプリケーションバンドルのイベント一覧で、イベント名の行の右端にある鉛筆アイコンをクリックします。これにより、イベントの動作列でドロップダウンリストが有効になります。
  5. 動作ドロップダウンリストをクリックし、イベントに関連付ける動作グループを選択します。
  6. イベント行のチェックマークをクリックして、そのイベントの選択を受け入れます。
  7. イベントごとに前の手順を繰り返します。
注記

イベントには複数の動作グループを関連付けることができます。動作グループがどのイベントにも関連付けられていない可能性もあります。その場合は、イベントが発生してもアクションは実行されません。

5. ユーザー設定

Red Hat Hybrid Cloud Console アカウントの各ユーザーは、メール通知を受け取るようにオプトインする必要があります。ユーザー設定を行わないと、イベントに関するメールを受け取れません。

通知を受け取るサービスおよび受信頻度を選択します。頻度は、(発生するイベントごとに) 即時、または毎日のダイジェストのいずれかになります。

重要

サービスの 即時通知 を選択すると、大量のメールを受け取る可能性があります。

5.1. メール通知のユーザー設定

各ユーザーは、イベント駆動型のシステム変更に関するメールを受け取るように独自の設定を行います。

前提条件

  • 登録ユーザーとして、Red Hat Hybrid Cloud Console プラットフォームにログインしている。

手順

  1. アプリケーションウィンドウの右上部分でユーザー名を見つけます。
  2. ユーザー名の右側にある矢印をクリックして、User Preferences を選択します。
  3. 左側のナビゲーションパネルで Notifications をクリックし、Red Hat Enterprise Linux または OpenShift などの適切なアプリケーションバンドルを選択します。
  4. 各サービスのメール設定を選択します。

    重要

    サービスの 即時通知 を選択すると、大量のメールを受け取る可能性があります。

  5. Save をクリックします。

メール通知は、選択した形式および頻度で配信されます。

注記

通知の受け取りを停止するには、Unsubscribe from all を選択して Save をクリックします。この画面で再度サブスクライブしない限り、メール通知を受け取らなくなります。

6. イベントログおよび統合設定での通知の失敗に関するトラブルシューティング

イベントログおよび統合設定での通知の失敗をトラブルシューティングします。通知サービスのイベントログを使用すると、通知管理者は通知が正しく機能していないことを簡単に確認できます。イベントログは、Red Hat Hybrid Cloud Console アカウントでトリガーされたイベントと、過去 14 日間に (関連する動作グループで設定されたように) 実行されたアクション一覧を提供します。

img hcc notif event log

各イベントは、Actions 列で緑または赤で強調表示された統合タイプを表示します。視覚的なカラーコードにより、メッセージ送信のステータス (成功または失敗) が示されます。

以下のユースケースは、イベントログのトラブルシューティング機能を示しています。

エンドポイント設定を確認して、接続の低下をトラブルシューティングする

フィルター可能なイベントログは、失敗した通知イベントを確認し、エンドポイントの潜在的な問題を特定するための便利なトラブルシューティングツールです。通知管理者は、イベントログで失敗したアクションを確認した後、統合画面でエンドポイントと最後の 5 回の接続試行のステータスを確認できます。

統合サービスでは、以下のコネクションステータスは色で反映されます。

  • 緑: 過去 5 回の送信が成功しました。
  • 赤: 過去 5 回の送信が失敗しました (タイムアウト、404エラーなど)。
  • 黄: 接続が低下し、過去 5 回の送信のうち少なくとも 2 回は失敗しました。
  • 不明: 統合が呼び出されていないか、または動作グループに関連付けられていません。

ユーザーが電子メールを受け取っていないのが、設定エラーなのかユーザーエラーなのかを判断する

イベントログは、メールの受信に関連する質問に回答できます。イベントのメールアクションを緑で表示することで、イベントログにより、通知管理者は電子メールが正常に送信されたことを確認できます。通知メールの受信に関する問題は、通知設定ではなく 個々のユーザー設定 にある可能性があります。

重要

通知や統合が適切に設定された場合でも、Red Hat Hybrid Cloud Console アカウントの個々のユーザーは、ユーザー設定 を設定してメールを受け取ります。

6.1. イベントログでの接続失敗の確認

以下の手順を使用して、通知アクションの失敗を確認します。

前提条件

  • ユーザーアクセスで設定した通知管理者権限で、Red Hat Hybrid Cloud Console にログインする必要があります。
  • ユーザーが webhook 統合タイプを使用して通知を受け取る前に、統合サービスの通知管理者が、組織で優先される webhook アプリケーションのエンドポイントを設定する必要があります。
  • ユーザーがメール通知を受け取る前に、Hybrid Cloud Console アプリケーションバンドルごとに、個人のメール通知設定を設定する必要があります。

手順

  1. Red Hat Hybrid Cloud Console > Settings > Notifications > Event log の順に移動します。
  2. イベント、アプリケーション、またはアプリケーションバンドルごとに必要に応じてイベントリストをフィルタリングし、今日、昨日、過去 7 日間、過去 14 日間 (デフォルト) から選択してイベントを表示するか、過去 14 日以内でカスタム範囲を設定します。
  3. 必要に応じて、日付と時刻の列を昇順または降順で並べ替えます。
  4. アプリケーションバンドルのユーザーが意図したとおりに通知を受け取っていない場合は、View notification settings をクリックして設定を変更したり、電子メール通知を受け取るユーザー設定をユーザーに確認してもらってください。