Kibana Machine
2a4c944acb
[8.x] Document that index/enable: false SO mappings is an anti-pattern ( #201969 ) ( #202244 )
...
# Backport
This will backport the following commits from `main` to `8.x`:
- [Document that index/enable: false SO mappings is an anti-pattern
(#201969 )](https://github.com/elastic/kibana/pull/201969 )
<!--- Backport version: 9.4.3 -->
### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport )
<!--BACKPORT [{"author":{"name":"Rudolf
Meijering","email":"skaapgif@gmail.com"},"sourceCommit":{"committedDate":"2024-11-28T23:50:34Z","message":"Document
that index/enable: false SO mappings is an anti-pattern (#201969 )\n\n##
Summary\r\n\r\nDocument that index/enable: false SO mappings is an
anti-pattern\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies
following conditions. \r\n\r\nReviewers should verify this PR satisfies
this list as well.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing ),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md )\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html )\r\nwere
updated or added to match the most common scenarios\r\n- [ ] If a plugin
configuration key changed, check if it needs to be\r\nallowlisted in the
cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker )\r\n-
[ ] This was checked for breaking HTTP API changes, and any
breaking\r\nchanges have been approved by the breaking-change committee.
The\r\n`release_note:breaking` label should be applied in these
situations.\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1 )
was\r\nused on any tests changed\r\n- [ ] The PR description includes
the appropriate Release Notes section,\r\nand the correct
`release_note:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process )\r\n\r\n###
Identify risks\r\n\r\nDoes this PR introduce any risks? For example,
consider risks like hard\r\nto test bugs, performance regression,
potential of data loss.\r\n\r\nDescribe the risk, its severity, and
mitigation for each identified\r\nrisk. Invite stakeholders and evaluate
how to proceed before merging.\r\n\r\n- [ ] [See some
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx )\r\n-
[ ]
...","sha":"5f639b2a078082c19edd11d50b49231125270cf5","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","v9.0.0","backport:prev-minor"],"title":"Document
that index/enable: false SO mappings is an
anti-pattern","number":201969,"url":"https://github.com/elastic/kibana/pull/201969 ","mergeCommit":{"message":"Document
that index/enable: false SO mappings is an anti-pattern (#201969 )\n\n##
Summary\r\n\r\nDocument that index/enable: false SO mappings is an
anti-pattern\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies
following conditions. \r\n\r\nReviewers should verify this PR satisfies
this list as well.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing ),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md )\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html )\r\nwere
updated or added to match the most common scenarios\r\n- [ ] If a plugin
configuration key changed, check if it needs to be\r\nallowlisted in the
cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker )\r\n-
[ ] This was checked for breaking HTTP API changes, and any
breaking\r\nchanges have been approved by the breaking-change committee.
The\r\n`release_note:breaking` label should be applied in these
situations.\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1 )
was\r\nused on any tests changed\r\n- [ ] The PR description includes
the appropriate Release Notes section,\r\nand the correct
`release_note:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process )\r\n\r\n###
Identify risks\r\n\r\nDoes this PR introduce any risks? For example,
consider risks like hard\r\nto test bugs, performance regression,
potential of data loss.\r\n\r\nDescribe the risk, its severity, and
mitigation for each identified\r\nrisk. Invite stakeholders and evaluate
how to proceed before merging.\r\n\r\n- [ ] [See some
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx )\r\n-
[ ]
...","sha":"5f639b2a078082c19edd11d50b49231125270cf5"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/201969 ","number":201969,"mergeCommit":{"message":"Document
that index/enable: false SO mappings is an anti-pattern (#201969 )\n\n##
Summary\r\n\r\nDocument that index/enable: false SO mappings is an
anti-pattern\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies
following conditions. \r\n\r\nReviewers should verify this PR satisfies
this list as well.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing ),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md )\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html )\r\nwere
updated or added to match the most common scenarios\r\n- [ ] If a plugin
configuration key changed, check if it needs to be\r\nallowlisted in the
cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker )\r\n-
[ ] This was checked for breaking HTTP API changes, and any
breaking\r\nchanges have been approved by the breaking-change committee.
The\r\n`release_note:breaking` label should be applied in these
situations.\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1 )
was\r\nused on any tests changed\r\n- [ ] The PR description includes
the appropriate Release Notes section,\r\nand the correct
`release_note:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process )\r\n\r\n###
Identify risks\r\n\r\nDoes this PR introduce any risks? For example,
consider risks like hard\r\nto test bugs, performance regression,
potential of data loss.\r\n\r\nDescribe the risk, its severity, and
mitigation for each identified\r\nrisk. Invite stakeholders and evaluate
how to proceed before merging.\r\n\r\n- [ ] [See some
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx )\r\n-
[ ] ...","sha":"5f639b2a078082c19edd11d50b49231125270cf5"}}]}]
BACKPORT-->
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
2024-11-29 00:17:07 +00:00
Kibana Machine
916f481d7d
[8.x] Enhance documentation on accessing hidden SO types ( #199046 ) ( #199075 )
...
# Backport
This will backport the following commits from `main` to `8.x`:
- [Enhance documentation on accessing hidden SO types
(#199046 )](https://github.com/elastic/kibana/pull/199046 )
<!--- Backport version: 9.4.3 -->
### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport )
<!--BACKPORT [{"author":{"name":"Christiane (Tina)
Heiligers","email":"christiane.heiligers@elastic.co"},"sourceCommit":{"committedDate":"2024-11-06T01:51:45Z","message":"Enhance
documentation on accessing hidden SO types (#199046 )\n\nSaved objects
declared as `hidden` can only be accessed with a client\r\nthat
explicitly includes hidden types.\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )\r\nwas
added for features that require explanation or
tutorials\r\n\r\n---------\r\n\r\nCo-authored-by: Alejandro Fernández
Haro
<afharo@gmail.com>","sha":"73f31549cd0ae6c4aa5cc505907e455d16307190","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","Feature:Saved
Objects","release_note:skip","v9.0.0","DevDocs","backport:prev-minor","v8.17.0"],"title":"Enhance
documentation on accessing hidden SO
types","number":199046,"url":"https://github.com/elastic/kibana/pull/199046 ","mergeCommit":{"message":"Enhance
documentation on accessing hidden SO types (#199046 )\n\nSaved objects
declared as `hidden` can only be accessed with a client\r\nthat
explicitly includes hidden types.\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )\r\nwas
added for features that require explanation or
tutorials\r\n\r\n---------\r\n\r\nCo-authored-by: Alejandro Fernández
Haro
<afharo@gmail.com>","sha":"73f31549cd0ae6c4aa5cc505907e455d16307190"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199046 ","number":199046,"mergeCommit":{"message":"Enhance
documentation on accessing hidden SO types (#199046 )\n\nSaved objects
declared as `hidden` can only be accessed with a client\r\nthat
explicitly includes hidden types.\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )\r\nwas
added for features that require explanation or
tutorials\r\n\r\n---------\r\n\r\nCo-authored-by: Alejandro Fernández
Haro
<afharo@gmail.com>","sha":"73f31549cd0ae6c4aa5cc505907e455d16307190"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
2024-11-05 21:35:11 -06:00
Jean-Louis Leysens
b5b9f7ffc8
[Docs] SO migration on serverless tutorial notes ( #179261 )
...
## Summary
Added documentation explaining how SO migrations on serverless work
## Preview
<img width="741" alt="Screenshot 2024-03-22 at 16 15 13"
src="2217c01f
2024-03-27 00:37:37 +01:00
Christiane (Tina) Heiligers
bfee4d79e8
Updates internal dev docs for Saved Objects ( #178058 )
...
fix [#178060 ](https://github.com/elastic/kibana/issues/178060 )
Updates the internal developer docs for transitions to new model
versions.
The end-user docs were updated in
https://github.com/elastic/kibana/pull/176970
---------
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
2024-03-07 08:16:28 -07:00
Michael Dokolin
a65cd356aa
[Migrations] Add support of deferred migrations ( #153117 )
...
* Add deferred migrations parameter.
* Update outdated documents query to take into account deferred migrations.
* Update outdated documents query to take into account the core migration version.
* Update read operations in the saved objects repository to perform deferred migrations.
2023-05-22 11:17:41 +02:00
Michael Dokolin
17876df41a
[Saved Objects] Update the migrationVersion property to hold a plain string value ( #150075 )
...
* Update document migrator to rely on `typeMigrationVersion` instead of `migrationVersion`.
* Refactor document migrator to extract migration pipeline logic.
* Add `core` migration type.
2023-03-24 13:45:30 +01:00
Christiane (Tina) Heiligers
f7b25f5e46
[Saved Objects] Provide ability to remove SO type from global SO HTTP API without hiding from the client ( #149166 )
...
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
resolves https://github.com/elastic/kibana/issues/147150
2023-01-23 15:04:24 -07:00
Michael Dokolin
167797cae1
[Saved Objects] Add documentation covering hidden saved object types ( #144647 )
2022-11-08 16:42:02 +01:00
Spencer
6c438b331c
[api-docs] follow the correct schema for frontmatter ( #138348 )
...
* [api-docs] follow the correct schema for frontmatter
* rename non-generated summary: usage
* fix yaml comment syntax
2022-08-10 17:17:50 -05:00
Joe Portner
89b1f9056c
Prevent endless loop for saved object migrations ( #120146 )
2021-12-03 08:42:54 -05:00
Rudolf Meijering
2e4c87211c
[docs] Fix anchor link to saved objects migrations testing ( #116427 )
2021-10-28 10:36:57 +02:00
Stacey Gammon
eddbc8db6f
Update doc slugs to improve analytic tracking, move to appropriate folders ( #113630 )
...
* Update the slugs to improve google analytics drilldown tracking
* more slug updates
* Fix some formatting issues in building blocks
* update paths
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-10-04 13:36:45 -04:00
Joe Portner
c21272cc5b
Sharing saved objects developer guide ( #107099 )
2021-08-10 16:02:45 -04:00
Josh Dover
283349ac2b
Add SO migration testing guidance to testing guide ( #105959 )
2021-08-10 10:52:10 -04:00
Stacey Gammon
9fca7a9012
Add saved object docs ( #90860 )
...
* iwp
* add docs on saved objects
* add saved object docs
* Update dev_docs/key_concepts/saved_objects.mdx
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
* Update dev_docs/tutorials/saved_objects.mdx
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
* Update dev_docs/tutorials/saved_objects.mdx
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
* Update dev_docs/tutorials/saved_objects.mdx
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
* Update dev_docs/tutorials/saved_objects.mdx
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
* Update dev_docs/tutorials/saved_objects.mdx
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
* Update dev_docs/tutorials/saved_objects.mdx
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
* review updates
* remove this line, support being added
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
2021-02-11 11:27:46 -05:00
