Merge branch 'develop' into 'master'

Bump master to 0.0.10

See merge request back-end/elastalert!16

Author: Martijn Rondeel

.dockerignore

@@ -1,8 +1,10 @@
-.editorconfig
-.gitlab-ci.yml
-.gitignore
-*.iml
-.idea/
-.git/
-node_modules/
-lib/
+*
+!index.js
+!package-lock.json
+!package.json
+!.babelrc
+!src/
+!scripts/
+!elastalert_modules/
+!rule_templates/
+!config/

.gitignore

@@ -73,3 +73,4 @@ jspm_packages
 lib/
 *.pyc
 config/config.json
+package-lock.json

.gitlab-ci.yml

@@ -22,8 +22,8 @@
 stages:
   - build
   - test
-  - deploy
   - mirror
+  - deploy
 
 cache:
   key: elastalert
@@ -45,11 +45,18 @@ test:
     - npm install --quiet
     - npm test
 
-lint:
-  <<: *node-test
+mirror:github:
+  stage: mirror
   script:
-    - npm install --quiet
-    - ./node_modules/.bin/eslint .
+    - git clone --mirror https://git.bitsensor.io/back-end/elastalert.git mirror-github
+    - cd mirror-github
+    - git remote add github https://$MIRROR_GITHUB_USER:$MIRROR_GITHUB_PASSWORD@$MIRROR_GITHUB_URL
+    - git push -u github -q --mirror
+    - rm -rf mirror-github
+  when: always
+  only:
+    - tags
+    - develop
 
 deploy:npm:
   image: node:slim
@@ -64,8 +71,9 @@ deploy:npm:
 deploy:docker:
   stage: deploy
   script:
+    - sh scripts/replace_templates.sh ${CI_JOB_TOKEN}
     - docker info
-    - docker login -u $BITSENSOR_USERNAME -p $BITSENSOR_PASSWORD artifacts.bitsensor.io:1443
+    - echo $BITSENSOR_PASSWORD | docker login -u $BITSENSOR_USERNAME --password-stdin artifacts.bitsensor.io:1443
     - docker build -t elastalert .
     - docker tag elastalert artifacts.bitsensor.io:1443/elastalert:latest
     - docker tag elastalert artifacts.bitsensor.io:1443/elastalert:$(git describe --abbrev=0)
@@ -79,8 +87,9 @@ deploy:docker:
 deploy:docker:snapshot:
   stage: deploy
   script:
+    - sh scripts/replace_templates.sh ${CI_JOB_TOKEN}
     - docker info
-    - docker login -u $BITSENSOR_USERNAME -p $BITSENSOR_PASSWORD artifacts.bitsensor.io:1443
+    - echo $BITSENSOR_PASSWORD | docker login -u $BITSENSOR_USERNAME --password-stdin artifacts.bitsensor.io:1443
     - docker build -t elastalert .
     - docker tag elastalert artifacts.bitsensor.io:1443/elastalert:snapshot
     - docker push artifacts.bitsensor.io:1443/elastalert:snapshot
@@ -89,14 +98,30 @@ deploy:docker:snapshot:
   tags:
     - docker
 
-mirror:github:
-  stage: mirror
+deploy:docker-hub:
+  stage: deploy
   script:
-    - git clone --mirror https://git.bitsensor.io/back-end/elastalert.git mirror-github
-    - cd mirror-github
-    - git remote add github https://$MIRROR_GITHUB_USER:$MIRROR_GITHUB_PASSWORD@$MIRROR_GITHUB_URL
-    - git push -u github -q --mirror
-  when: always
+    - docker info
+    - echo $DOCKER_PASSWORD | docker login -u $DOCKER_USERNAME --password-stdin
+    - docker build -t elastalert .
+    - docker tag elastalert bitsensor/elastalert:latest
+    - docker tag elastalert bitsensor/elastalert:$(git describe --abbrev=0)
+    - docker push bitsensor/elastalert:latest
+    - docker push bitsensor/elastalert:$(git describe --abbrev=0)
   only:
     - tags
