Merge branch 'develop' into 'master'

Update master

See merge request front-end/elastalert-kibana-plugin!2

Author: martijnrondeel

.eslintrc

@@ -0,0 +1,7 @@
+---
+extends: "@elastic/kibana"
+
+settings:
+  import/resolver:
+    '@elastic/eslint-import-resolver-kibana':
+      rootPackageName: 'elastalert-kibana-plugin'

.gitignore

@@ -0,0 +1,3 @@
+npm-debug.log*
+node_modules
+/build/

.nvmrc

@@ -0,0 +1 @@
+8.11.4

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+## Development
+
+See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. Once you have completed that, you can use the commands below.
+
+  - `yarn kbn bootstrap`
+
+    Install dependencies and crosslink Kibana and all projects/plugins.
+
+  - `yarn start`
+
+    Start kibana and have it include this plugin. You can pass any arguments that you would normally send to `bin/kibana`
+
+      ```bash
+      yarn start --elasticsearch.url http://localhost:9220
+      ```
+
+  - `yarn build`
+
+    Build a distributable archive of the plugin.
+
+  - `yarn test:browser`
+
+    Run the browser tests in a real web browser.
+
+  - `yarn test:server`
+
+    Run the server tests using mocha.
+
+For more information about any of these commands run `yarn ${task} --help`. For a full list of tasks checkout the `package.json` file, or run `yarn run`.
+
+## Releasing
+
+In the develop branch the Kibana version in `package.json` should always point to the latest unreleased stable version. For example: if Kibana 6.3.2 has been released the version should be 6.3.3. 
+
+The develop branch is merged to master when a new version is ready (do not forget to increment the version inside `package.json`). The new version is tagged and uploaded to GitHub releases.
+
+A GitHub release should at least contain a build for the latest stable Kibana version, but if possible builds for older minor versions should be created as well. Building for a specific Kibana version can be done easily with: `yarn build -k kibana-version-here`.

LICENSE.md

@@ -1,22 +1,20 @@
-The 3-clause BSD license (Modified)
-===================================
+# 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:
 
-  * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-  * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-  * Neither the name of BitSensor, BitSensor B.V. nor the
-    names of its contributors may be used to endorse or promote products
-    derived from this software without specific prior written permission.
-    However, those names can be used when explicitely stating the use of
-    the ElastAlert Server Plugin (which can be rephrased as the Alerting
-    Plugin).
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+- Neither the name of BitSensor, BitSensor B.V. nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+  However, those names can be used when explicitly stating the use of
+  the ElastAlert Kibana Plugin.
 
 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
