Skip to content

Commit

Permalink
Merge branch 'main' into feat-site247-provider
Browse files Browse the repository at this point in the history
  • Loading branch information
shahargl authored Apr 27, 2024
2 parents b7cf4c3 + 6851e45 commit dc15094
Show file tree
Hide file tree
Showing 7 changed files with 528 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,8 @@ Workflow triggers can either be executed manually when an alert is activated or
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/gcpmonitoring-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/splunk-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/incidentmanager-icon.png"/>
</p>
<h3 align="center">Databases and data warehouses</h3>
<p align="center">
Expand Down
3 changes: 2 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,11 @@
"providers/documentation/trello-provider",
"providers/documentation/twilio-provider",
"providers/documentation/websocket-provider",
"providers/documentation/incidentmanager-provider",
"providers/documentation/zabbix-provider",
"providers/documentation/zenduty-provider"
]
}
}
]
},
{
Expand Down
43 changes: 43 additions & 0 deletions docs/providers/documentation/incidentmanager-provider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Incident Manager Provider

The Incident Manager Provider allows you to push incidents from AWS IncidentManager to Keep.

## Authentication Configuration

To authenticate with the Incident Manager Provider, you need to provide the following configuration parameters:

- `access_key`: AWS access key (required, sensitive)
- `access_key_secret`: AWS access key secret (required, sensitive)
- `region`: AWS region (required)
- `response_plan_arn`: AWS Response Plan's ARN (required, hint: Default response plan ARN to use when interacting with incidents, if not provided, we won't be able to register web hook for the incidents)
- `sns_topic_arn`: AWS SNS Topic ARN you want to be used/using in response plan (required, hint: Default SNS topic to use when creating incidents, if not provided, we won't be able to register web hook for the incidents)

## Provider Scopes

The Incident Manager Provider requires the following provider scopes:

- `ssm-incidents:ListIncidentRecords`: Required to retrieve incidents. [Documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm-incidents.html) (mandatory, alias: Describe Incidents)
- `ssm-incidents:GetResponsePlan`: Required to get response plan and register Keep as webhook. [Documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm-incidents.html) (optional, alias: Update Response Plan)
- `ssm-incidents:UpdateResponsePlan`: Required to update response plan and register Keep as webhook. [Documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm-incidents.html) (optional, alias: Update Response Plan)
- `iam:SimulatePrincipalPolicy`: Allow Keep to test the scopes of the current user/role without modifying any resource. [Documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm-incidents.html) (optional, alias: Simulate IAM Policy)
- `sns:ListSubscriptionsByTopic`: Required to list all subscriptions of a topic, so Keep will be able to add itself as a subscription. [Documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ssm-incidents.html) (optional, alias: List Subscriptions)

## Status Map

The Incident Manager Provider maps the following statuses:

- "OPEN" to AlertStatus.FIRING
- "RESOLVED" to AlertStatus.RESOLVED

## Severities Map

The Incident Manager Provider maps the following severities:

- 1 to AlertSeverity.CRITICAL
- 2 to AlertSeverity.HIGH
- 3 to AlertSeverity.LOW
- 4 to AlertSeverity.WARNING
- 5 to AlertSeverity.INFO

## Notes
1. Incident Manager only throws notification when there is chatChannel attached to response plan. Make sure to add chatChannel to response plan before adding webhook
Binary file added keep-ui/public/icons/incidentmanager-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions keep-ui/public/incidentmanager.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
Loading

0 comments on commit dc15094

Please sign in to comment.