🔦 Alerts for Kubernetes
Clone or download
tamalsaha Pass image pull secrets for cleaner job in chart (#425)
Signed-off-by: Tamal Saha <tamal@appscode.com>
Latest commit a74b3d9 Oct 14, 2018

README.md

Go Report Card Build Status codecov Docker Pulls Slack Twitter

Searchlight

Searchlight by AppsCode is a Kubernetes operator for Icinga. If you are running production workloads in Kubernetes, you probably want to be alerted when things go wrong. Icinga periodically runs various checks on a Kubernetes cluster and sends notifications if detects an issue. It also nicely supplements whitebox monitoring tools like, Prometheus with blackbox monitoring can catch problems that are otherwise invisible, and also serves as a fallback in case internal systems completely fail. Searchlight is a CRD controller for Kubernetes built around Icinga to address these issues. Searchlight can do the following things for you:

  • Periodically run various checks on a Kubernetes cluster and its nodes or pods.
  • Includes a suite of check commands written specifically for Kubernetes.
  • Searchlight can send notifications via Email, SMS or Chat.
  • Supplements the whitebox monitoring tools like Prometheus.

Supported Versions

Please pick a version of Searchlight that matches your Kubernetes installation.

Searchlight Version Docs Kubernetes Version
7.0.0 (uses CRD) User Guide 1.8.x+ (test/qa clusters)
5.1.1 (uses CRD) User Guide 1.7.x+
3.0.1 (uses TPR) User Guide 1.5.x - 1.7.x

Installation

To install Searchlight, please follow the guide here.

Using Searchlight

Want to learn how to use Searchlight? Please start here.

Searchlight API Clients

You can use Searchlight api clients to programmatically access its CRD objects. Here are the supported clients:

Contribution guidelines

Want to help improve Searchlight? Please start here.


Searchlight binaries collects anonymous usage statistics to help us learn how the software is being used and how we can improve it. To disable stats collection, run the operator with the flag --enable-analytics=false.


Acknowledgement

  • Many thanks to Icinga project.

Support

We use Slack for public discussions. To chit chat with us or the rest of the community, join us in the AppsCode Slack team channel #searchlight_. To sign up, use our Slack inviter.

If you have found a bug with Searchlight or want to request for new features, please file an issue.