feat: Merge branch 'main' into feature/elastic

keephq · Jun 18, 2024 · acd3373 · acd3373
2 parents b780ff6 + b451994
commit acd3373
Show file tree

Hide file tree

Showing 119 changed files with 1,077 additions and 540 deletions.
diff --git a/.gitignore b/.gitignore
@@ -191,3 +191,9 @@ storage
 
 # otel files
 tempo-data/
+
+# docs
+docs/node_modules/
+
+
+scripts/automatic_extraction_rules.py
diff --git a/README.md b/README.md
@@ -195,6 +195,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/rollbar-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/centreon-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/netdata-icon.png?raw=true"/>
 </p>
 <h3 align="center">Ticketing tools</h2>
 <p align="center">

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,8 @@
+How to run docs locally:
+
+```
+npm i -g mintlify
+mintlify dev
+```
+
+Read more: https://mintlify.com/docs/development
diff --git a/docs/api-ref/alerts/assign-alert.mdx b/docs/api-ref/alerts/assign-alert.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /alerts/{fingerprint}/assign/{last_received}
+---
diff --git a/docs/api-ref/alerts/delete-alert.mdx b/docs/api-ref/alerts/delete-alert.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /alerts
+---
diff --git a/docs/api-ref/alerts/enrich-alert.mdx b/docs/api-ref/alerts/enrich-alert.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /alerts/enrich
+---
diff --git a/docs/api-ref/alerts/get-alert-history.mdx b/docs/api-ref/alerts/get-alert-history.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /alerts/{fingerprint}/history
+---
diff --git a/docs/api-ref/alerts/get-alert.mdx b/docs/api-ref/alerts/get-alert.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /alerts/{fingerprint}
+---
diff --git a/docs/api-ref/alerts/get-all-alerts.mdx b/docs/api-ref/alerts/get-all-alerts.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /alerts
+---
diff --git a/docs/api-ref/alerts/receive-generic-event.mdx b/docs/api-ref/alerts/receive-generic-event.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /alerts/event
+---
diff --git a/docs/api-ref/alerts/search-alerts.mdx b/docs/api-ref/alerts/search-alerts.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /alerts/search
+---
diff --git a/docs/api-ref/enrichment/create-extraction-rule.mdx b/docs/api-ref/enrichment/create-extraction-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /extraction
+---
diff --git a/docs/api-ref/enrichment/create-rule.mdx b/docs/api-ref/enrichment/create-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /mapping
+---
diff --git a/docs/api-ref/enrichment/delete-extraction-rule.mdx b/docs/api-ref/enrichment/delete-extraction-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /extraction/{rule_id}
+---
diff --git a/docs/api-ref/enrichment/delete-rule.mdx b/docs/api-ref/enrichment/delete-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /mapping/{rule_id}
+---
diff --git a/docs/api-ref/enrichment/get-extraction-rules.mdx b/docs/api-ref/enrichment/get-extraction-rules.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /extraction
+---
diff --git a/docs/api-ref/enrichment/get-rules.mdx b/docs/api-ref/enrichment/get-rules.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /mapping
+---
diff --git a/docs/api-ref/enrichment/update-extraction-rule.mdx b/docs/api-ref/enrichment/update-extraction-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: put /extraction/{rule_id}
+---
diff --git a/docs/api-ref/enrichment/update-rule.mdx b/docs/api-ref/enrichment/update-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: put /mapping
+---
diff --git a/docs/api-ref/groups/get-groups.mdx b/docs/api-ref/groups/get-groups.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /groups/
+---
diff --git a/docs/api-ref/preset/create-preset.mdx b/docs/api-ref/preset/create-preset.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /preset
+---
diff --git a/docs/api-ref/preset/delete-preset.mdx b/docs/api-ref/preset/delete-preset.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /preset/{uuid}
+---
diff --git a/docs/api-ref/preset/get-presets.mdx b/docs/api-ref/preset/get-presets.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /preset
+---
diff --git a/docs/api-ref/preset/update-preset.mdx b/docs/api-ref/preset/update-preset.mdx
@@ -0,0 +1,3 @@
+---
+openapi: put /preset/{uuid}
+---
diff --git a/docs/api-ref/providers/get-installed-providers.mdx b/docs/api-ref/providers/get-installed-providers.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /providers/export
+---
diff --git a/docs/api-ref/providers/install-provider-oauth2.mdx b/docs/api-ref/providers/install-provider-oauth2.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /providers/install/oauth2/{provider_type}
+---
diff --git a/docs/api-ref/providers/invoke-provider-method.mdx b/docs/api-ref/providers/invoke-provider-method.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /providers/{provider_id}/invoke/{method}
+---
diff --git a/docs/api-ref/providers/update-provider.mdx b/docs/api-ref/providers/update-provider.mdx
@@ -0,0 +1,3 @@
+---
+openapi: put /providers/{provider_id}
+---
diff --git a/docs/api-ref/providers/validate-provider-scopes.mdx b/docs/api-ref/providers/validate-provider-scopes.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /providers/{provider_id}/scopes
+---
diff --git a/docs/api-ref/pusher/pusher-authentication.mdx b/docs/api-ref/pusher/pusher-authentication.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /pusher/auth
+---
diff --git a/docs/api-ref/rules/create-rule.mdx b/docs/api-ref/rules/create-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /rules
+---
diff --git a/docs/api-ref/rules/delete-rule.mdx b/docs/api-ref/rules/delete-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /rules/{rule_id}
+---
diff --git a/docs/api-ref/rules/get-rules.mdx b/docs/api-ref/rules/get-rules.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /rules
+---
diff --git a/docs/api-ref/rules/update-rule.mdx b/docs/api-ref/rules/update-rule.mdx
@@ -0,0 +1,3 @@
+---
+openapi: put /rules/{rule_id}
+---
diff --git a/docs/api-ref/settings/create-key.mdx b/docs/api-ref/settings/create-key.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /settings/apikey
+---
diff --git a/docs/api-ref/settings/create-user.mdx b/docs/api-ref/settings/create-user.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /settings/users
+---
diff --git a/docs/api-ref/settings/delete-api-key.mdx b/docs/api-ref/settings/delete-api-key.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /settings/apikey/{keyId}
+---
diff --git a/docs/api-ref/settings/delete-smtp-settings.mdx b/docs/api-ref/settings/delete-smtp-settings.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /settings/smtp
+---
diff --git a/docs/api-ref/settings/delete-user.mdx b/docs/api-ref/settings/delete-user.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /settings/users/{user_email}
+---
diff --git a/docs/api-ref/settings/get-keys.mdx b/docs/api-ref/settings/get-keys.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /settings/apikeys
+---
diff --git a/docs/api-ref/settings/get-smtp-settings.mdx b/docs/api-ref/settings/get-smtp-settings.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /settings/smtp
+---
diff --git a/docs/api-ref/settings/get-users.mdx b/docs/api-ref/settings/get-users.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /settings/users
+---
diff --git a/docs/api-ref/settings/test-smtp-settings.mdx b/docs/api-ref/settings/test-smtp-settings.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /settings/smtp/test
+---
diff --git a/docs/api-ref/settings/update-api-key.mdx b/docs/api-ref/settings/update-api-key.mdx
@@ -0,0 +1,3 @@
+---
+openapi: put /settings/apikey
+---
diff --git a/docs/api-ref/settings/update-smtp-settings.mdx b/docs/api-ref/settings/update-smtp-settings.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /settings/smtp
+---
diff --git a/docs/api-ref/status/status.mdx b/docs/api-ref/status/status.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /status
+---
diff --git a/docs/api-ref/users/delete-user.mdx b/docs/api-ref/users/delete-user.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /users/{user_email}
+---
diff --git a/docs/api-ref/whoami/get-tenant-id.mdx b/docs/api-ref/whoami/get-tenant-id.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /whoami
+---
diff --git a/docs/api-ref/workflows/get-raw-workflow-by-id.mdx b/docs/api-ref/workflows/get-raw-workflow-by-id.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /workflows/{workflow_id}/raw
+---
diff --git a/docs/api-ref/workflows/get-workflow-executions-by-alert-fingerprint.mdx b/docs/api-ref/workflows/get-workflow-executions-by-alert-fingerprint.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /workflows/executions
+---
diff --git a/docs/api-ref/workflows/get-workflow-executions.mdx b/docs/api-ref/workflows/get-workflow-executions.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /workflows/executions/list
+---
diff --git a/docs/api-ref/workflows/run-workflow-from-definition.mdx b/docs/api-ref/workflows/run-workflow-from-definition.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /workflows/test
+---
diff --git a/docs/api-ref/workflows/update-workflow-by-id.mdx b/docs/api-ref/workflows/update-workflow-by-id.mdx
@@ -0,0 +1,3 @@
+---
+openapi: put /workflows/{workflow_id}
+---
diff --git a/docs/deployment/authentication.mdx b/docs/deployment/authentication.mdx
@@ -59,7 +59,7 @@ Username/Password, but additional providers could be added (just submit a GitHub
 
 
 ### Setup instructions
-The easiest way would be to use [docker-compose-with-auth.yml](https://github.com/keephq/keep/blob/main/docker-compose-with-auth.yaml) which populates the following environment variables:
+The easiest way would be to use [docker-compose-with-auth.yml](https://github.com/keephq/keep/blob/main/docker-compose-with-auth.yml) which populates the following environment variables:
 
 #### Backend
 ```

diff --git a/docs/development/getting-started.mdx b/docs/development/getting-started.mdx
@@ -17,21 +17,44 @@ docker-compose -f docker-compose.dev.yml up
 ```
 
 ## VSCode
-You can run Keep from your VSCode (after cloning the repo) by adding this configurations to your `launch.json`:
+You can run Keep from your VSCode (after cloning the repo) by adding this configurations to your `.vscode/launch.json`:
 
 ```json
 {
     "version": "0.2.0",
     "configurations": [
       {
         "name": "Keep Backend",
-        "type": "python",
+        "type": "debugpy",
         "request": "launch",
         "program": "keep/cli/cli.py",
         "console": "integratedTerminal",
         "justMyCode": false,
         "args": ["--json", "api","--multi-tenant"],
-        "env": {"PYDEVD_DISABLE_FILE_VALIDATION": "1"}
+        "env": {
+            "PYDEVD_DISABLE_FILE_VALIDATION": "1",
+            "PYTHONPATH": "${workspaceFolder}/",
+            "PUSHER_APP_ID": "1",
+            "SECRET_MANAGER_DIRECTORY": "./state/",
+            "PUSHER_HOST": "localhost",
+            "PUSHER_PORT": "6001",
+            "PUSHER_APP_KEY": "keepappkey",
+            "PUSHER_APP_SECRET": "keepappsecret",
+        }
+      },
+      {
+        "name": "Keep Simulate Alerts",
+        "type": "debugpy",
+        "request": "launch",
+        "program": "scripts/simulate_alerts.py",
+        "console": "integratedTerminal",
+        "justMyCode": false,
+        "env": {
+          "PYDEVD_DISABLE_FILE_VALIDATION": "1",
+          "PYTHONPATH": "${workspaceFolder}/",
+          "KEEP_API_URL": "http://localhost:8080",
+          "KEEP_API_KEY": "some-api-key"
+        }
       },
       {
         "name": "Keep Frontend",
@@ -41,9 +64,22 @@ You can run Keep from your VSCode (after cloning the repo) by adding this config
         "cwd": "${workspaceFolder}/keep-ui",
       }
     ]
-  }
+}
+```
+
+Install dependencies:
+```
+pip install poetry'
+poetry install;
+cd keep-ui && npm i;
 ```
 
+Launch Pusher ([soketi](https://soketi.app/)) container in parallel:
+```bash
+docker run -d -p 6001:6001 -p 9601:9601 -e SOKETI_USER_AUTHENTICATION_TIMEOUT=3000 -e SOKETI_DEFAULT_APP_KEY=keepappkey -e SOKETI_DEFAULT_APP_SECRET=keepappsecret -e SOKETI_DEFAULT_APP_ID=1 quay.io/soketi/soketi:1.4-16-debian
+```
+
+
 ## VSCode + Docker
 <Info>For this guide to work, the VSCode Docker extension is required.</Info>
 <Tip>In air-gapped environments, you might consider building the container on an internet-connected computer, exporting the image using docker save, transferring it with docker load in the air-gapped environment, and then using the run configuration.</Tip>

diff --git a/docs/generate_readme_from_openapijson.sh b/docs/generate_readme_from_openapijson.sh
@@ -0,0 +1,8 @@
+
+#!/bin/bash
+
+# Before running this script, make sure you have update the openapi.json from the backend, (/docs route)
+
+python3 openapi_converter.py --source ./openapi.json --dest ./openapi_converted.json
+npx @mintlify/scraping@latest openapi-file ./openapi_converted.json -o ./api-ref
+rm ./openapi_converted.json
diff --git a/docs/mint.json b/docs/mint.json
@@ -105,6 +105,7 @@
             "providers/documentation/mailchimp-provider",
             "providers/documentation/mock-provider",
             "providers/documentation/mysql-provider",
+            "providers/documentation/netdata-provider",
             "providers/documentation/new-relic-provider",
             "providers/documentation/ntfy-provider",
             "providers/documentation/openshift-provider",

diff --git a/docs/openapi.json b/docs/openapi.json