Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ilert/ilert-kube-agent

ilert Kubernetes integration
https://github.com/ilert/ilert-kube-agent

alarm eks gke kubernetes lambda node-alert pod-alert sms voice-call

Last synced: about 1 month ago
JSON representation

ilert Kubernetes integration

Host: GitHub
URL: https://github.com/ilert/ilert-kube-agent
Owner: iLert
License: apache-2.0
Created: 2021-02-18T13:19:36.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2021-03-09T12:12:06.000Z (almost 4 years ago)
Last Synced: 2024-06-20T00:50:28.704Z (7 months ago)
Topics: alarm, eks, gke, kubernetes, lambda, node-alert, pod-alert, sms, voice-call
Language: Go
Homepage: https://docs.ilert.com/integrations/kubernetes
Size: 430 KB
Stars: 4
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # ilert-kube-agent

[![Build Status](https://github.com/iLert/ilert-kube-agent/workflows/docker-release/badge.svg)](https://github.com/iLert/ilert-kube-agent/actions)

[![Go Report Card](https://goreportcard.com/badge/github.com/iLert/ilert-kube-agent)](https://goreportcard.com/report/github.com/iLert/ilert-kube-agent) [![GoDoc](https://godoc.org/github.com/iLert/ilert-kube-agent?status.svg)](https://godoc.org/github.com/iLert/ilert-kube-agent)

[![Docker Pulls](https://img.shields.io/docker/pulls/ilert/ilert-kube-agent.svg?maxAge=604800)](https://hub.docker.com/r/ilert/ilert-kube-agent)

ilert-kube-agent is a service that listens to the Kubernetes API

server and generates incidents about the health state of the pods and the nodes.

_{Node alert example:

![Node alert example](img/slack_node_cpu_alert.png)}

_{Pod alert example:

![Pod alert example](img/slack_pod_cpu_alert.png)}

## Usage

Simply build and run ilert-kube-agent to get Kubernetes cluster alarms.

| Flag | Description |

| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| `--alarms.cluster.enabled` | Enables cluster alarms. Triggers an alarm if any cluster problem occurred e.g. API server not available [Default: true] |

| `--alarms.pods.terminate.enabled` | Enables terminate pod alarms. Triggers an alarm if any pod terminated e.g. Terminated, OOMKilled, Error, ContainerCannotRun, DeadlineExceeded, Evicted [Default: true] |

| `--alarms.pods.waiting.enabled` | Enables waiting pod alarms. Triggers an alarm if any pod in waiting status e.g. CrashLoopBackOff, ErrImagePull, ImagePullBackOff, CreateContainerConfigError, InvalidImageName, CreateContainerError [Default: true] |

| `--alarms.pods.restarts.enabled` | Enables restarts pod alarms. Triggers an alarm if any pod restarts count reached threshold [Default: true] |

| `--alarms.pods.resources.cpu.enabled` | Enables pod CPU resource alarms. Triggers an alarm if any pod reaches CPU limit [Default: true] |

| `--alarms.pods.resources.memory.enabled` | Enables pod CPU resource alarms. Triggers an alarm if any pod reaches memory limit [Default: true] |

| `--alarms.nodes.terminate.enabled` | Enables terminate node alarms. Triggers an alarm if any node terminated. [Default: true] |

| `--alarms.nodes.resources.cpu.enabled` | Enables node CPU resource alarms. Triggers an alarm if any node reaches CPU limit [Default: true] |

| `--alarms.nodes.resources.memory.enabled` | Enables node CPU resource alarms. Triggers an alarm if any node reaches memory limit [Default: true] |

## Deployment

**Note:** Google Kubernetes Engine (GKE) Users - GKE has strict role permissions that will prevent the kube-state-metrics roles and role bindings from being created. To work around this, you can give your GCP identity the cluster-admin role by running the following one-liner:

```sh

kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin --user=$(gcloud info --format='value(config.account)')

```

### Helm Deployment (recommended)

```sh

helm repo add ilert https://ilert.github.io/charts/

helm repo update

helm upgrade --install --namespace kube-systems \

    ilert-kube-agent ilert/ilert-kube-agent \

    --set config.settings.apiKey=""

```

### Terraform Deployment (recommended)

- Define module:

```hcl

module "ilert-kube-agent" {

  source  = "iLert/ilert-kube-agent/kubernetes"

  replicas = 2

  api_key = ""

}

```

- Apply changes

```sh

terraform init

terraform apply

```

### Lambda Deployment

Follow [this guide](deployment/lambda/README.md) please.

### Raw YAML Deployment

To deploy this project, you can simply run `kubectl apply -f deployment/standard` and a

Kubernetes service and deployment will be created.

## Getting help

We are happy to respond to [GitHub issues][issues] as well.

[issues]: https://github.com/iLert/ilert-kube-agent/issues/new




#### License

^{Licensed under Apache License, Version

2.0}




_{Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ilert-kube-agent by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.}