Go to file
Spencer 5ecdaa7e7b
Move kibana-plugin-helpers to kbn-plugin-helpers package (#16565)
* initial commit

Original commit: elastic/kibana-plugin-helpers@06c603d0d9

* simplify bin scripts and get them working

Original commit: elastic/kibana-plugin-helpers@1455f09194

* [npm] finish package.json

Original commit: elastic/kibana-plugin-helpers@c7b0e9d522

* [readme] inception

Original commit: elastic/kibana-plugin-helpers@5caa197ea7

* [npm] rename

Original commit: elastic/kibana-plugin-helpers@9fb16dd1c3

* [package.json] fix typo

Original commit: elastic/kibana-plugin-helpers@f135485c1a

* [npm] do not commit npm logs

Original commit: elastic/kibana-plugin-helpers@a1bf7505a7

* version 5.0.0-beta1

Original commit: elastic/kibana-plugin-helpers@5abf8ee2ac

* Fix start cmd on Windows

Original commit: elastic/kibana-plugin-helpers@7718cefd8a

* 5.0.0-beta2

Original commit: elastic/kibana-plugin-helpers@4e70c3e4d8

* added license files for better visiblity

Original commit: elastic/kibana-plugin-helpers@a3297e2728

* group task related files

Original commit: elastic/kibana-plugin-helpers@4a8ccce1ec

* [build] place the plugin contents under the kibana directory

Original commit: elastic/kibana-plugin-helpers@0a0f5fea0a

* [start] send extra args to the kibana process

Original commit: elastic/kibana-plugin-helpers@ce943ca67c

* 5.0.0

Original commit: elastic/kibana-plugin-helpers@42163ce240

* Correctly bundle dependencies if there is only one

Fixes elastic/kibana-plugin-helpers#8

Original commit: elastic/kibana-plugin-helpers@c46b2ca07c

* [test:server] include Kibana node_modules/.bin in path when running server tests

Original commit: elastic/kibana-plugin-helpers@bbda801351

* 5.0.1-pre

Original commit: elastic/kibana-plugin-helpers@2d26645117

* Pass pluginId and plugin-path values through correctly (elastic/kibana-plugin-helpers#11)

Fixes elastic/kibana-plugin-helpers#10

Original commit: elastic/kibana-plugin-helpers@74defe4206

* 5.0.1-pre2

Original commit: elastic/kibana-plugin-helpers@0fd7d07558

* [build] ask for kibana version when set to "kibana"

Original commit: elastic/kibana-plugin-helpers@5fe34c47ae

* 5.0.1-pre3

Original commit: elastic/kibana-plugin-helpers@2e0e10106b

* Running main, corrected build, checking for no dependencies (elastic/kibana-plugin-helpers#15)

* Updated if check if there are no dependencies

* Now running main()

* Build now uses the correct parameter.

Original commit: elastic/kibana-plugin-helpers@7cf31d26d2

* fix lint error

Original commit: elastic/kibana-plugin-helpers@06af5c3dd4

* support defining an alternate plugin root

Original commit: elastic/kibana-plugin-helpers@0e4d4fa501

* add an optional callback to the build action

Original commit: elastic/kibana-plugin-helpers@6a1012f96b

* run vinyl.src in the plugin.root directory

Original commit: elastic/kibana-plugin-helpers@8f3081b029

* add basic test for the build action

Original commit: elastic/kibana-plugin-helpers@52230f6c3b

* include nvmrc file for development

Original commit: elastic/kibana-plugin-helpers@f51115de11

* add circle-ci config file

Original commit: elastic/kibana-plugin-helpers@80505e1b0d

* 5.0.1

Original commit: elastic/kibana-plugin-helpers@e42d134e4c

* use a promise instead of a callback to track task completion

Original commit: elastic/kibana-plugin-helpers@c6dacf3507

* 5.0.1-patch1

Original commit: elastic/kibana-plugin-helpers@d49bb6ea73

* do not pass stdin to sub tasks, fixes elastic/kibana-plugin-helpers#19

Original commit: elastic/kibana-plugin-helpers@f872954888

* 5.0.1-patch2

Original commit: elastic/kibana-plugin-helpers@a754ef5b50

* Use json files to override default config values (elastic/kibana-plugin-helpers#21)

* read json overrides, mix into defaults

* rename plugin config helper

* use the plugin config in start

Original commit: elastic/kibana-plugin-helpers@4cfbe28128

* allow browser tests to be runOnce

Original commit: elastic/kibana-plugin-helpers@ede52ece0e

* add a test/all task

Original commit: elastic/kibana-plugin-helpers@9b7c15cf32

* add test command to execute test/all

Original commit: elastic/kibana-plugin-helpers@e096ac55f3

* remove use of spread and default assignment

Original commit: elastic/kibana-plugin-helpers@17532f0fdd

* pass run method into tasks

don't reach into lib for it

Original commit: elastic/kibana-plugin-helpers@d92d2e979a

* use --dev flag for browser dev mode

Original commit: elastic/kibana-plugin-helpers@a790fdd338

* fix default command, no more use of call

Original commit: elastic/kibana-plugin-helpers@fe13b987c9

* Move require calls outside of task functions (elastic/kibana-plugin-helpers#23)

* move require calls outside of task functions

* fix default command value

Original commit: elastic/kibana-plugin-helpers@846855e960

* add --include options to test:server

Original commit: elastic/kibana-plugin-helpers@d3b5e24207

* split and concat and included server test paths

Original commit: elastic/kibana-plugin-helpers@e7dffb6ffe

* add plugins option to browser tests

used to pass your own testsBundle.pluginIds to the test runner

Original commit: elastic/kibana-plugin-helpers@d370d74bd4

* if plugins are specified, use the option value instead of the default

Original commit: elastic/kibana-plugin-helpers@d610c9c9d6

* assign args in argument passing code

minor syntax change

Original commit: elastic/kibana-plugin-helpers@ce77d071d1

* make server test files an argument

Original commit: elastic/kibana-plugin-helpers@b043b423ef

* add not about custom tests executiong to the readme/help

Original commit: elastic/kibana-plugin-helpers@139221e5a6

* Separate the task runner and the command line parser (elastic/kibana-plugin-helpers#25)

* remove conditionl require in runner

add tasks module to load all tasks, throw if task does not exist

* change task signatures and action handlers

- tasks get plugin, run, and an options object
- action handler controls what goes into each task
- taskRunner wrapper moves the command object to the first argument

* change test command signature

allow files to be passed in, and pass all options to test:server and test:browser

* simplify the task runner

* fix typo in unknownOptions

* expose the task runner as the module's main

this way tasks can be run programatically without going through a cli parser

* add tests for task runner

* remove file passing for testAll

* add serverTestPaths to the plugin config

useful for overriding the value via a config file

* [config] plugin.serverTestPaths -> plugin.serverTestPatterns

Original commit: elastic/kibana-plugin-helpers@82af4df64e

* 5.1.0

Original commit: elastic/kibana-plugin-helpers@6dd1407e81

* update the readme

Original commit: elastic/kibana-plugin-helpers@c650c4527e

* append build info to package.json

Original commit: elastic/kibana-plugin-helpers@504fd07f3c

* format the package.json file

Original commit: elastic/kibana-plugin-helpers@c474820bb5

* node4 support: const -> var

Original commit: elastic/kibana-plugin-helpers@19b607d954

* fix cli parsing of --dev flag

Original commit: elastic/kibana-plugin-helpers@3aa37c2dfc

* 5.1.1

Original commit: elastic/kibana-plugin-helpers@ad9a8e85b8

* Enable custom builds (elastic/kibana-plugin-helpers#27)

* only modify root package.json file

previously this was modifying every package.json from node_modules as well

* refactor the build task

export the build, define helpers outside of the task

* allow custom kibana and build versions

both can be passed via flags

* allow custom build globs to be specified

* move build into its own module

* add simple option parsing tests

* update readme

* move dependency file appending into the action

* put source and target into variables

* move config file loading into a module

* refactor test_server_action slightly

be more explicit about the files option overwriting the plugin settings

* move default build patterns to plugin config

allows the setting to be overridden via the config file

* fix dirname on relative includes

trim any leading '../' off the path when moving it into the build target

* move node_module dirs into plugin_config module, use existing promises

* rename file_config => config_file

Original commit: elastic/kibana-plugin-helpers@743e4a37c2

* return the result of running the action

Original commit: elastic/kibana-plugin-helpers@9b819eeeb3

* Allow custom build target via --build-destination flag (elastic/kibana-plugin-helpers#30)

* pass buildTarget into createBuild

allow override from options

* add cli option to override build destination

--build-destination

* fix tests

* resolve build destination from plugin.root

this allows both relative and absolute paths to be used

* add short option

* update the help

Original commit: elastic/kibana-plugin-helpers@6c9fb3464e

* 5.2.0

Original commit: elastic/kibana-plugin-helpers@8c2a547d9d

* Use npm/yarn to install build dependencies (elastic/kibana-plugin-helpers#28)

* remove scripts and devDependencies from package

these are only useful in development, and serve no purpose in the build

* refactor the package rewriter

* clean up the buildTarget before building

* run npm install after build creation

* break apart the create_build module

* add create_package modules

call it from within the build_action

* add flag to skip package zip creation

* rename skip-package flag to skip-archive

* rename rewritePackage to rewritePackageJson

* include lock and shrinkwrap files if they exist

* add test for skipping zip creation

* add some tests to build creation

Original commit: elastic/kibana-plugin-helpers@ef6b9c6332

* 6.0.0

Original commit: elastic/kibana-plugin-helpers@9ee7b62e75

* Update URLs in package.json (elastic/kibana-plugin-helpers#31)

The package.json URLs are still referencing @spalger's version, whilst development and collaboration happens on @elastic's version

Original commit: elastic/kibana-plugin-helpers@1f322c1cb1

* 6.0.1

Original commit: elastic/kibana-plugin-helpers@8eae537f9f

* [tasks/test/browser] fix --kbnServer.tests_bundle flag

Original commit: elastic/kibana-plugin-helpers@12e7552adb

* 6.0.2

Original commit: elastic/kibana-plugin-helpers@ff9d402245

* change let to var (elastic/kibana-plugin-helpers#35)

allow helpers to run on pre-6.0 node

Original commit: elastic/kibana-plugin-helpers@91de9a84d3

* Fix running tasks on Windows (elastic/kibana-plugin-helpers#37)

* create windows cmd wrapper

* use windows cmd wrapper on browser tests

* be explicit about the mocha command location

* use windows cmd wrapper on server tests

* use windows cmd wrapper on build

default to using npm as well

Original commit: elastic/kibana-plugin-helpers@35f80a08ce

* 6.0.3

Original commit: elastic/kibana-plugin-helpers@b4da11f899

* fix `build` task when yarn is not installed

Original commit: elastic/kibana-plugin-helpers@d48808f8d8

* 6.0.4

Original commit: elastic/kibana-plugin-helpers@0c0ee17a54

* Added helpers, KIBANA_ROOT environment override (elastic/kibana-plugin-helpers#41)

* run is now a named export, added helpers for interacting with the kibana repo

* [config] override the kibana root config with KIBANA_ROOT envvar

Original commit: elastic/kibana-plugin-helpers@54a38cd9a2

* bump to version 7 snapshot

Original commit: elastic/kibana-plugin-helpers@0c1b2c1670

* [utils] use actual plugin config (with defaults)

Original commit: elastic/kibana-plugin-helpers@f3bfdb2689

* require node 6 (elastic/kibana-plugin-helpers#42)

* switch to .node-version file

* require and validate node version 6+

Original commit: elastic/kibana-plugin-helpers@85655f230e

* Bump eslint rules, update code to match rules (elastic/kibana-plugin-helpers#43)

* bump @elastic/eslint-config-kibana and deps

* eslint --fix

* fix unused vars

some exceptions for tests

* move eslint-config-kibana to dev

* rename create_package function

* make .node-version looser, match internal checks

Original commit: elastic/kibana-plugin-helpers@6fac14bd51

* 7.0.0

Original commit: elastic/kibana-plugin-helpers@2ff10e0a45

* commit yarn.lock file

Original commit: elastic/kibana-plugin-helpers@22bc67e613

* [utils/babelRegister] add support for changes in elastic/kibana#13973

Original commit: elastic/kibana-plugin-helpers@13f30fb4d5

* 7.0.1

Original commit: elastic/kibana-plugin-helpers@abb99896ad

* Feat: add translations to default build source paths (elastic/kibana-plugin-helpers#48)

* feat: add translations path to build

included by default, to better match what's in the elastic products and even the plugin template

also add a translations path to the mock plugin for tests

* chore: add script to run tests with linting

Original commit: elastic/kibana-plugin-helpers@9871a4b11d

* chore: add yarn.lock file to repo

Original commit: elastic/kibana-plugin-helpers@4108fe6597

* v7.0.2

Original commit: elastic/kibana-plugin-helpers@dba9da1b3c

* Feat: add includePlugins setting (elastic/kibana-plugin-helpers#49)

* observe includePlugins setting

* fix: move resolve up to config parser

this ensures that the path is resolved relative to the plugin root

Original commit: elastic/kibana-plugin-helpers@fd07d617a4

* Fix: readme include docs (elastic/kibana-plugin-helpers#50)

* chore: add a simple version compat chart

* chore: document the settings and how to use them

* chore: use icon for license info

* chore: use matching badge for circleci status

Original commit: elastic/kibana-plugin-helpers@1f39e488a3

* v7.1.0

Original commit: elastic/kibana-plugin-helpers@11238b2697

* fix: read package file instead of using require

require uses a cache, so if the package.json file was changed before running build, the changes won't exist in the build runtime. using fs.readFileSync instead ensures that the information read from package.json is current.

Original commit: elastic/kibana-plugin-helpers@f78e891838

* v7.1.1

Original commit: elastic/kibana-plugin-helpers@b489c76b26

* Fix: Package use build target (elastic/kibana-plugin-helpers#52)

* fix: pass build target into package task

use the build target for the zip output

* chore: change up the npm scripts

* chore: add create package tests

* chore: update eslint deps

* chore: fix linting issues, add engines

Original commit: elastic/kibana-plugin-helpers@51058fb7fc

* v7.1.2

Original commit: elastic/kibana-plugin-helpers@e314c21bf3

* Use scripts/kibana instead of bin if available (elastic/kibana-plugin-helpers#53)

* Use scripts/kibana instead of bin if available

* semicolons

* Don't fallback to legacy bin/kibana start method

* chore: add 8.x version to compat chart

Original commit: elastic/kibana-plugin-helpers@fc72de53bd

* v8.0.0

Original commit: elastic/kibana-plugin-helpers@d538b32bc3

* chore: add kibanaRoot setting to readme

Original commit: elastic/kibana-plugin-helpers@3769efdb26

* [createToolingLog] update require path for toolingLog (elastic/kibana-plugin-helpers#54)

Original commit: elastic/kibana-plugin-helpers@d968819d09

* v8.0.1

Original commit: elastic/kibana-plugin-helpers@2663befdc4

* Add support for passing in node options via environment variable (elastic/kibana-plugin-helpers#56)

* Add support for passing in node options via environment variable

* Split node options

* semicolon

Original commit: elastic/kibana-plugin-helpers@3fc4ec0e87

* Update yarn.lock

Original commit: elastic/kibana-plugin-helpers@b3d62e5925

* v8.1.0

Original commit: elastic/kibana-plugin-helpers@fb979ff679

* Deprecate specifying kibana root location (elastic/kibana-plugin-helpers#59)

Original commit: elastic/kibana-plugin-helpers@385fdede72

* Remove kibanaRoot option, require kibana-extra (elastic/kibana-plugin-helpers#58)

* Remove kibanaRoot option, require kibana-extra

* Check location of Kibana on postinstall

* Fix eslint

* Remove 'process.env.KIBANA_ROOT'

Original commit: elastic/kibana-plugin-helpers@3511054dfb

* v9.0.0

Original commit: elastic/kibana-plugin-helpers@8d5af744bb

* [npm] upgrade gulp-zip (elastic/kibana-plugin-helpers#61)

Original commit: elastic/kibana-plugin-helpers@94e7530e76

* chore: ignore yarn.lock file

Original commit: elastic/kibana-plugin-helpers@9cad57cd97

* [npm] upgraded eslint-related deps (elastic/kibana-plugin-helpers#62)

* [npm] upgraded eslint-related deps

* [npm] reflect peer deps from @elastic/eslint-config-kibana

Original commit: elastic/kibana-plugin-helpers@1add265641

* v9.0.1

Original commit: elastic/kibana-plugin-helpers@140024adac

* [config] throw if config file has a syntax error (elastic/kibana-plugin-helpers#65)

Original commit: elastic/kibana-plugin-helpers@487dd70bdb

* v9.0.2

Original commit: elastic/kibana-plugin-helpers@3bd57fbe5e

* [kbn-plugin-helpers] remove redundant configs

* [kbn-plugin-helpers/yarn] add yarn.lock file

* run kbn-plugin-helpers tests on ci

* [plugin-helpers] remove keywords from package.json

* [plugin-helpers] rely on kibana eslint

* [plugin-helpers/eslint] remove unused vars

* [eslint] allow kebab-case in any bin directory

* [plugin-helpers] replace last few uses of old package name
2018-02-08 12:48:23 -07:00
.github Switch to Yarn (#15485) 2018-01-10 13:23:43 +01:00
bin Remove node fallback from kibana-keystore (#15066) 2017-11-27 10:11:38 -06:00
config Kibana Home page - phase one (#14673) 2017-11-02 12:58:46 -06:00
data [folder structure] plugins/.data -> data 2016-07-05 14:06:16 -05:00
docs Move kibana-plugin-helpers to kbn-plugin-helpers package (#16565) 2018-02-08 12:48:23 -07:00
packages Move kibana-plugin-helpers to kbn-plugin-helpers package (#16565) 2018-02-08 12:48:23 -07:00
plugins [folder structure] plugins/.data -> data 2016-07-05 14:06:16 -05:00
scripts Snake case scripts/kibana-keystore.js and scripts/kibana-plugin.js (#15331) 2018-02-02 09:54:02 -06:00
src Move kibana-plugin-helpers to kbn-plugin-helpers package (#16565) 2018-02-08 12:48:23 -07:00
style_guides Prettier + ESLint setup (#16514) 2018-02-05 18:18:43 +01:00
tasks Use execFile instead of exec when installing deps in build (#16587) 2018-02-08 00:37:00 +01:00
test Move kibana-plugin-helpers to kbn-plugin-helpers package (#16565) 2018-02-08 12:48:23 -07:00
ui_framework Removing flex-basis: 0 to make items size properly in IE11 (#16557) 2018-02-06 18:46:06 -08:00
utilities Upgrade to eslint 4 (#14862) 2017-11-14 18:16:59 -07:00
webpackShims Prettier + ESLint setup (#16514) 2018-02-05 18:18:43 +01:00
.backportrc.json Adds 6.2 branch to backport config (#16165) 2018-01-19 11:26:38 -08:00
.editorconfig Apply the same editorconfig rules to both markdown and asciidoc files 2016-09-07 11:41:41 -04:00
.eslintignore [eslint] un-ignore .eslintrc.js (#16542) 2018-02-05 16:29:30 -07:00
.eslintrc.js Move kibana-plugin-helpers to kbn-plugin-helpers package (#16565) 2018-02-08 12:48:23 -07:00
.gitignore Only ignore data dir on root level (#16222) 2018-01-30 15:44:26 +01:00
.node-version Bumps node to 6.12.2 (#15612) 2017-12-15 10:15:08 -08:00
.prettierrc Prettier + ESLint setup (#16514) 2018-02-05 18:18:43 +01:00
CONTRIBUTING.md Kibana build tool (#15055) 2018-01-24 10:34:52 +01:00
FAQ.md propose language changes (#10709) 2017-03-05 12:10:32 -05:00
Gruntfile.js create babel-preset and babel-register modules (#13973) 2017-09-19 17:44:47 -07:00
LICENSE.md [build] Add notice file (#10344) 2017-02-16 11:41:09 -05:00
package.json Revert "Upgrade to EUI 0.0.19. (#16576)" 2018-02-08 08:14:22 -05:00
preinstall_check.js Preinstall check that mentions 'yarn kbn' (#16572) 2018-02-08 13:40:57 +01:00
README.md [DOCS] Build Kibana Guide from kibana repo (#16450) 2018-02-01 10:19:00 -08:00
STYLEGUIDE.md Fix typo in accessibility styleguide link (#14718) 2017-11-02 12:28:22 +01:00
yarn.lock Revert "Upgrade to EUI 0.0.19. (#16576)" 2018-02-08 08:14:22 -05:00

Kibana 7.0.0-alpha1

Kibana is your window into the Elastic Stack. Specifically, it's an open source (Apache Licensed), browser-based analytics and search dashboard for Elasticsearch.

Getting Started

If you just want to try Kibana out, check out the Elastic Stack Getting Started Page to give it a whirl.

If you're interested in diving a bit deeper and getting a taste of Kibana's capabilities, head over to the Kibana Getting Started Page.

Using a Kibana Release

If you want to use a Kibana release in production, give it a test run, or just play around:

Building and Running Kibana, and/or Contributing Code

You might want to build Kibana locally to contribute some code, test out the latest features, or try out an open PR:

Snapshot Builds

For the daring, snapshot builds are available. These builds are created nightly and have undergone no formal QA, so they should never be run in production. All builds are 64 bit.

platform
OSX tar
Linux tar deb rpm
Windows zip

Documentation

Visit Elastic.co for the full Kibana documentation.

For information about building the documentation, see the README in elastic/docs.

Version Compatibility with Elasticsearch

Ideally, you should be running Elasticsearch and Kibana with matching version numbers. If your Elasticsearch has an older version number or a newer major number than Kibana, then Kibana will fail to run. If Elasticsearch has a newer minor or patch number than Kibana, then the Kibana Server will log a warning.

Note: The version numbers below are only examples, meant to illustrate the relationships between different types of version numbers.

Situation Example Kibana version Example ES version Outcome
Versions are the same. 5.1.2 5.1.2 💚 OK
ES patch number is newer. 5.1.2 5.1.5 ⚠️ Logged warning
ES minor number is newer. 5.1.2 5.5.0 ⚠️ Logged warning
ES major number is newer. 5.1.2 6.0.0 🚫 Fatal error
ES patch number is older. 5.1.2 5.1.0 ⚠️ Logged warning
ES minor number is older. 5.1.2 5.0.0 🚫 Fatal error
ES major number is older. 5.1.2 4.0.0 🚫 Fatal error

Questions? Problems? Suggestions?

  • If you've found a bug or want to request a feature, please create a GitHub Issue. Please check to make sure someone else hasn't already created an issue for the same topic.
  • Need help using Kibana? Ask away on our Kibana Discuss Forum and a fellow community member or Elastic engineer will be glad to help you out.