# elastalert-server

**Repository Path**: Sunnyghd/elastalert-server

## Basic Information

- **Project Name**: elastalert-server
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-11-09
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

* Elastalert Helm Chart

[elastalert](https://github.com/Yelp/elastalert) is a simple framework for alerting on anomalies, spikes, or other patterns of interest from data in Elasticsearch.

This elastalert is based on the bitsensor docker image [[https://github.com/bitsensor/yelp-elastalert][found here]]

* TL;DR;

** Installing the Chart

To install the chart with the release name `my-release`(use helm2.x):

#+BEGIN_SRC emacs-lisp
git clone https://gitee.com/lenxia/elastalert-server.git
cd  elastalert-server
helm install --name my-release --namespace logging ./
#+END_SRC

The command deploys elastalert on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

** Uninstalling the Chart

To uninstall/delete the my-release deployment:

#+BEGIN_SRC emacs-lisp
helm del --purge my-release
#+END_SRC

The command removes all the Kubernetes components associated with the chart and deletes the release.

* Configuration :ARCHIVE:

| Parameter                         | Description                                                                                | Default                         |
| ------------------------          | -------------------------------------------------                                          | ------------------------------- |
| `image.repository`                | docker image                                                                               | bitsensor/elastalert-docker     |
| `image.tag`                       | docker image tag                                                                           | 3.0.0-beta.0                    |
| `image.pullPolicy`                | image pull policy                                                                          | IfNotPresent                    |
| `command`                         | command override for container                                                             | `NULL`                          |
| `args`                            | args override for container                                                                | `NULL`                          |
| `replicaCount`                    | number of replicas to run                                                                  | 1                               |
| `elasticsearch.host`              | elasticsearch endpoint to use                                                              | elasticsearch                   |
| `elasticsearch.port`              | elasticsearch port to use                                                                  | 80                              |
| `elasticsearch.useSsl`            | whether or not to connect to es_host using SSL                                             | False                           |
| `elasticsearch.username`          | Username for ES with basic auth                                                            | `NULL`                          |
| `elasticsearch.password`          | Password for ES with basic auth                                                            | `NULL`                          |
| `elasticsearch.verifyCerts`       | whether or not to verify TLS certificates                                                  | True                            |
| `elasticsearch.clientCert`        | path to a PEM certificate to use as the client certificate                                 | /certs/client.pem               |
| `elasticsearch.clientKey`         | path to a private key file to use as the client key                                        | /certs/client-key.pem           |
| `elasticsearch.caCerts`           | path to a CA cert bundle to use to verify SSL connections                                  | /certs/ca.pem                   |
| `elasticsearch.certsVolumes`      | certs volumes, required to mount ssl certificates when elasticsearch has tls enabled       | `NULL`                          |
| `elasticsearch.certsVolumeMounts` | mount certs volumes, required to mount ssl certificates when elasticsearch has tls enabled | `NULL`                          |
| `extraConfigOptions`              | Additional options to propagate to all rules, cannot be `alert`, `type`, `name` or `index` | `{}`                            |
| `resources`                       | Container resource requests and limits                                                     | {}                              |
| `rules`                           | Rule and alert configuration for Elastalert                                                | {} example shown in values.yaml |
| `runIntervalMins`                 | Default interval between alert checks, in minutes                                          | 1                               |
| `realertIntervalMins`             | Time between alarms for same rule, in minutes                                              | `NULL`                          |
| `alertRetryLimitMins`             | Time to retry failed alert deliveries, in minutes                                          | 2880 (2 days)                   |
| `bufferTimeMins`                  | Default rule buffer time, in minutes                                                       | 15                              |
| `writebackIndex`                  | Name or prefix of elastalert index(es)                                                     | elastalert_status               |
| `nodeSelector`                    | Node selector for deployment                                                               | {}                              |
| `tolerations`                     | Tolerations for deployment                                                                 | []                              |
| `securityContext`                 | fsGroup and supplementalGroups                                                             | {}                              |
| `ports`                           | containerPort                                                                              | []                              |
| `ServiceAccount`                  | Service account for the namespace                                                          | `NULL`                          |
| `ServiceAccountName`              | Service account name for the namespace                                                     | `NULL`                          |
| `net`                             | net flag arg                                                                               | `NULL`                          |
| `service`                         | type, port, protocol,targetport                                                            | `NULL`                          |
| `serverConfig`                    | configurations to setup elastalert server                                                  | {}                              |