Merge branch 'main' into fix/3898-bug-topology-models-pks-are-tenant-agnostic

Author: VladimirFilonov

Diff for: .github/workflows/auto-resolve-keep.yml

@@ -16,7 +16,8 @@ on:
         required: false
         type: string
         default: "resolved"
-  push:
+  pull_request:
+    types: [closed]
     branches:
       - main
 
@@ -25,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Extract Keep ID from PR description
-        if: github.event_name == 'push'
+        if: github.event_name == 'pull_request'
         id: extract_id
         run: |
           PR_DESC="${{ github.event.pull_request.body }}"
@@ -44,7 +45,7 @@ jobs:
 
       - name: Auto resolve Keep incident
         if: |
-          (github.event_name == 'push' && steps.set_ids.outputs.final_incident_id != '') ||
+          (github.event_name == 'pull_request' && github.event.pull_request.merged == true && steps.set_ids.outputs.final_incident_id != '') ||
           (github.event_name == 'workflow_dispatch' && inputs.incident_id != '')
         uses: fjogeleit/http-request-action@v1
         with:
@@ -55,22 +56,22 @@ jobs:
 
       - name: Auto enrich Keep incident
         if: |
-          (github.event_name == 'push' && steps.set_ids.outputs.final_incident_id != '') ||
+          (github.event_name == 'pull_request' && github.event.pull_request.merged == true && steps.set_ids.outputs.final_incident_id != '') ||
           (github.event_name == 'workflow_dispatch' && inputs.incident_id != '')
         uses: fjogeleit/http-request-action@v1
         with:
           url: "https://api.keephq.dev/incidents/${{ steps.set_ids.outputs.final_incident_id }}/enrich"
           method: "POST"
           customHeaders: '{"X-API-KEY": "${{ secrets.KEEP_API_KEY }}", "Content-Type": "application/json"}'
-          data: '{"enrichments":{"incident_title":"${{ github.event.head_commit.message || ''Manual resolution'' }}","incident_url":"${{ github.event.head_commit.url || format(''{0}/{1}/actions/runs/{2}'', github.server_url, github.repository, github.run_id) }}", "incident_id": "${{ github.run_id }}", "incident_provider": "github"}}'
+          data: '{"enrichments":{"incident_title":"${{ github.event.pull_request.title || ''Manual resolution'' }}","incident_url":"${{ github.event.pull_request.html_url || github.server_url }}//${{ github.repository }}/actions/runs/${{ github.run_id }}", "incident_id": "${{ github.run_id }}", "incident_provider": "github"}}'
 
       - name: Auto resolve Keep alert
         if: |
-          (github.event_name == 'push' && steps.set_ids.outputs.final_alert_fingerprint != '') ||
+          (github.event_name == 'pull_request' && github.event.pull_request.merged == true && steps.set_ids.outputs.final_alert_fingerprint != '') ||
           (github.event_name == 'workflow_dispatch' && inputs.alert_fingerprint != '')
         uses: fjogeleit/http-request-action@v1
         with:
           url: "https://api.keephq.dev/alerts/enrich?dispose_on_new_alert=true"
           method: "POST"
           customHeaders: '{"Content-Type": "application/json", "X-API-KEY": "${{ secrets.KEEP_API_KEY }}"}'
-          data: '{"enrichments":{"status":"${{ inputs.status || ''resolved'' }}","dismissed":false,"dismissUntil":"","note":"${{ github.event.head_commit.message || ''Manual resolution'' }}","ticket_url":"${{ github.event.head_commit.url || format(''{0}/{1}/actions/runs/{2}'', github.server_url, github.repository, github.run_id) }}"},"fingerprint":"${{ steps.set_ids.outputs.final_alert_fingerprint }}"}'
+          data: '{"enrichments":{"status":"${{ inputs.status || ''resolved'' }}","dismissed":false,"dismissUntil":"","note":"${{ github.event.pull_request.title || ''Manual resolution'' }}","ticket_url":"${{ github.event.pull_request.html_url || github.server_url }}//${{ github.repository }}/actions/runs/${{ github.run_id }}"},"fingerprint":"${{ steps.set_ids.outputs.final_alert_fingerprint }}"}'

