Slack の構成
Slack は、クラウド・ベースのリアルタイムでのメッセージングおよび通知のシステムです。
イベント通知を Event Notifications ツール統合を使用して配信できるようになりました。IBM Cloud® Event Notificationsは、Slackや、PagerDuty,メール、SMS、プッシュ通知、Webhook、Microsoft® Teams、ServiceNow, IBMなどの通信チャネルに通知を配信するのに適した方法です。Cloud Functionsなどです。 Event Notificationsの使用について詳しくは、 ツールチェーンのイベント通知の有効化 を参照してください。
POST /toolchains/{toolchain_id}/events API によって生成されたクライアント・カスタム・ツールチェーン・イベントは、Slack ツール統合に送信されません。 Bespoke ツールチェーン・イベントは IBM Cloud® Event Notificationsにのみ送信されます。
Slack が提供する永続的なチャットは、E メールの代わりに使用できる対話性に優れたチームのコラボレーション手段になります。 専用チャネルまたは作業に直接関連する一連のチャネルで、チームと連絡を取ることができます。 さらに、2 人以上のメンバー間で、チャネルやダイレクト・メッセージを使用して、ファイルとイメージを共有することもできます。 ダイレクト・メッセージとチャネルでの通信は、検索できるように保存されます。
パブリック Slack チャネルに送信される通知は、チームの全員が見ることができます。 投稿したコンテンツの責任は投稿者が負います。
テストやデプロイのアクティビティーなどのツールチェーンに関する通知をツール統合から受信するように Slack を構成します。
-
ツールチェーン作成時にこのツール統合を構成する場合は、「構成可能な統合」セクションで**「Slack」**をクリックします。
-
ツールチェーンがあり、そこにこのツール統合を追加する場合、IBM Cloudコンソールから、メニューアイコンの
>Platform Automation>Toolchains をクリックします。 「ツールチェーン」ページで、ツールチェーンをクリックしてその「概要」ページを開きます。 あるいは、アプリの「概要」ページの「継続的デリバリー」カードで、**「ツールチェーンの表示」をクリックします。 次に、「概要」**をクリックします。
a. **「ツールの追加」**をクリックします。
b. 「ツール統合」セクションで、**「Slack」**をクリックします。
-
着信 Web フックとして Slack によって生成された Slack Web フック URL を入力します。 Slack チャネルがツール統合からツールチェーンに関する通知を受け取るためには Slack Web フック URL が必要です。 ウェブフックの作成または検索方法については、受信ウェブフックを参照してください。
Slack チャネルがツール統合からツールチェーンについての通知を受け取れるようにするために API キーを使用する場合は、代わりに Web フックを使用するように構成を更新する必要があります。
-
通知を送信する Slack チャネルの名前を入力します。 このチャネルは存在していなければならず、Slack チームでアクティブである必要があります。
-
Slack チームの URL ホスト名を入力します。これは、チーム URL 内の
.slack.com
の前にある語または句です。 例えば、チーム URL がhttps://team.slack.com
の場合、ホスト名はteam
です。 -
「統合の作成」 をクリックします。
指定した Slack チャネルおよびチームに到達できない場合、Slack カードに
Setup Failed
エラーが表示されます。Setup Failed
メッセージの上に移動し、**「再構成 (Reconfigure)」をクリックしてください。 Slack Web フック URL、Slack チャネル、および Slack チームの URL ホスト名に、有効な構成パラメーターを使用していることを確認してください。 必要に応じて設定を更新し、「統合の保存」**をクリックします。 -
ツールチェーンの「概要」ページの**「サード・パーティー・ツール」カードで、「スラック」**をクリックします。 構成した Slack チャネルでツールチェーンのアクティビティーをすべて表示できます。
APIを使ってSlackを設定する
Slack ツール統合は、 、 read、および update ツール統合を作成するときに、 Toolchain HTTP API および SDK で使用できる以下の構成パラメーターをサポートします。
slack
値を使用して、要求本体に tool_type_id
プロパティーを指定する必要があります。
パラメーター | 使用法 | タイプ | Terraform 引数 | 説明 |
---|---|---|---|---|
API トークン | 必須、更新可能 | パスワード | Web フック (webhook) | Slack がイベントを受信するために使用する着信 Webhook。 このパラメーターには、ツールチェーン・シークレットの参照を使用できます。 秘密参照について詳しくは、 IBM Cloud を参照してください。 |
channel_name | 必須、更新可能 | ストリング | channel_name | 通知を投稿するSlackチャンネル。 |
パイプライン失敗 (pipeline_fail) | オプション、更新可能、 Default: true |
ブール値 | パイプライン失敗 (pipeline_fail) | pipeline failed 通知を生成します。 |
パイプラインの開始 | オプション、更新可能、 Default: true |
ブール値 | パイプラインの開始 | pipeline start 通知を生成します。 |
パイプラインの成功 | オプション、更新可能、 Default: true |
ブール値 | パイプラインの成功 | pipeline succeeded 通知を生成します。 |
チーム URL | オプション、更新可能 | ストリング | チーム名 | Slack チーム名。これは、チーム URL 内の .slack.com の前の単語または句です。 |
ツールチェーン・バインド | オプション、更新可能、 Default: true |
ブール値 | ツールチェーン・バインド | tool added to toolchain 通知を生成します。 |
ツールチェーンのアンバインド | オプション、更新可能、 Default: true |
ブール値 | ツールチェーンのアンバインド | tool removed from toolchain 通知を生成します。 |
Tekton パイプラインの Slack 通知の有効化
イベントを Slack 統合に送信するように Tekton パイプラインを構成できます。
- ツールチェーンの概要ページから、デリバリーパイプラインカードの Delivery Pipeline をクリックし、TektonDelivery Pipelineを開きます。
- 「設定」 > 「拡張設定」 ページで、 Event Notifications を有効にします。
- 変更内容を保存します。