Deployment

Keep currently supports Docker and Render.

​

E2E

​

Docker

​

CLI

Run Keep alerting engine (The CLI)

​

Docker

Configure the Slack provider (See ”Run locally” on how to obtain the webhook URL)

docker run -v ${PWD}:/app -it us-central1-docker.pkg.dev/keephq/keep/keep-cli config provider --provider-type slack --provider-id slack-demo

You should now have a providers.yaml file created locally

Run Keep and execute our example “Paper DB has insufficient disk space” alert

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

​

Render

Click the Deploy to Render button to deploy Keep as a background worker running in Render

To run Keep and execute our example “Paper DB has insufficient disk space” alert, you will need to configure you Slack provider. When clicking the Deploy to Render button, you will be asked to provide the KEEP_PROVIDER_SLACK_DEMO environment variable, this is the expected format:

{ "authentication": { "webhook_url": "https://hooks.slack.com/services/..." } }

** KEEP_PROVIDER_PROVIDER_ID is the way you can configure providers using environment variables
** Refer to Run locally on how to obtain a Slack webhook URL or on how to obtain Keep’s webhook.