Diff for: README.md

@@ -237,6 +237,12 @@
             Kibana
         </a>
     </td>
+    <td align="center" width="150">
+        <a href="https://docs.keephq.dev/providers/documentation/libre_nms-provider" target="_blank">
+            <img width="40" src="keep-ui/public/icons/libre_nms-icon.png" alt="LibreNMS"/><br/>
+            LibreNMS
+        </a>
+    </td>
     <td align="center" width="150">
         <a href="https://docs.keephq.dev/providers/documentation/netbox-provider" target="_blank">
             <img width="40" src="keep-ui/public/icons/netbox-icon.png" alt="NetBox"/><br/>
@@ -261,14 +267,14 @@
             Parseable
         </a>
     </td>
+</tr>
+<tr>
     <td align="center" width="150">
         <a href="https://docs.keephq.dev/providers/documentation/pingdom-provider" target="_blank">
             <img width="40" src="keep-ui/public/icons/pingdom-icon.png" alt="Pingdom"/><br/>
             Pingdom
         </a>
     </td>
-</tr>
-<tr>
     <td align="center" width="150">
         <a href="https://docs.keephq.dev/providers/documentation/prometheus-provider" target="_blank">
             <img width="40" src="keep-ui/public/icons/prometheus-icon.png" alt="Prometheus"/><br/>
@@ -299,14 +305,14 @@
             OpenObserve
         </a>
     </td>
+</tr>
+<tr>
   <td align="center" width="150">
         <a href="https://docs.keephq.dev/providers/documentation/site24x7-provider" target="_blank">
             <img width="40" src="keep-ui/public/icons/site24x7-icon.png" alt="Site24x7"/><br/>
           Site24x7
         </a>
   </td>
-</tr>
-<tr>
   <td align="center" width="150">
         <a href="https://docs.keephq.dev/providers/documentation/splunk-provider" target="_blank">
             <img width="40" src="keep-ui/public/icons/splunk-icon.png" alt="Splunk"/><br/>
@@ -337,14 +343,14 @@
           VictoriaLogs
         </a>
   </td>
+</tr>
+<tr>
   <td align="center" width="150">
         <a href="https://docs.keephq.dev/providers/documentation/victoriametrics-provider" target="_blank">
             <img width="40" src="keep-ui/public/icons/victoriametrics-icon.png" alt="VictoriaMetrics"/><br/>
           VictoriaMetrics
         </a>
   </td>
-</tr>
-<tr>
   <td align="center" width="150">
         <a href="https://docs.keephq.dev/providers/documentation/wazuh-provider" target="_blank">
             <img width="40" src="keep-ui/public/icons/wazuh-icon.png" alt="Wazuh"/><br/>

Diff for: docker/Dockerfile.api

@@ -31,6 +31,7 @@ RUN poetry export -f requirements.txt --output requirements.txt --without-hashes
 COPY keep keep
 COPY ee keep/ee
 COPY examples examples
+COPY keep-ui/public/icons/unknown-icon.png unknown-icon.png
 RUN /venv/bin/pip install --use-deprecated=legacy-resolver . && \
     rm -rf /root/.cache/pip && \
     find /venv -type d -name "__pycache__" -exec rm -r {} + && \
@@ -42,6 +43,7 @@ ENV VIRTUAL_ENV="/venv"
 ENV EE_PATH="ee"
 COPY --from=builder /venv /venv
 COPY --from=builder /app/examples /examples
+COPY --from=builder /app/unknown-icon.png unknown-icon.png
 # as per Openshift guidelines, https://docs.openshift.com/container-platform/4.11/openshift_images/create-images.html#use-uid_create-images
 RUN chgrp -R 0 /app && chmod -R g=u /app && \
     chown -R keep:keep /app && \

Diff for: docs/cli/installation.mdx

