Go to file
Ryland Herrick 4ca52e678a
[Security Solution][Detections] Refactor ML calls for newest ML permissions (#74582)
## Summary

Addresses https://github.com/elastic/kibana/issues/73567.

ML Users (role: `machine_learning_user`) were previously able to invoke the ML Recognizer API, which we use to get not-yet-installed ML Jobs relevant to our index patterns. As of https://github.com/elastic/kibana/pull/64662 this is not true, and so we receive errors from components using the underlying hook, `useSiemJobs`.

To solve this I've created two separate hooks to replace `useSiemJobs`:

* `useSecurityJobs`
  * used on ML Popover
  * includes uninstalled ML Jobs
  * checks (and returns) `isMlAdmin` before fetching data
* `useInstalledSecurityJobs`
  * used on ML Jobs Dropdown and Anomalies Table
  * includes only installed ML Jobs
  * checks (and returns) `isMlUser` before fetching data

Note that we while we now receive the knowledge to do so, we do not always inform the user in the case of invalid permissions, and instead have the following behaviors:

#### User has insufficient license
* ML Popover:  shows an upgrade CTA
* Anomalies Tables: show no data
* Rule Creation: ML Rule option is disabled, shows upgrade CTA
* Rule Details: ML Job Id is displayed as text
#### User is ML User
* ML Popover:  not shown
* Anomalies Tables: show no data
* Rule Creation: ML Rule option is disabled
* Rule Details: ML Job Id is displayed as text
#### User is ML Admin
* ML Popover:  shown
* Anomalies Tables: show data __for installed ML Jobs__
  * This is the same as previous logic, but worth calling out that you can't view historical anomalies
* Rule Creation: ML Rule option is enabled, all ML Jobs available
* Rule Details: ML Job Id is displayed as hyperlink, job status badge shown

### Checklist

- [x] [Unit or functional tests](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#cross-browser-compatibility) were updated or added to match the most common scenarios

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled appropriately](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#release-notes-process)
2020-08-12 18:26:06 -06:00
.ci [Jenkins] run CI when plugin readmes change (#74388) 2020-08-05 12:05:17 -07:00
.github Update links that pointed to CONTRIBUTING.md (#74757) 2020-08-11 10:18:12 -04:00
common/graphql
config Node options from cfg file for production (#62468) 2020-07-13 16:30:03 +01:00
data
docs Empty index patterns page re-design (#68819) 2020-08-12 15:58:16 -05:00
examples [Dashboard First] Decouple Attribute Service and By Value Embeddables (#74302) 2020-08-12 15:31:44 -04:00
licenses
packages [bin/kibana-plugin] support KP plugins instead (#74604) 2020-08-12 16:38:08 -07:00
rfcs Fixed grammar (#74725) 2020-08-11 06:40:22 -04:00
scripts [KP] Expose new es client (#73651) 2020-07-30 19:12:37 +02:00
src [bin/kibana-plugin] support KP plugins instead (#74604) 2020-08-12 16:38:08 -07:00
tasks [CI] Add pipeline task queue framework and merge workers into one (#71268) 2020-08-04 13:13:51 -04:00
test Empty index patterns page re-design (#68819) 2020-08-12 15:58:16 -05:00
typings Update @typescript-eslint to ensure compatibility with TypeScript v3.9 (#74091) 2020-08-05 17:32:19 +02:00
utilities apply prettier styles 2020-05-22 09:08:58 +02:00
vars [Jenkins] run CI when plugin readmes change (#74388) 2020-08-05 12:05:17 -07:00
webpackShims upgrade elastic/numeral and complete migration away from numeral (#68035) 2020-06-03 10:07:11 -07:00
x-pack [Security Solution][Detections] Refactor ML calls for newest ML permissions (#74582) 2020-08-12 18:26:06 -06:00
.backportrc.json chore(NA): setup backport tool for 7.9 and the new 7.x (#71861) 2020-07-15 09:32:13 -07:00
.browserslistrc Aligns BrowserList config with Support Matrix (#71876) 2020-07-16 10:56:07 -07:00
.editorconfig
.eslintignore [pre-req] Move .storybook to storybook; standardize files (#72384) 2020-07-20 22:18:20 -04:00
.eslintrc.js [Lens] Clean and inline disabling of react-hooks/exhaustive-deps eslint rule (#70010) 2020-08-06 10:10:09 +02:00
.fossa.yml Adds FOSSA CLI configuration file (#70137) 2020-07-02 08:37:37 -07:00
.gitattributes
.gitignore [CI] Add pipeline task queue framework and merge workers into one (#71268) 2020-08-04 13:13:51 -04:00
.i18nrc.json Migrate timelion to the NP. (#69160) 2020-07-14 18:41:12 +03:00
.node-version Update Node.js to version 10.21.0 (#68059) 2020-06-05 08:31:59 +02:00
.nvmrc Update Node.js to version 10.21.0 (#68059) 2020-06-05 08:31:59 +02:00
.prettierrc
.sass-lint.yml Empty index patterns page re-design (#68819) 2020-08-12 15:58:16 -05:00
.telemetryrc.json [Telemetry] Collector Schema (#64942) 2020-06-27 02:52:26 +03:00
.yarnrc
api-documenter.json Normalize EOL symbol in platform docs (#56021) 2020-01-27 18:42:45 +01:00
CONTRIBUTING.md Improvements to our developer guide (#67764) 2020-07-13 10:47:01 -04:00
FAQ.md
github_checks_reporter.json implementing github checks - second attempt (#35757) 2019-05-01 16:02:33 -05:00
Gruntfile.js apply prettier styles 2020-05-22 09:08:58 +02:00
Jenkinsfile [CI] Add pipeline task queue framework and merge workers into one (#71268) 2020-08-04 13:13:51 -04:00
kibana.d.ts Update @typescript-eslint to ensure compatibility with TypeScript v3.9 (#74091) 2020-08-05 17:32:19 +02:00
LICENSE.txt
NOTICE.txt chore(NA): teardown dynamic dll plugin (#72096) 2020-07-17 11:04:14 +01:00
package.json [bin/kibana-plugin] support KP plugins instead (#74604) 2020-08-12 16:38:08 -07:00
preinstall_check.js
README.md chore: point issue links to choose (#49616) 2019-10-29 15:54:27 +01:00
renovate.json5 disable renovate masterIssue 2020-07-22 14:43:12 -07:00
STYLEGUIDE.md [Lens] 7.9 design cleanup (#71444) 2020-07-13 20:06:58 -04:00
tsconfig.browser.json
tsconfig.json Bump jest related packages (#58095) 2020-06-20 21:05:09 +02:00
tsconfig.types.json [data.search.aggs]: Add AggConfig.toSerializedFieldFormat (#69114) 2020-06-24 07:52:21 -06:00
TYPESCRIPT.md Fixed grammar (#74725) 2020-08-11 06:40:22 -04:00
yarn.lock [bin/kibana-plugin] support KP plugins instead (#74604) 2020-08-12 16:38:08 -07:00

Kibana

Kibana is your window into the Elastic Stack. Specifically, it's a 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:

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.