# Integrations
Fairwinds Insights integrates with a number of third-party tools to better support your team's needs.
# GitHub
You can connect Insights to GitHub to:
- Open issues in GitHub repos
- Get a better CI/CD experience for Infrastructure-as-Code scanning
# Connecting
Connecting Insights to your GitHub repository will help you get the most out of the CI integration. To get started:
- Visit your organization's
Repositories
page and clickAdd Repository
- Click on
Connect Github
Then, in the GitHub UI, choose which repositories you'd like to link to Insights:
# Using the GitHub Integration
Connecting GitHub with Fairwinds Insights unlocks several features:
- Auto-Scan for Infrastructure-as-Code
- Scan results posted to pull requests as comments
- Fairwinds Insights status on pull requests
- Automated Pull Request Fix
- Create an Github Issue based on a Fairwinds Insights Action Item
# Fairwinds Insights GitHub Application Permissions Required
To provide these features, the Fairwinds Insights GitHub Application requires the following permissions:
Repositories Permission | Read | Write | Description | Used for features |
---|---|---|---|---|
Metadata | ✓ | Search repositories, list collaborators, and access repository metadata. | (mandatory) | |
Commit statuses | ✓ | ✓ | 3 | |
Content | ✓ | ✓ | Repository contents, commits, branches, downloads, releases, and merges. | 1, 4 |
Issues | ✓ | ✓ | Issues and related comments, assignees, labels, and milestones. | 5 |
Pull Request | ✓ | ✓ | Pull requests and related comments, assignees, labels, milestones, and merges. | 2, 4 |
WebHooks | ✓ | ✓ | Manage the post-receive hooks for a repository. |
# Status on Pull Requests Example
For example, once your repository is linked, you'll start seeing a Fairwinds Insights status on each of your pull requests.
# Jira
Fairwinds Insights can connect to Jira in order to create Jira tickets from Action Items.
# Installation
We recommend creating a "robot account" to connect to your Insights organization and granting this user the ability to create tickets on all of your Jira projects. The linked account will show as the creator of any tickets created via Insights
- Visit your organization's
Settings > Integration
page - Hover over
Jira
and clickAdd Integration
- Once you have connected Jira to Insights, you can create tickets for Action Items manually or automatically using Automation Rules
# Jira Tickets and Action Items
If an Action Item that is associated with a Jira ticket is marked as Resolved
or Fixed
,
the Jira ticket will automatically close.
# Azure DevOps
Fairwinds Insights can connect to Azure DevOps in order to create Work Items from Action Items.
# Installation
We recommend creating a "robot account" to connect to your Insights organization and granting this user the ability to create Work Items on all of your Azure DevOps projects. The linked account will show as the creator of any Work Items created via Insights
- Visit your organization's
Settings > Integration
page - Hover over
Azure DevOps
and clickAdd Integration
- Once you have connected Azure DevOps to Insights, you can create Work Items for Action Items manually or automatically using Automation Rules
# Azure DevOps Work Items and Action Items
If an Action Item that is associated with an Azure DevOps work item is marked as Resolved
or Fixed
,
the Azure DevOps work item will automatically close.
# Slack
Fairwinds Insights has an integration with Slack so you can get notifications about critical changes to your clusters.
There are two types of Slack notifications:
- Realtime: Alert every time one of your reports generate new Action Items. This is good for production clusters which deserve more attention and should be relatively stable
- Daily Digest: One alert per day highlighting any new Action Items or fixed Action Items in your cluster from the previous day
Read our privacy policy (opens new window) to learn more about how Fairwinds Insights handles user data.
# Installation
To set up Slack notifications:
- Visit your organization's
Settings > Integration
page - Hover over
Slack
and clickAdd Integration
- Once you have connected Slack to Insights, you can choose which channels you'd like notifications to be
sent to in the
Settings > Notifications
page
See the confgure section to customize Slack alerts through Automation Rules.
# PagerDuty
The PagerDuty integration allows you to create PagerDuty incidents for any Action Item in Fairwinds Insights. This includes all three contexts: Insights Agent, CI/CD and Admission Controller.
PagerDuty incidents are created via Automation Rules. You can customize your Automation Rule to only trigger on particular events (e.g. critical level container CVEs from Trivy). You can also customize the PagerDuty incident with different levels of urgency, add resource metadata and remediation details to the incident body and more.
# How It Works
Users can create new PagerDuty incidents for specific scenarios using Fairwinds Insights’ Automation Rule functionality. Automation Rules trigger automatically when certain scenarios are met. For example, a common user scenario is creating a PagerDuty incident when a new high severity security misconfiguration is found in the Kubernetes cluster.
At a minimum, a PagerDuty incident requires:
- An incident title
- A PagerDuty service ID
- An urgency threshold (low or high)
Users can optionally configure an incident description which are good places to store remediation recommendations and workload related details. Incidents may also be routed to an escalation policy or assigned to specific PagerDuty user IDs.
Once a PagerDuty incident is created, it will appear in the PagerDuty console under the specific service ID specified.
# Installation
The user who authorizes the application will appear in the PagerDuty UI as having triggered the incident. We suggest creating a "robot account" for authenticating with Fairwinds Insights to prevent any confusion
- Visit your organization's
Settings > Integration
page - Hover over
PagerDuty
and clickAdd Integration
- Once you have connected PagerDuty to Insights, you can use Automation Rules to trigger incidents
# Datadog
Fairwinds Insights has an integration to feed data into Datadog.
An Event is sent into Datadog whenever an Action Item is first discovered or when it's fixed. This can be very helpful for correlating issues with either an attempt to fix an Action Item or introducing a new workload that has additional Action Items.
Also a metric is sent to Datadog representing the number of open Action Items with tags that allow you to filter or compare data.
# Installation
To set up DataDog integration:
- Visit your organization's
Settings > Integration
page - Hover over
DataDog
and clickAdd Integration
- Add the
API key
and clickConnect to Datadog