+  tags:
+    - docker
+
+deploy:docker-hub:snapshot:
+  stage: deploy
+  script:
+    - docker info
+    - echo $DOCKER_PASSWORD | docker login -u $DOCKER_USERNAME --password-stdin
+    - docker build -t elastalert .
+    - docker tag elastalert bitsensor/elastalert:snapshot
+    - docker push bitsensor/elastalert:snapshot
+  only:
     - develop
+  tags:
+    - docker

.node-version

@@ -0,0 +1 @@
+9.9.0

.nvmrc

@@ -25,7 +25,7 @@ cd elastalert
 
 Then follow the default installation steps, so:
 
-1. Run `nvm install "$(cat .node-version)"` to install & use the required NodeJS version.
+1. Run `nvm install "$(cat .nvmrc)"` to install & use the required NodeJS version.
 2. Run `npm install` to install all the dependencies.
 3. Look at the `Config` section in [REAMDE.md](../README.md#config) to setup the path to your ElastAlert instance.
 

CONTRIBUTING.md

@@ -3,10 +3,10 @@ FROM ivankrizsan/elastalert AS py-ea
 # ENV ELASTALERT_URL https://github.com/bitsensor/yelp-elastalert/archive/master.zip
 
 FROM node:alpine
-MAINTAINER BitSensor <[email protected]>
+LABEL maintainer="[email protected]"
 EXPOSE 3030
 
-RUN apk update && apk upgrade && apk add python2
+RUN apk update && apk add --no-cache python2 curl
 
 COPY --from=py-ea /usr/lib/python2.7/site-packages /usr/lib/python2.7/site-packages
 COPY --from=py-ea /opt/elastalert /opt/elastalert

Dockerfile

@@ -1,7 +1,7 @@
 The 3-clause BSD license (Modified)
 ===================================
 
-Copyright © 2016, BitSensor B.V.
+Copyright © 2018, BitSensor B.V.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

LICENSE.md

@@ -1,45 +1,57 @@
 # Elastalert Server
 **A server that runs [ElastAlert](https://github.com/Yelp/elastalert) and exposes REST API's for manipulating rules and alerts. It works great in combination with our [ElastAlert Kibana plugin](https://github.com/bitsensor/elastalert-kibana-plugin).**
 
-## Requirements
-- Docker
+![img](https://www.bitsensor.io/assets/img/screenshots/template.gif)
 
-## Docker installation
-First, build the container locally:
+## Installing Kibana plugin
+Kibana 4
+```bash
+./bin/kibana plugin -i elastalert -u https://git.bitsensor.io/front-end/elastalert-kibana-plugin/builds/artifacts/master/raw/build/elastalert-latest.zip?job=build
+```
+
+Kibana 5
+```bash
+./bin/kibana-plugin install https://git.bitsensor.io/front-end/elastalert-kibana-plugin/builds/artifacts/kibana5/raw/artifact/elastalert-`pwd | grep -Po '(?<=kibana-)[^-]*'`-latest.zip?job=build
+```
+
+Kibana 5 (if you have renamed the `kibana-5.x.x` folder
 ```bash
-docker build . -t elastalert
+./bin/kibana-plugin install https://git.bitsensor.io/front-end/elastalert-kibana-plugin/builds/artifacts/kibana5/raw/artifact/elastalert-5.x.x-latest.zip?job=build
 ```
-The default configuration uses localhost as ES host.
 
-_Bash_
+Append to the `config/kibana.yml` file the host of ElastAlert server, if it is different than localhost. Typically the case if you are running on macOS. 
+```
+elastalert.serverHost: docker.for.mac.localhost
+```
+
+## Docker installation
+The default configuration uses localhost as ES host. You will want to mount the volumes for configuration and rule files to keep them after container updates. In order to do that conviniently, please do a `git clone https://github.com/bitsensor/elastalert.git; cd elastalert`
+
+### Bash
 ```bash
 docker run -d -p 3030:3030 \
     -v `pwd`/config/elastalert.yaml:/opt/elastalert/config.yaml \
     -v `pwd`/config/config.json:/opt/elastalert-server/config/config.json \
     -v `pwd`/rules:/opt/elastalert/rules \
     -v `pwd`/rule_templates:/opt/elastalert/rule_templates \
-    -v `pwd`/elastalert_modules:/opt/elastalert/elastalert_modules \
     --net="host" \
-    --name elastalert elastalert:latest
+    --name elastalert bitsensor/elastalert:latest
 ```
 
-_Fish_
+### Fish
 ```bash
 docker run -d -p 3030:3030 \
     -v (pwd)/config/elastalert.yaml:/opt/elastalert/config.yaml \
     -v (pwd)/config/config.json:/opt/elastalert-server/config/config.json \
     -v (pwd)/rules:/opt/elastalert/rules \
     -v (pwd)/rule_templates:/opt/elastalert/rule_templates \
-    -v (pwd)/elastalert_modules:/opt/elastalert/elastalert_modules \
     --net="host" \
-    --name elastalert elastalert:latest
+    --name elastalert bitsensor/elastalert:latest
 ```
 ### Configuration
 #### ElastAlert parameters
 ElastAlert supports additional arguments, that can be passed in the `config.json` file. An example is given in `config/config-historic-data-example.json`. 
 
-
-
 ## Installation using npm and manual ElastAlert setup
 
 ### Requirements
@@ -52,7 +64,7 @@ ElastAlert supports additional arguments, that can be passed in the `config.json
     git clone https://github.com/bitsensor/elastalert.git elastalert
     cd elastalert
     ```
-2. Run `nvm install "$(cat .node-version)"` to install & use the required NodeJS version.
+2. Run `nvm install "$(cat .nvmrc)"` to install & use the required NodeJS version.
 3. Run `npm install` to install all the dependencies.
 4. Look at the `Config` section to setup the path to your ElastAlert instance.
 
@@ -212,5 +224,5 @@ This project is [BSD Licensed](../LICENSE.md) with some modifications. Note that
 We [(BitSensor)](https://www.bitsensor.io) do not have any rights over the original [ElastAlert](https://github.com/Yelp/elastalert) project from [Yelp](https://www.yelp.com/). We do not own any trademarks or copyright to the name "ElastAlert" (ElastAlert, however, does because of their Apache 2 license). We do own copyright over the source code of this project, as stated in our BSD license, which means the copyright notice below and as stated in the BSD license should be included in (merged / changed) distributions of this project. The BSD license also states that making promotional content using 'BitSensor' is prohibited. However we hereby grant permission to anyone who wants to use the phrases 'BitSensor ElastAlert Plugin', 'BitSensor Software' or 'BitSensor Alerting' in promotional content. Phrases like 'We use BitSensor' or 'We use BitSensor security' when only using our ElastAlert Server are forbidden.
 
 ## Copyright
-Copyright © 2016, BitSensor B.V.
+Copyright © 2018, BitSensor B.V.
 All rights reserved.

README.md

@@ -1,13 +1,15 @@
 from elastalert.enhancements import BaseEnhancement
 from util import convert_array_to_object
-from util import parse_detections
+from util import parse_array
 
-# For easier access to nested values in an array , this merges all items in  array
+# For easier access to nested values in an array , this merges all items in array
 # within  
 class AlertTextEnhancement(BaseEnhancement):
     # The enhancement is run against every match
     # The match is passed to the process function where it can be modified in any way
     # ElastAlert will do this for each enhancement linked to a rule
     def process(self, match):
-        parsed_match = parse_detections(match)
+        parsed_match = parse_array(match, 'detections')
+        match.update(parsed_match)
+        parsed_match = parse_array(match, 'errors')
         match.update(parsed_match)