mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
Your window into the Elastic Stack
a75155043b
# Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] Improve documentation for `version` and `revision` fields (#216074)](https://github.com/elastic/kibana/pull/216074) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Jacek Kolezynski","email":"jacek.kolezynski@elastic.co"},"sourceCommit":{"committedDate":"2025-03-31T18:06:13Z","message":"[Security Solution] Improve documentation for `version` and `revision` fields (#216074)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3545**\n\n## Summary\n\nI am fixing documentation for the version and revision fields.\nI used this page as the base documentation:\nhttps://docs.elastic.dev/security-solution/dev-docs/detections/rule-versions\n\nThe changes:\n- by marking the RuleVersion as read-only I am making sure we are\nproperly documenting that this field is not to be used in the request.\nIt is only returned in the response.\n- by introducing RuleRevision type and marking it as read-only, I am\ndoing the same for this field, saying that this field is not supposed to\nbe used in the request.\n- I am not changing any code in the app, as the ticket says we shouldn't\ndo any breaking changes and the update of the version should not cause\n400 error. Basically current behavior is kept: users can still update\nthe version to whatever value they want, including going backwards, and\nthe changes to revision field is completely ignored.\n- I am adding a condensed description of these fields.\n\nI wanted to introduce an internal link between these two fields, but I\ncouldn't make it work in Bump.sh (even though this should work, normal\nMarkdown links) so I abandoned this idea.\n\nYou can also use this [link](https://bump.sh/jkelas2/doc/kibana_wip2)\nwhere I deployed the generated bundled doc.\n\nScreenshots:\n\n<img width=\"664\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/34d82eb2-f7f0-4369-ad8e-2fd3c1f35447\"\n/>\n\n<img width=\"660\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/dc7772af-0185-4850-816e-60be003775d6\"\n/>\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"63575a8320a7e021df79727ad66ed4cf01dd1e5f","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Detections and Resp","Team: SecuritySolution","Feature:Rule Management","APIDocs","Team:Detection Rule Management","Feature:Prebuilt Detection Rules","backport:version","9.1 candidate","v9.1.0","v8.19.0"],"title":"[Security Solution] Improve documentation for `version` and `revision` fields","number":216074,"url":"https://github.com/elastic/kibana/pull/216074","mergeCommit":{"message":"[Security Solution] Improve documentation for `version` and `revision` fields (#216074)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3545**\n\n## Summary\n\nI am fixing documentation for the version and revision fields.\nI used this page as the base documentation:\nhttps://docs.elastic.dev/security-solution/dev-docs/detections/rule-versions\n\nThe changes:\n- by marking the RuleVersion as read-only I am making sure we are\nproperly documenting that this field is not to be used in the request.\nIt is only returned in the response.\n- by introducing RuleRevision type and marking it as read-only, I am\ndoing the same for this field, saying that this field is not supposed to\nbe used in the request.\n- I am not changing any code in the app, as the ticket says we shouldn't\ndo any breaking changes and the update of the version should not cause\n400 error. Basically current behavior is kept: users can still update\nthe version to whatever value they want, including going backwards, and\nthe changes to revision field is completely ignored.\n- I am adding a condensed description of these fields.\n\nI wanted to introduce an internal link between these two fields, but I\ncouldn't make it work in Bump.sh (even though this should work, normal\nMarkdown links) so I abandoned this idea.\n\nYou can also use this [link](https://bump.sh/jkelas2/doc/kibana_wip2)\nwhere I deployed the generated bundled doc.\n\nScreenshots:\n\n<img width=\"664\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/34d82eb2-f7f0-4369-ad8e-2fd3c1f35447\"\n/>\n\n<img width=\"660\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/dc7772af-0185-4850-816e-60be003775d6\"\n/>\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"63575a8320a7e021df79727ad66ed4cf01dd1e5f"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/216074","number":216074,"mergeCommit":{"message":"[Security Solution] Improve documentation for `version` and `revision` fields (#216074)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3545**\n\n## Summary\n\nI am fixing documentation for the version and revision fields.\nI used this page as the base documentation:\nhttps://docs.elastic.dev/security-solution/dev-docs/detections/rule-versions\n\nThe changes:\n- by marking the RuleVersion as read-only I am making sure we are\nproperly documenting that this field is not to be used in the request.\nIt is only returned in the response.\n- by introducing RuleRevision type and marking it as read-only, I am\ndoing the same for this field, saying that this field is not supposed to\nbe used in the request.\n- I am not changing any code in the app, as the ticket says we shouldn't\ndo any breaking changes and the update of the version should not cause\n400 error. Basically current behavior is kept: users can still update\nthe version to whatever value they want, including going backwards, and\nthe changes to revision field is completely ignored.\n- I am adding a condensed description of these fields.\n\nI wanted to introduce an internal link between these two fields, but I\ncouldn't make it work in Bump.sh (even though this should work, normal\nMarkdown links) so I abandoned this idea.\n\nYou can also use this [link](https://bump.sh/jkelas2/doc/kibana_wip2)\nwhere I deployed the generated bundled doc.\n\nScreenshots:\n\n<img width=\"664\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/34d82eb2-f7f0-4369-ad8e-2fd3c1f35447\"\n/>\n\n<img width=\"660\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/dc7772af-0185-4850-816e-60be003775d6\"\n/>\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"63575a8320a7e021df79727ad66ed4cf01dd1e5f"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co> |
||
|---|---|---|
| .buildkite | ||
| .devcontainer | ||
| .github | ||
| api_docs | ||
| config | ||
| dev_docs | ||
| docs | ||
| examples | ||
| kbn_pm | ||
| legacy_rfcs | ||
| licenses | ||
| oas_docs | ||
| packages | ||
| plugins | ||
| scripts | ||
| src | ||
| typings | ||
| x-pack | ||
| .backportrc.json | ||
| .bazelignore | ||
| .bazeliskversion | ||
| .bazelrc | ||
| .bazelrc.common | ||
| .bazelversion | ||
| .browserslistrc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .i18nrc.json | ||
| .node-version | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| .puppeteerrc | ||
| .stylelintignore | ||
| .stylelintrc | ||
| .telemetryrc.json | ||
| .yarnrc | ||
| BUILD.bazel | ||
| catalog-info.yaml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| FAQ.md | ||
| fleet_packages.json | ||
| github_checks_reporter.json | ||
| kibana.d.ts | ||
| LICENSE.txt | ||
| NOTICE.txt | ||
| package.json | ||
| preinstall_check.js | ||
| README.md | ||
| renovate.json | ||
| RISK_MATRIX.mdx | ||
| run_fleet_setup_parallel.sh | ||
| SECURITY.md | ||
| sonar-project.properties | ||
| STYLEGUIDE.mdx | ||
| tsconfig.base.json | ||
| tsconfig.browser.json | ||
| tsconfig.browser_bazel.json | ||
| tsconfig.json | ||
| TYPESCRIPT.md | ||
| versions.json | ||
| WORKSPACE.bazel | ||
| yarn.lock | ||
Kibana
Kibana is your window into the Elastic Stack. Specifically, it's a browser-based analytics and search dashboard for Elasticsearch.
- Getting Started
- Documentation
- Version Compatibility with Elasticsearch
- Questions? Problems? Suggestions?
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:
- Download the latest version on the Kibana Download Page.
- Learn more about Kibana's features and capabilities on the Kibana Product Page.
- We also offer a hosted version of Kibana on our Cloud Service.
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:
- CONTRIBUTING.md will help you get Kibana up and running.
- If you would like to contribute code, please follow our STYLEGUIDE.mdx.
- For all other questions, check out the FAQ.md and wiki.
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. | 7.15.1 | 7.15.1 | 💚 OK |
| ES patch number is newer. | 7.15.0 | 7.15.1 | ⚠️ Logged warning |
| ES minor number is newer. | 7.14.2 | 7.15.0 | ⚠️ Logged warning |
| ES major number is newer. | 7.15.1 | 8.0.0 | 🚫 Fatal error |
| ES patch number is older. | 7.15.1 | 7.15.0 | ⚠️ Logged warning |
| ES minor number is older. | 7.15.1 | 7.14.2 | 🚫 Fatal error |
| ES major number is older. | 8.0.0 | 7.15.1 | 🚫 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.