scout: slack integration

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-04-25 11:38:22 +02:00
parent 9bc9d56ac9
commit aca1d50744
4 changed files with 71 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -82,3 +82,13 @@ analysis, directly in your repositories.
The following source code management integrations are available:
- [GitHub](source-code-management/github.md) {{< badge color=violet text=Beta >}}
### Team collaboration
Integrations in this category let you integrate Docker Scout with collaboration
platforms for broadcasting notifications about your software supply chain in
real-time to team communication platforms.
The following team collaboration integrations are available:
- [Slack](./team-collaboration/slack.md)

View File

@ -0,0 +1,57 @@
---
title: Integrate Docker Scout with Slack
description: |
Integrate Docker Scout with Slack to receive real-time updates
about vulnerabilities and policy compliance in Slack channels
keywords: scout, team collaboration, slack, notifications, updates
---
You can integrate Docker Scout with Slack by creating a Slack webhook and
adding it to the Docker Scout Dashboard. Docker Scout will notify you about
when a new vulnerability is disclosed, and it affects one or more of your
images.
![Slack notification from Docker Scout](../../images/scout-slack-notification.png?border=true "Example Slack notification from Docker Scout")
## How it works
After configuring the integration, Docker Scout sends notifications about
changes to policy compliance and vulnerability exposure for your repositories,
to the Slack channels associated with the webhook.
> **Note**
>
> Notifications are only triggered for the *last pushed* image tags for each
> repository. "Last pushed" refers to the image tag that was most recently
> pushed to the registry and analyzed by Docker Scout. If the last pushed image
> is not by a newly disclosed CVE, then no notification will be triggered.
## Setup
To add a Slack integration:
1. Create a webhook, see [Slack documentation](https://api.slack.com/messaging/webhooks).
2. Go to the [Slack integration page](https://scout.docker.com/settings/integrations/slack/) in the Docker Scout Dashboard.
3. In the **How to integrate** section, enter a **Configuration name**.
Docker Scout uses this label as a display name for the integration,
so you might want to change the default name into something more meaningful.
For example the `#channel-name`, or the name of the team that this configuration belongs to.
4. Paste the webhook you just created in the **Slack webhook** field.
Select the **Test webhook** button if you wish to verify the connection.
Docker Scout will send a test message to the specified webhook.
5. Select whether you want to enable notifications for all your Scout-enabled image repositories,
or enter the names of the repositories that you want to send notifications for.
6. When you're ready to enable the integration, select **Create**.
After creating the webhook, Docker Scout begins to send notifications updates
to the Slack channels associated with the webhook.
## Remove a Slack integration
To remove a Slack integration:
1. Go to the [Slack integration page](https://scout.docker.com/settings/integrations/slack/) in the Docker Scout Dashboard.
2. Select the **Remove** icon for the integration that you want to remove.
3. Confirm by selecting **Remove** again in the confirmation dialog.

View File

@ -1458,6 +1458,10 @@ Manuals:
section:
- title: GitHub
path: /scout/integrations/source-code-management/github/
- sectiontitle: Team collaboration
section:
- title: Slack
path: /scout/integrations/team-collaboration/slack/
- sectiontitle: Release notes
section:
- path: /scout/release-notes/cli/