@@ -22,7 +22,10 @@ git clone https://github.com/keephq/keep.git && cd keep
 Install Keep CLI with `pip`:
 
 ```shell
-pip install .
+# MacOS if python or pip not present:
+# brew install [email protected]
+# brew install postgresql
+pip3.11 install .
 ```
 or with `poetry`:
 
@@ -36,33 +39,33 @@ From now on, Keep should be installed locally and accessible from your CLI, test
 keep version
 ```
 
-### Test
-Get a Slack Incoming Webhook using [this tutorial](https://api.slack.com/messaging/webhooks) and use use Keep to configure it
+### Configuration
 
+To get API key, check Keep UI -> your username (bottom left) -> Settings -> API Keys
 ```
-keep config provider --provider-type slack --provider-id slack-demo
+keep config new --url http://backend.my_keep.my_awesome_org.com:backend_port --api-key your_personal_api_key
 ```
-Paste the Slack Incoming Webhook URL (e.g. https://hooks.slack.com/services/...) and you're good to go 👌
 
-Let's now execute our example "Paper DB has insufficient disk space" alert
+### Test
 
-```bash
-keep run --alerts-file examples/workflows/db_disk_space.yml
+Now, 
+```
+keep workflow apply -f examples/workflows/query_clickhouse.yml
 ```
 
-Congrats 🥳 You should have received your first "Dunder Mifflin Paper Company" alert in Slack by now.
+Congrats 🥳 Check your UI for the new workflow uploaded from the YAML file.
 
 
 ## Docker image (Option 2)
 ### Install
 
 ```
-docker run -v ${PWD}:/app -it us-central1-docker.pkg.dev/keephq/keep/keep-cli config provider --provider-type slack --provider-id slack-demo
+docker run -v ${PWD}:/app -v ~/.keep.yaml:/root/.keep.yaml -it us-central1-docker.pkg.dev/keephq/keep/keep-cli keep config new --url http://backend.my_keep.my_awesome_org.com:backend_port --api-key your_personal_api_key
 ```
 
 ### Test
 ```
-docker run -v ${PWD}:/app -it us-central1-docker.pkg.dev/keephq/keep/keep-cli -j run --alert-url https://raw.githubusercontent.com/keephq/keep/main/examples/alerts/db_disk_space.yml
+docker run -v ${PWD}:/app -v ~/.keep.yaml:/root/.keep.yaml -it us-central1-docker.pkg.dev/keephq/keep/keep-cli workflow apply -f examples/workflows/query_clickhouse.yml
 ```
 
 

Diff for: docs/images/librenms-provider_1.png

@@ -183,6 +183,7 @@
             "providers/documentation/keep-provider",
             "providers/documentation/kibana-provider",
             "providers/documentation/kubernetes-provider",
+            "providers/documentation/libre_nms-provider",
             "providers/documentation/linear_provider",
             "providers/documentation/linearb-provider",
             "providers/documentation/llamacpp-provider",

Diff for: docs/images/librenms-provider_2.png

