diff --git a/openmetadata-docs/content/deployment/upgrade/index.md b/openmetadata-docs/content/deployment/upgrade/index.md index 080bd9fe1af..0c95edf9f3f 100644 --- a/openmetadata-docs/content/deployment/upgrade/index.md +++ b/openmetadata-docs/content/deployment/upgrade/index.md @@ -12,22 +12,24 @@ OpenMetadata community will be doing feature releases and stable releases. - Feature releases are to upgrade your sandbox or POCs to give feedback to the community and any potential bugs that the community needs to fix. - Stable releases are to upgrade your production environments and share it with your users. -## 0.13.0 - Feature Release - -OpenMetadata 0.13.0 is a **feature release**. - -**Don't upgrade your production with 0.13.0 feature release** - -Explore 0.13.0 by following up [Deployment guides](https://docs.open-metadata.org/deployment) and please give us any feedback on our [community slack](https://slack.open-metadata.org) - - -## 0.12.3 - Stable release - - OpenMetadata 0.12.3 is a stable release. Please check the [release notes](https://github.com/open-metadata/OpenMetadata/releases/tag/0.12.3-release) +## 0.13.1 - Stable Release +OpenMetadata 0.12.3 is a stable release. Please check the [release notes]() If you are upgrading production this is the recommended version to upgrade. - -## Breaking Changes from 0.13.0 Feature Release + +## Breaking Changes for 0.13.1 Stable Release + +OpenMetadata Release 0.13.1 introduces below breaking changes - + +### Webhooks + +Starting from 0.13.1 , OpenMetadata will be deprecating the existing webhooks for Slack, MSTeams. + +Before upgrading to 0.13.1 it is recommended to save the existing Webhook configs(like webhook url) to use them later. + +We have added Alerts/Notifications , which can be configured to receive customised alerts on updates in OM using Triggers, Filtering Information to different destinations like Slack, MsTeams or even Emails. +Please use the same webhook config that you had saved from previous version to configure the Alerts Destination after upgrading. + OpenMetadata Release 0.13.x introduces below breaking changes: @@ -45,6 +47,21 @@ We will remove the dbt configuration from your existing metadata ingestion pipel After upgrading you will have to create the dbt workflow for the dbt ingestion to start working again. +## 0.13.0 - Feature Release + +OpenMetadata 0.13.0 is a **feature release**. + +**Don't upgrade your production with 0.13.0 feature release** + +Explore 0.13.0 by following up [Deployment guides](https://docs.open-metadata.org/deployment) and please give us any feedback on our [community slack](https://slack.open-metadata.org) + + +## 0.12.3 - Stable release + + OpenMetadata 0.12.3 is a stable release. Please check the [release notes](https://github.com/open-metadata/OpenMetadata/releases/tag/0.12.3-release) + +If you are upgrading production this is the recommended version to upgrade. + ## Breaking Changes from 0.12.x Stable Release OpenMetadata Release 0.12.x introduces below breaking changes - diff --git a/openmetadata-docs/content/deployment/upgrade/versions/012-to-013.md b/openmetadata-docs/content/deployment/upgrade/versions/012-to-013.md index a37e3bb418f..9275582ad0e 100644 --- a/openmetadata-docs/content/deployment/upgrade/versions/012-to-013.md +++ b/openmetadata-docs/content/deployment/upgrade/versions/012-to-013.md @@ -38,6 +38,14 @@ to `airflow_provider_openmetadata.lineage.backend.OpenMetadataLineageBackend`. - We removed support from Airflow v1. - The failure callback now only updates the pipeline status if the Pipeline already exists in OpenMetadata. +## Webhooks + +In 0.13.1 , OpenMetadata will be deprecating the existing webhooks for Slack, MSTeams. + +Before upgrading to 0.13.1 it is recommended to save the existing Webhook configs(like webhook url) to use them later. + +We have added Alerts/Notifications , which can be configured to receive customised alerts on updates in OM using Triggers, Filtering Information to different destinations like Slack, MsTeams or even Emails. +Please use the same webhook config that you had saved from previous version to configure the Alerts Destination after upgrading. ### dbt Workflow - Starting with `0.13.1` dbt ingestion has been separated from the metadata ingestion. It can now be configured as a separate workflow after completing the metadata ingestion workflow diff --git a/openmetadata-docs/content/developers/webhooks.md b/openmetadata-docs/content/developers/webhooks.md index 9aa8f57e795..67c105fe145 100644 --- a/openmetadata-docs/content/developers/webhooks.md +++ b/openmetadata-docs/content/developers/webhooks.md @@ -3,6 +3,19 @@ title: Webhooks slug: /developers/webhooks --- + + +# Webhooks + +In 0.13.1 , webhooks have been deprecated. You should instead use [OpenMetadata alerts](/openmetadata/alerts-notifications) + +Before upgrading to 0.13.1 it is recommended to save the existing Webhook configs(like webhook url) to use them later. + +We have added Alerts/Notifications , which can be configured to receive customised alerts on updates in OM using Triggers, Filtering Information to different destinations like Slack, MsTeams or even Emails. +Please use the same webhook config that you had saved from previous version to configure the Alerts Destination after upgrading. + + + # Webhooks A webhook is a way for an app to provide other applications with real-time information. diff --git a/openmetadata-docs/content/menu.md b/openmetadata-docs/content/menu.md index f1e9ac823bf..603df87a1e7 100644 --- a/openmetadata-docs/content/menu.md +++ b/openmetadata-docs/content/menu.md @@ -586,6 +586,9 @@ site_menu: - category: Features / Data Insights url: /openmetadata/data-insight + - category: Features / Alerts & Notifications + url: /openmetadata/alerts-notifications + - category: Main Concepts url: /main-concepts color: violet-70 diff --git a/openmetadata-docs/content/openmetadata/alerts-notifications/index.md b/openmetadata-docs/content/openmetadata/alerts-notifications/index.md new file mode 100644 index 00000000000..3e433209e9e --- /dev/null +++ b/openmetadata-docs/content/openmetadata/alerts-notifications/index.md @@ -0,0 +1,67 @@ +--- +title: Alerts & Notifications +slug: /openmetadata/alerts-notifications +--- + +# Alerts & Notifications +Starting in 0.13 OpenMetadata allows users to define fine grain notification/alerts using the "Alerts" feature. This feature replaces the Webhook that present in version 0.12 and before. It stills provides native integration with Slack and MS Webhook and give you the ability to send alerts using a generic webhook. It also introduces the ability to send email alerts + +## Creating an Alert +### Step 1 +Navigate to `settings > Alerts. + +Once on the alert page click on the purple button `Create alert` in the top right corner. + +### Step 2 +Configure you alert. + +As with most configuration in OpenMetadata you will first need to add a Name and a Description for your alert. Once this is completed, we can move on to the configuration. You have 3 steps to configure your alert: +1. **Trigger**: this will determine how your alert should be trigger. You can select your alert to be triggered when events happen against all the existing assets or only specific ones +2. **Filter**: in this section, you can add specific event filters. The filter input will determine what event will trigger an alert to be sent. Setting `Allow` against a condition will result in an alert being sent if the condition is met while setting `Deny` will silence this condition (i.e. alert won't be sent for the denied event). +3. **Destination**: you will determine where your alert should be sent in this section. We provide 4 destinations + - Slack + - MS Teams + - Email + - Webhook + +Set profiler configuration + +## Configuration Details for Destinations +### Slack +For slack configuration you will need to get the endpoint URL of the channel where you wish to send the alerts. Additionally, you can conigure the following parameter: +- **Batch Size**: size of the batch that will be sent to the endpoint. +- **Connection Timeout**: timeout for the connection. +- **Secret Key**: Secret key can be used to secure the webhook connection. + +### MS Teams +For MS Teams configuration you will need to get the endpoint URL if the chanel where you wish to send the alerts. You can find this by going to the Teams channel where you want the posts to appear, clicking the three dots `...`, and clicking "Connectors". Then add the "Incoming Webhook" connector. Copy this connector's URL and supply it here to OpenMetadata. It may be in the form of `https://your-domain.webhook.office.com/webhookb2/...@.../IncomingWebhook/.../...`. For more on MS Teams webhooks, see [Create an Incoming Webhook](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook). Additionally, you can conigure the following parameter: +- **Batch Size**: size of the batch that will be sent to the endpoint. +- **Connection Timeout**: timeout for the connection. +- **Secret Key**: Secret key can be used to secure the webhook connection. + +### Email +To enable email alerts you will need to make sure you have an SMTP server available. With the information for your SMTP server you can configure OpenMetadata to send email alerts by updating the below section of the `openmetadata.yaml` file. + +``` +email: + emailingEntity: ${OM_EMAIL_ENTITY} + supportUrl: ${OM_SUPPORT_URL} + enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP} + openMetadataUrl: ${OPENMETADATA_SERVER_URL} + senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL} + serverEndpoint: ${SMTP_SERVER_ENDPOINT} + serverPort: ${SMTP_SERVER_PORT} + username: ${SMTP_SERVER_USERNAME} + password: ${SMTP_SERVER_PWD} + transportationStrategy: ${SMTP_SERVER_STRATEGY} +``` + +### Webhook +To set up a webhook you can simply use the endpoint URL where you want your alert to be sent. Additionally, you can conigure the following parameter: +- **Batch Size**: size of the batch that will be sent to the endpoint. +- **Connection Timeout**: timeout for the connection. +- **Secret Key**: Secret key can be used to secure the webhook connection. \ No newline at end of file diff --git a/openmetadata-docs/images/openmetadata/alerts-notifications/OMAlerts.gif b/openmetadata-docs/images/openmetadata/alerts-notifications/OMAlerts.gif new file mode 100644 index 00000000000..bc9f5ff6cdd Binary files /dev/null and b/openmetadata-docs/images/openmetadata/alerts-notifications/OMAlerts.gif differ