@@ -27,4 +25,4 @@ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,9 +1,25 @@
-# ElastAlert Kibana plugin
-![img](https://raw.githubusercontent.com/bitsensor/elastalert-kibana-plugin/master/kibana-elastalert-plugin-showcase.gif)
+# ElastAlert Kibana Plugin
+
+> This plugin provides a way to create, test and edit ElastAlert rules within Kibana.
+
+![Showcase](showcase.gif)
+
+---
+
+## Requirements
+- Our [ElastAlert](https://github.com/bitsensor/elastalert) fork
+- Kibana 6.3.1 or higher
 
 ## Installation
-Check the installation guide inside the branch that matches your Kibana version.
+Check the [releases](https://github.com/bitsensor/elastalert-kibana-plugin/releases) page to download and install the latest version of this plugin that is compatible with your Kibana version.
+
+## Configuration
+By default the plugin will connect to `localhost:3030`. If your ElastAlert server is running on a different host or port add/change the following options in your `config/kibana.yml` file: 
+
+```
+elastalert-kibana-plugin.serverHost: 123.0.0.1
+elastalert-kibana-plugin.serverPort: 9000
+```
 
-- [Kibana 4.6.6](https://github.com/bitsensor/elastalert-kibana-plugin/tree/4.6.6)
-- [Kibana 5.6.8](https://github.com/bitsensor/elastalert-kibana-plugin/tree/5.6.8)
-- [Kibana 6.2.3](https://github.com/bitsensor/elastalert-kibana-plugin/tree/6.2.3) (experimental)
+## Contribution
+Please report any issues or suggestions you have on the [issues page](https://github.com/bitsensor/elastalert-kibana-plugin/issues). If you want to create a pull request please check our [contribution guide](CONTRIBUTING.md).

index.js

@@ -0,0 +1,29 @@
+import elastAlertAPI from './server/routes/elastalert';
+
+export default function (kibana) {
+  return new kibana.Plugin({
+    name: 'elastalert-kibana-plugin',
+    uiExports: {
+      app: {
+        title: 'ElastAlert',
+        description: 'A way to create, test and edit ElastAlert rules within Kibana.',
+        main: 'plugins/elastalert-kibana-plugin/app'
+      }
+    },
+    config(Joi) {
+      return Joi.object({
+        enabled: Joi.boolean().default(true),
+        serverHost: Joi.string()
+          .hostname()
+          .default('localhost'),
+        serverPort: Joi.number()
+          .integer()
+          .default(3030),
+        serverSsl: Joi.boolean().default(false)
+      }).default();
+    },
+    init(server, options) {
+      elastAlertAPI(server, options);
+    }
+  });
+}

package.json

@@ -0,0 +1,38 @@
+{
+  "name": "elastalert-kibana-plugin",
+  "version": "1.0.0",
+  "description": "Create, test and edit ElastAlert rules within Kibana.",
+  "main": "index.js",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "kibana": {
+    "version": "6.4.2",
+    "templateVersion": "1.0.0"
+  },
+  "scripts": {
+    "preinstall": "node ../../kibana/preinstall_check",
+    "kbn": "node ../../kibana/scripts/kbn",
+    "lint": "eslint .",
+    "start": "plugin-helpers start",
+    "test:server": "plugin-helpers test:server",
+    "test:browser": "plugin-helpers test:browser",
+    "build": "plugin-helpers build"
+  },
+  "devDependencies": {
+    "@elastic/eslint-config-kibana": "link:../../kibana/packages/eslint-config-kibana",
+    "@elastic/eslint-import-resolver-kibana": "link:../../kibana/packages/kbn-eslint-import-resolver-kibana",
+    "@kbn/plugin-helpers": "link:../../kibana/packages/kbn-plugin-helpers",
+    "babel-eslint": "^8.0.2",
+    "eslint": "^4.11.0",
+    "eslint-plugin-babel": "^4.1.1",
+    "eslint-plugin-import": "^2.3.0",
+    "eslint-plugin-jest": "^21.3.2",
+    "eslint-plugin-mocha": "^4.9.0",
+    "eslint-plugin-no-unsanitized": "^3.0.2",
+    "eslint-plugin-prefer-object-spread": "^1.2.1",
+    "eslint-plugin-react": "^7.0.1",
+    "expect.js": "^0.3.1"
+  },
+  "dependencies": {
+    "@elastic/eui": "^4.2.0"
+  }
+}

public/app.js

@@ -0,0 +1,34 @@
+import React from 'react';
+import { uiModules } from 'ui/modules';
+import chrome from 'ui/chrome';
+import { render, unmountComponentAtNode } from 'react-dom';
+import 'ui/autoload/styles';
+import { Main } from './components/main';
+
+const app = uiModules.get('apps/elastalertKibanaPlugin');
+
+app.config($locationProvider => {
+  $locationProvider.html5Mode({
+    enabled: false,
+    requireBase: false,
+    rewriteLinks: false
+  });
+});
+
+app.config(stateManagementConfigProvider =>
+  stateManagementConfigProvider.disable()
+);
+
+function RootController($scope, $element, $http) {
+  const domNode = $element[0];
+
+  // render react to DOM
+  render(<Main title="ElastAlert Kibana Plugin" httpClient={$http} />, domNode);
+
+  // unmount react on controller destroy
+  $scope.$on('$destroy', () => {
+    unmountComponentAtNode(domNode);
+  });
+}
+
+chrome.setRootController('elastalertKibanaPlugin', RootController);

public/components/console/console.js

@@ -0,0 +1,14 @@
+import React from 'react';
+import { EuiCallOut } from '@elastic/eui';
+
+export const Console = (props) => (
+  <EuiCallOut
+    size="s"
+    title="Console output"
+    iconType="console"
+    color={props.hasError ? 'danger' : 'success'}
+    style={{ whiteSpace: 'pre-wrap' }}
+  >
+    {props.consoleOutput}
+  </EuiCallOut>
+);