@@ -0,0 +1,141 @@
+---
+title: 'LibreNMS'
+sidebarTitle: 'LibreNMS Provider'
+description: 'LibreNMS allows you to receive alerts from LibreNMS using API endpoints as well as webhooks'
+---
+
+## Authentication Parameters
+
+The LibreNMS provider offers two ways to authenticate:
+
+- `LibreNMS Host URL` - This is the URL of your LibreNMS instance.
+- `LibreNMS API Key` - This is the API key created in the User Settings of your LibreNMS account and is used to authenticate requests to the LibreNMS API.
+
+## Connecting LibreNMS to Keep
+
+1. Open LibreNMS dashboard and click on settings in the top right corner.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/librenms-provider_4.png" />
+</Frame>
+
+2. Click on `Create API access token` to generate a new API key.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/librenms-provider_5.png" />
+</Frame>
+
+3. Give a description to the API key and click on `Create API Token`.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/librenms-provider_6.png" />
+</Frame>
+
+## Webhooks Integration
+
+1. Open LibreNMS dashboard and open `Alerts` tab in the navigation bar and click on `Alert Transports`.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/librenms-provider_1.png" />
+</Frame>
+
+2. Click on `Create add transport` and select `Transport type` as `API`. Select the `API Method` as `POST`.
+
+3. Fill the `API URL` with [https://api.keephq.dev/alerts/event/libre_nms](https://api.keephq.dev/alerts/event/libre_nms).
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/librenms-provider_2.png" />
+</Frame>
+
+4. Copy the below JSON and paste it in `body` field.
+
+```json
+{
+  "title": "{{ $title }}",
+  "hostname": "{{ $hostname }}",
+  "device_id": "{{ $device_id }}",
+  "sysDescr": "{{ $sysDescr }}",
+  "sysName": "{{ $sysName }}",
+  "sysContact": "{{ $sysContact }}",
+  "os": "{{ $os }}",
+  "type": "{{ $type }}",
+  "ip": "{{ $ip }}",
+  "display": "{{ $display }}",
+  "version": "{{ $version }}",
+  "hardware": "{{ $hardware }}",
+  "features": "{{ $features }}",
+  "serial": "{{ $serial }}",
+  "status": "{{ $status }}",
+  "status_reason": "{{ $status_reason }}",
+  "location": "{{ $location }}",
+  "description": "{{ $description }}",
+  "notes": "{{ $notes }}",
+  "uptime": "{{ $uptime }}",
+  "uptime_short": "{{ $uptime_short }}",
+  "uptime_long": "{{ $uptime_long }}",
+  "elapsed": "{{ $elapsed }}",
+  "alerted": "{{ $alerted }}",
+  "alert_id": "{{ $alert_id }}",
+  "alert_notes": "{{ $alert_notes }}",
+  "proc": "{{ $proc }}",
+  "rule_id": "{{ $rule_id }}",
+  "id": "{{ $id }}",
+  "faults": "{{ $faults }}",
+  "uid": "{{ $uid }}",
+  "severity": "{{ $severity }}",
+  "rule": "{{ $rule }}",
+  "name": "{{ $name }}",
+  "string": "{{ $string }}",
+  "timestamp": "{{ $timestamp }}",
+  "contacts": "{{ $contacts }}",
+  "state": "{{ $state }}",
+  "msg": "{{ $msg }}",
+  "builder": "{{ $builder }}"
+}
+```
+
+5. Follow the below steps to create a new API key in Keep.
+
+6. Go to Keep dashboard and click on the profile icon in the botton left corner and click `Settings`.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/keep-apikey-1.png" />
+</Frame>
+
+7. Select `Users and Access` tab and then select `API Keys` tab and create a new API key.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/keep-apikey-2.png" />
+</Frame>
+
+8. Give name and select the role as `webhook` and click on `Create API Key`.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/keep-apikey-3.png" />
+</Frame>
+
+9. Copy the API key.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/keep-apikey-4.png" />
+</Frame>
+
+10. Add a new header with key as `X-API-KEY` and create a new API key in Keep and paste it as the value and save the webhook.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/librenms-provider_2.png" />
+</Frame>
+
+11. Save the webhook.
+
+12. You can add devices from the Devices tab in the LibreNMS dashboard and select the alert transport that you have created.
+
+<Frame width="100" height="200">
+  <img height="10" src="/images/librenms-provider_3.png" />
+</Frame>
+
+13. Now, you will receive the alerts in Keep.
+
+## Useful Links
+
+- [LibreNMS](https://www.librenms.org/)

Diff for: docs/images/librenms-provider_3.png

@@ -313,6 +313,12 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
   icon={ <img src="https://img.logo.dev/kubernetes.io?token=pk_dfXfZBoKQMGDTIgqu7LvYg" /> }
 ></Card>
 
+<Card
+  title="LibreNMS"
+  href="/providers/documentation/libre_nms-provider"
+  icon={ <img src="https://img.logo.dev/librenms.org?token=pk_dfXfZBoKQMGDTIgqu7LvYg" /> }
+></Card>
+
 <Card
   title="Linear"
   href="/providers/documentation/linear_provider"