diff --git a/_posts/2020-04-18-plugins.md b/_posts/2020-04-18-plugins.md new file mode 100644 index 0000000..81d63af --- /dev/null +++ b/_posts/2020-04-18-plugins.md @@ -0,0 +1,81 @@ +--- +layout: page +title: "Plugins" +category: use +date: 2020-04-18 21:37:00 +order: 11 +--- + +### Plugins + +Plugins can be used to add new alerting and check functionality to Cabot. The list below is provided as a reference and these plugins ahve not necessarily been validated. Test and use at your own risk. + +### Installing plugins + +Installing plugins with the recommended Docker installation requires some extra work to build a custom Docker image to install the plugin from PyPi. + +1. Create your own Dockerfile +``` + FROM cabotapp/cabot:0.11.13 + RUN pip install cabot_alert_telegram +``` +2. Build a new container +``` + docker build -t foobar/cabot:latest . +``` +3. Verify that pip install worked +``` + docker run -it foobar/cabot:latest /bin/sh + pip freeze +``` +Expected output +``` + ... + botocore==1.10.26 + cabot==0.11.13 + cabot-alert-email==1.4.3 + cabot-alert-hipchat==2.0.3 + cabot-alert-slack==0.8.3 + cabot-alert-telegram==0.6 + cabot-alert-twilio==1.3.3 + cabot-check-cloudwatch==0.1.2 + celery==4.0.2 + ... +``` +4. Update the docker-compose file to reference the new image +``` + web: + image: foobar/cabot:latest +``` + +5. Update the conf/default.env file to add the new plugin (or if multiple, separate by commas +``` + CABOT_PLUGINS_ENABLED=cabot_alert_email,cabot_alert_telegram +``` + +### Alerting plugins +* Team Chat + * [RocketChat](https://pypi.org/project/cabot-alert-rocketchat/) + * [TypeTalk](https://pypi.org/project/cabot-alert-typetalk/) + * [DingDing](https://pypi.org/project/cabot-alert-dingding/) + * [IRC](https://pypi.org/project/cabot-alert-irc/) +* Notification/Messaging Services + * [Alerta](https://pypi.org/project/cabot-alert-alerta/) + * [Telegram](https://pypi.org/project/cabot-alert-telegram/) + * [PagerDuty](https://pypi.org/project/cabot-alert-pagerduty/) + * [Pushover](https://pypi.org/project/cabot-alert-pushover/) + * [Mattermost](https://pypi.org/project/cabot-alert-slack-mattermost/) +* Misc + * [Webhooks](https://pypi.org/project/cabot-alert-webhooks/) + * [OVH](https://pypi.org/project/cabot-alert-ovh/) + + +### Check plugins + +These plugins can be installed to provide additional checks to the Cabot system. This list is provided as a reference and has not been verified. Test and use at your own risk. + +* [Network connection](https://github.com/cabotapp/cabot-check-network) - check network connection ([custom setup instructions - to be integrated into these docs](https://github.com/cabotapp/cabot-check-network/issues/2)) +* [Cloudwatch](https://github.com/cabotapp/cabot-check-cloudwatch) [PyPi](https://pypi.org/project/cabot-check-cloudwatch/) - check metrics on AWS Cloudwatch +* [SSL Cert](https://pypi.org/project/cabot-check-sslcert/) - SSL certificate check +* [Prometheus](https://pypi.org/project/cabot-check-prometheus/) - check metrics from [Prometheus monitoring system] (https://prometheus.io/) +* [InfluxDB](https://pypi.org/project/cabot-check-influxdb/) - check metrisc from [InfluxDB time series database] (https://www.influxdata.com/)