diff --git a/docs/installation/teams/assets/cloud_teams_install.png b/docs/installation/assets/cloud_install.png similarity index 100% rename from docs/installation/teams/assets/cloud_teams_install.png rename to docs/installation/assets/cloud_install.png diff --git a/docs/installation/teams/assets/cloud_teams_instance_delete.png b/docs/installation/assets/cloud_instance_delete.png similarity index 100% rename from docs/installation/teams/assets/cloud_teams_instance_delete.png rename to docs/installation/assets/cloud_instance_delete.png diff --git a/docs/installation/teams/assets/cloud_teams_new_instance.png b/docs/installation/assets/cloud_new_instance.png similarity index 100% rename from docs/installation/teams/assets/cloud_teams_new_instance.png rename to docs/installation/assets/cloud_new_instance.png diff --git a/docs/installation/assets/undraw_under_construction.svg b/docs/installation/assets/undraw_under_construction.svg new file mode 100644 index 00000000..7718df50 --- /dev/null +++ b/docs/installation/assets/undraw_under_construction.svg @@ -0,0 +1 @@ +under construction diff --git a/docs/installation/index.mdx b/docs/installation/index.mdx index 54670ad6..18dff383 100644 --- a/docs/installation/index.mdx +++ b/docs/installation/index.mdx @@ -34,10 +34,10 @@ Compare our bidirectional integrations: Compare our unidirectional integrations: -| Feature | Elasticsearch | Webhook | -| -------------------------------------------------------------- | ------------------ | ------------------ | -| Source plugins support (e.g. `kubernetes`, `prometheus`, etc.) | :heavy_check_mark: | :heavy_check_mark: | -| Multi-cluster support | :heavy_check_mark: | :heavy_check_mark: | +| Feature | Elasticsearch | Webhook | Pager Duty | +| -------------------------------------------------------------- | ------------------ | ------------------ | ------------------ | +| Source plugins support (e.g. `kubernetes`, `prometheus`, etc.) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Multi-cluster support | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | ## Integrations @@ -48,6 +48,7 @@ Compare our unidirectional integrations: { name: "Discord", image: "/images/integrations/discord.svg", link: "installation/discord" }, { name: "Teams", image: "/images/integrations/msteams.svg", link: "installation/teams" }, { name: "Elasticsearch", image: "/images/integrations/elasticsearch.svg", link: "installation/elasticsearch" }, + { name: "Pager Duty", image: "/images/integrations/pager-duty.svg", link: "installation/pagerduty" }, { name: "Webhook", image: "/images/integrations/webhooks.svg", link: "installation/webhook" }, ]} /> diff --git a/docs/installation/pager-duty/assets/pager_duty_integration.png b/docs/installation/pager-duty/assets/pager_duty_integration.png new file mode 100644 index 00000000..e2f4d0f2 Binary files /dev/null and b/docs/installation/pager-duty/assets/pager_duty_integration.png differ diff --git a/docs/installation/pager-duty/index.md b/docs/installation/pager-duty/index.md new file mode 100644 index 00000000..9f6a5e67 --- /dev/null +++ b/docs/installation/pager-duty/index.md @@ -0,0 +1,116 @@ +--- +id: pagerduty +title: "Pager Duty" +sidebar_position: 6 +--- + +## Botkube Cloud Pager Duty + +The Botkube Cloud Pager Duty integration ensure timely reactions to both alerts and changes in your system. + + + +You can directly try Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Web App](https://app.botkube.io). Follow the steps below to install the app. + +## Prerequisites + +- A Botkube Cloud account. + + You can try out the Botkube Cloud Microsoft Teams app for free by creating an account in the [Botkube Cloud app](https://app.botkube.io). + +## Create a Botkube Cloud Instance with Pager Duty + +### Connect Botkube Cloud to your Kubernetes cluster + +1. Go to Botkube Cloud [Web App](https://app.botkube.io/) and click on `New Instance` button. + + ![New Instance](../assets/cloud_new_instance.png "Create new instance") + +2. Install Botkube Agent on your Kubernetes cluster by following the instructions on the page. + + ![Install Agent](../assets/cloud_install.png "Install Agent") + +3. Click `Add platform` dropdown, and select `Pager Duty` option. + + ![Platform Select](../assets/undraw_under_construction.svg "Select Pager Duty platform") + +Proceed with the next section. + +### Create a Pager Duty Service + +:::note +For a detailed guide, navigate to PagerDuty's support page [Services and Integrations](https://support.pagerduty.com/docs/services-and-integrations#create-a-service). +::: + +To create a service in the Pager Duty web app: + +1. Go to **Services** -> **Service Directory** and click **New Service**. On the next screen you will be guided through several steps. + 1. Enter **Name**. We suggest to put a cluster name, for example: "Production EU". + 2. Click **Next** to continue. +2. Select Escalation Policy that suits you best. Click **Next** to continue. +3. Select the **Events API V2** integration. + + ![pager_duty_integration.png](assets/pager_duty_integration.png) + +4. Click **Create Service**. +5. Now you will be in the service’s Integrations tab, where you’ll find the **integration key**. +6. Copy the **integration key**. + +Proceed with the next section. + +### Finalize Botkube Cloud instance configuration + +Go back to the Botkube Cloud instance creation. + +1. In step 2, specify configuration details: + + - **Integration key:** The integration key generated by Pager Duty in the previous section. + + ![Botkube Cloud Instance Configuration](../assets/undraw_under_construction.svg "Botkube Cloud Instance configuration") + +2. Add source plugins you want to enable in your Botkube instance and click `Next` button. + + ![Source Plugins](../assets/undraw_under_construction.svg "Source plugins") + +3. Click `Apply Changes` button to update Botkube Cloud instance. + + ![Cloud Instance Create](../assets/undraw_under_construction.svg "Cloud Instance create") + +## Using Botkube Cloud with PagerDuty Integration + +From now on, all events emitted by enabled sources are routed directly to created PagerDuty service using the [Events API v2](https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgw-events-api-v2-overview). Botkube follows the best practices by recognizing different event types and sending them to PagerDuty accordingly. + +### Alerts + +An [alert](https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgx-send-an-alert-event) indicates a problem within a monitored system. Botkube forwards the following types of alerts to PagerDuty: + +- [Kubernetes'](../../configuration/source/kubernetes.md) error and warning events. +- All configured [Prometheus](../../configuration/source/prometheus.md) alerts. +- [ArgoCD](../../configuration/source/argocd.md) alerts (details to be specified). + +### Changes + +A [change](https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTgy-send-a-change-event) indicates a non-problematic update within a system. Botkube forwards the following types of change events to PagerDuty: + +- [Kubernetes'](../../configuration/source/kubernetes.md) create, delete, and update events. +- [ArgoCD](../../configuration/source/argocd.md) changes (details to be specified). + +## Instance Cleanup + +1. Go to Botkube Cloud instances page and click `Manage` button of the instance you want to remove. + + ![Cloud Instance Manage](../assets/undraw_under_construction.svg "Cloud Instance manage") + +2. Click `Delete instance` button, type instance name in the popup and click `Delete instance`. + + :::caution + Remember to execute the displayed command to completely remove Botkube and related resources from your cluster. + ::: + + ![Cloud Instance Delete](../assets/cloud_instance_delete.png "Cloud Instance delete") + +## Limitations + +Botkube Cloud Microsoft Teams App currently doesn't support the following features: + +- Botkube doesn't send a follow-up events to acknowledge or resolve triggered alert. diff --git a/docs/installation/teams/index.md b/docs/installation/teams/index.md index 65fc87e3..7b9c086c 100644 --- a/docs/installation/teams/index.md +++ b/docs/installation/teams/index.md @@ -28,11 +28,11 @@ You can directly try Botkube Cloud Microsoft Teams app for free by creating an a 1. Go to Botkube Cloud [Web App](https://app.botkube.io/) and click on `New Instance` button. - ![New Instance](assets/cloud_teams_new_instance.png "Create new instance") + ![New Instance](../assets/cloud_new_instance.png "Create new instance") 1. Install Botkube Agent on your Kubernetes cluster by following the instructions on the page. - ![Install Agent](assets/cloud_teams_install.png "Install Agent") + ![Install Agent](../assets/cloud_install.png "Install Agent") 1. Click `Add platform` dropdown, and select `Teams` option. @@ -172,7 +172,7 @@ After this point, all of your commands will be executed on the default instance. Remember to execute the displayed command to completely remove Botkube and related resources from your cluster. ::: - ![Cloud Teams Instance Delete](assets/cloud_teams_instance_delete.png "Cloud Microsoft Teams instances delete") + ![Cloud Teams Instance Delete](../assets/cloud_instance_delete.png "Cloud Microsoft Teams instances delete") ## Caveats diff --git a/static/images/botkube_multicluster.png b/static/images/botkube_multicluster.png deleted file mode 100644 index f6487926..00000000 Binary files a/static/images/botkube_multicluster.png and /dev/null differ diff --git a/static/images/botkube_multicluster_v2.svg b/static/images/botkube_multicluster_v2.svg deleted file mode 100644 index d8cea15c..00000000 --- a/static/images/botkube_multicluster_v2.svg +++ /dev/null @@ -1,3607 +0,0 @@ - - - D5FB916F-F1EC-4AC0-8186-E41FB846A0CB@3x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/static/images/integrations/pager-duty.svg b/static/images/integrations/pager-duty.svg new file mode 100644 index 00000000..aa55f9dc --- /dev/null +++ b/static/images/integrations/pager-duty.svg @@ -0,0 +1 @@ +icon-pd-green