florent-leborgne
e42569dc04
[Docs] Reset release files for 9.0 ( #199519 )
...
This PR resets the release notes, upgrade notes, and what's new for 9.0.
It also cleans up a few references/files that were focusing on migration
to 8.0
Some more PRs will happen to prepare the rest of the docs for v9
Closes: https://github.com/elastic/platform-docs-team/issues/564
2024-11-22 10:24:10 +01:00
Jesus Wahrman
7cb5b4d3cc
[doc] Allow copying as curl for saved object rollback instructions ( #200187 )
...
## Summary
Changed the doc file so it allows to copy as curl.
[Issue](https://github.com/elastic/kibana/issues/198490 )
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-11-18 10:04:20 +01:00
Gerard Soldevila
d4cc182e8a
[Migrations] Upgrade tests to use 9.x compatible archives ( #193696 )
...
## Summary
Part of https://github.com/elastic/kibana-team/issues/1113
Merges some tested code paths into `v2_migration.test.ts` which uses an
archive that is generated in 9.0.0.
Gets rid of the related failing tests.
2024-09-24 05:05:46 -05:00
Rudolf Meijering
befa09285b
[docs] Resolve migration failures: allow copying as curl and remove outdated 7.12 known issue ( #190677 )
...
## Summary
This allows users to copy the documented console commands as curl
commands. Useful since users don't have access to console when there's a
migration failure. I also removed a known 7.12 issue that's no longer
relevant for 8.x users.
Example:
<img width="815" alt="Screenshot 2024-08-19 at 12 48 36"
src="https://github.com/user-attachments/assets/973fe626-7593-4d65-91d3-3c7aab5e9c63 ">
clicking "copy as curl" produces:
```
curl -X PUT "localhost:9200/_security/role/grant_kibana_system_indices?pretty" -H 'Content-Type: application/json' -d'
{
"indices": [
{
"names": [
".kibana*"
],
"privileges": [
"all"
],
"allow_restricted_indices": true
}
]
}
'
```
### Checklist
Delete any items that are not applicable to this PR.
- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing ), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md )
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html )
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html )
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1 ) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/ ))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/ ),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US ))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker )
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server ))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers )
### Risk Matrix
Delete this section if it is not applicable to this PR.
Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.
When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:
| Risk | Probability | Severity | Mitigation/Notes |
|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx ) |
### For maintainers
- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process )
2024-08-20 16:07:52 +02:00
Christiane (Tina) Heiligers
f2aa1faee4
Removes non-backup rollback from upgrade kibana ( #189011 )
...
FIx https://github.com/elastic/kibana/issues/158117
Removes section on rolling back without a snapshot.
The changes made to kibana saved objects migration make the process of
rolling back without a snapshot too complex for customers to do alone.
Furthermore, rolling back without a snapshot is not recommended or
supported.
See the changes on `master`
[here](https://kibana_bk_189011.docs-preview.app.elstc.co/guide/en/kibana/master/upgrade-migrations-rolling-back.html )
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-07-24 14:51:24 +00:00
Gerard Soldevila
70eb9d3ecb
Update saved objects migrations documentation for 8.8.0 ( #158241 )
...
Documentation must reflect changes brought by the [dot kibana
split](https://github.com/elastic/kibana/pull/154888 ).
Our public facing documentation just mentions two indices e.g.
https://www.elastic.co/guide/en/kibana/8.8/saved-object-migrations.html
https://www.elastic.co/guide/en/kibana/8.8/resolve-migrations-failures.html#upgrade-migrations-old-indices
this one in particular mentions that "all other indices are safe to
delete".
2023-05-23 15:53:52 +02:00
Christiane (Tina) Heiligers
049d8021eb
Updates upgrade assistant doclinks to point to current rather than hard-coded 7.17 ( #147585 )
...
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Fix https://github.com/elastic/kibana/issues/145092
2022-12-19 09:19:26 -07:00
Kurt
ba61ce4a2d
Add steps to docs to fix Corrupt Saved Objects ( #143479 )
...
* upgrade mocha to 10.1
2022-10-18 09:47:10 -04:00
Abdon Pijpelink
4bc0cb7cae
[DOCS] Update link to common cluster issues page ( #136965 )
2022-07-22 13:03:39 -04:00
Abdon Pijpelink
da4c898b67
Removed anchor from link to common cluster issues page ( #136378 )
...
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-07-18 17:08:21 +02:00
Rudolf Meijering
d3756a10c1
Update failed migration roll back instructions ( #135006 )
2022-06-29 08:47:33 -04:00
Paul Power
bee025b3c0
Changed a minor error - "to to" to "to" ( #126760 )
...
A minor change, not urgent/important
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-06-23 07:21:30 -04:00
Gerard Soldevila
df5d2c913b
Add migrations.discardCorruptObjects flag ( #132984 )
...
* Add migrations.ignoreUnknownObjects flag
* Misc enhancements following PR comments, fix UTs
* Fix validation
* Make check_for_unknown_docs flag-agnostic. Misc enhancements
* Minor fixes
* Fix UTs
* misc doc updates
* Simplify excludeOnUpgradeQuery helper methods
* Improve unknown type detection, improve e2e tests
* Fix tests
* Simplify queries for unknown types, use "missing:" in agg
* Unify logic from unknown_object_types and check_for_unknown_docs
* Small code enhancements
* Update FTs datasets mappings, ensure saved object type is a "keyword"
* Undo changes in non-related type
* Fix UTs
* Add migrations.discardCorruptObjects flag
* Add migrations.discardCorruptObjects flag
* Fix imports that change with new packages
* Fix imports that change with new packages
* Fix tests
* Update Jest snapshot
* Fix snapshots
* Update ascii docs, revert unwanted mapping update
* Revert to default log output type
* Fix typo [Prebot => Preboot]
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-06-14 09:28:23 +02:00
Gerard Soldevila
ee34153e5b
Add migrations.discardUnknownObjects flag ( #132167 )
...
* Add migrations.ignoreUnknownObjects flag
* Misc enhancements following PR comments, fix UTs
* Fix validation
* Make check_for_unknown_docs flag-agnostic. Misc enhancements
* Minor fixes
* Fix UTs
* misc doc updates
* Simplify excludeOnUpgradeQuery helper methods
* Improve unknown type detection, improve e2e tests
* Fix tests
* Simplify queries for unknown types, use "missing:" in agg
* Unify logic from unknown_object_types and check_for_unknown_docs
* Small code enhancements
* Update FTs datasets mappings, ensure saved object type is a "keyword"
* Undo changes in non-related type
* Fix UTs
* Fix imports that change with new packages
* Rollback unnecessary mapping changes
* Update docs/setup/upgrade/resolving-migration-failures.asciidoc
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
2022-06-02 11:06:07 +02:00
Rudolf Meijering
e79ab079fa
Descriptive logs with docLinks for cluster shard limit exceeded ( #132072 )
...
* Descriptive logs with docLinks for cluster shard limit exceeded
* Integration test for isClusterShardLimitExceeded
* Fix jest test snapshots
* Apply suggestions from code review
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* PR feedback
* PR feedback
* Unit tests for isClusterShardLimitExceeded
* Use constast for repeated strings
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2022-05-16 13:26:58 -07:00
Rudolf Meijering
575c5599a9
Retry INIT step when hitting incompatible_cluster_routing_allocation ( #131809 )
...
* Add reproducing test case
* Fix and add integration test
* Transient settings should take preference
* Rename unsupported_cluster_routing_allocation error to incompatible_cluster_routing_allocation
* Retry INIT when action fails with [incompatible_cluster_routing_allocation]
* Apply suggestions from code review
Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
* Fix archive with trial licence and re-enable skipped test
* Integration test for incompatible cluster routing allocation
* Fix types after renaming UnsupportedClusterRoutingAllocation
* Attempt to fix open handle tests
Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
2022-05-11 08:05:01 -07:00
Christiane (Tina) Heiligers
4b19c72dde
Improve saved objects migrations failure errors and logs ( #131359 )
2022-05-03 18:03:48 -07:00
Christiane (Tina) Heiligers
fb33187270
Adds documentation and improves migrations failing on timeouts while waiting for index yellow status ( #130352 )
...
* reapply docs and doclink changes
* Updates wait_for_index_yellow_status response type on response timeout, updates create_index action and model to account for the changes
* Refactors clone_index action to account for new return type of waitForIndexYellow, updates model
* Updates README
* Updates snapshot
* Updates docs
* Fix import violations
* imports
* Extends the retry log message with an actionable item linking to the docs on every retryable migration action
* Refactor retry_state and model to allow linking to specific subsections in the docs
* Updates resolving saved objects migration failures docs
* Calls waitForIndexStatusYellow directly in actions integration tests
* Deletes comment
* Update src/core/server/saved_objects/migrations/model/retry_state.test.ts
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
2022-04-21 08:11:39 -07:00
gchaps
93cb99db5d
[DOCS] Minor tweaks to upgrade docs ( #125538 )
2022-02-14 09:31:40 -08:00
gchaps
a13dafc7dd
[DOCS] Updates the Upgrade docs ( #125288 )
...
* [DOCS] Adds redirect for Standard Upgrade doc
* [DOCS] Updates Upgrade docs
* [DOCS] Incorporates review comments
* [DOCS] Adds info on saved objects
* [DOCS] Fixes broken link
* [DOCS] Fixes placement of section on unknown saved objects
* [DOCS] Removes duplicate topic
2022-02-10 15:46:58 -08:00
Rudolf Meijering
f3b01b6751
Improve docs for unknown saved object types ( #125253 )
...
* Revert "Revert "Docs for preventing migrations failing for unknown saved object types""
This reverts commit 580d61d990
2022-02-10 15:43:05 -05:00
Rudolf Meijering
580d61d990
Revert "Docs for preventing migrations failing for unknown saved object types"
...
This reverts commit 561d0b798b
2022-02-10 14:19:12 +01:00
Rudolf Meijering
561d0b798b
Docs for preventing migrations failing for unknown saved object types
2022-02-10 14:17:50 +01:00
Kaarina Tungseth
a1a273238e
[DOCS] Updates the 8.0.0 upgrade docs ( #125128 )
...
* [DOCS] Updates the 8.0.0 upgrade docs
* Update docs/setup/upgrade/upgrade-migrations.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Update docs/setup/upgrade/upgrade-migrations.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Update docs/setup/upgrade/upgrade-migrations.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Update docs/setup/upgrade/upgrade-migrations.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Update docs/setup/upgrade/upgrade-migrations.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Update docs/setup/upgrade/upgrade-migrations.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2022-02-09 14:39:17 -06:00
gchaps
5fde0a07e3
[DOCS] Edits to upgrade docs ( #125019 )
...
* [DOCS] Edits to upgrade docs
* Apply suggestions from code review
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-02-09 09:02:48 -08:00
Kaarina Tungseth
f2e9efe457
[DOCS] Adds 8.0.0 release notes ( #124399 )
...
* [DOCS] Adds 8.0.0 release notes
* Update docs/CHANGELOG.asciidoc
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
* Update docs/CHANGELOG.asciidoc
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
2022-02-09 10:15:07 -06:00
gchaps
ca10263ed6
[DOCS] Fixes links in Update docs ( #124892 )
...
* [DOCS] Fixes links in Update docs
* [DOCS] Fixes another formatting error
2022-02-07 14:26:51 -08:00
debadair
35d3c9a277
[DOCS] Synced with stack upgrade changes ( #124744 )
...
* [DOCS] Synced with stack upgrade changes
* Fixed links
* Apply suggestions from code review
Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-02-04 15:54:48 -08:00
James Rodewig
26c8703534
Update snapshot docs for new system index defaults ( #120174 )
...
With https://github.com/elastic/elasticsearch/pull/79670 , you can only include system indices in a snapshot using feature states. This updates some references to taking a snapshots of the `.kibana*` system indices.
Relates to https://github.com/elastic/elasticsearch/pull/81226
2021-12-08 10:26:29 -05:00
Christiane (Tina) Heiligers
9189066b0c
[docs-logging]: move developer/architecture docs to user docs ( #119125 )
...
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-11-24 16:42:28 -05:00
James Rodewig
899a803ca4
[DOCS] Remove snapshot and restore docs ( #114836 )
...
With https://github.com/elastic/elasticsearch/pull/79081 , we now cover Kibana's **Snapshot and Restore** feature in the Elasticsearch docs. This removes and redirects the related docs from Kibana.
It also updates some references to the `.kibana` system indices to include the `kibana` feature state. The `kibana` feature state is now the preferred way to back up and restore system indices and other configuration data for Kibana.
Relates to https://github.com/elastic/elasticsearch/issues/79675
2021-11-16 16:59:24 -05:00
Pierre Gayvallet
106183551a
[8.0] remove kibana.index config property ( #112773 )
...
* remove kibana config
* remove kibanaConfig usages
* prettier fix
* fix some globalConfig.kibana.index access
* fix xpack_legacy globalConfig usage
* fix home globalConfig usage
* fix canvas globalConfig usage
* fix action globalConfig usage
* fix (all?) remaining usages
* fix more plugins
* fix more plugins bis
* yet more usages
* fix ml usages
* fix security_solution
* fix lens
* fix monitoring
* remove from settings docs
* move doc update
* fix unit tests
* update generated doc
* improve test
* adapt new usage in security_solution
* fix security_solution config
* fix createConfig, again
* fix mock config
2021-10-25 14:25:24 -07:00
Luke Elmers
bd2215f587
[docs][migrations v2] Update SO migration docs to include removal of index write block when handling corrupt SOs. ( #103014 )
2021-06-24 15:46:19 -07:00
Rudolf Meijering
6fa23eb619
Add docs for v2 migration timeouts related to fleet-agent-events ( #95370 )
2021-04-07 16:14:26 +02:00
Rudolf Meijering
11f84bb61b
More detailed instructions for deleting corrupt saved object documents ( #95046 )
...
* More detailed instructions for deleting corrupt saved object documents
* Update docs/setup/upgrade/upgrade-migrations.asciidoc
Co-authored-by: Luca Belluccini <luca.belluccini@elastic.co>
Co-authored-by: Luca Belluccini <luca.belluccini@elastic.co>
2021-03-30 12:28:56 +02:00
Rudolf Meijering
f732b2c3c5
Fix rendering of Saved object indices and aliases per {kib} version table ( #89700 )
...
Collapsing rows and applying vertical alignment doesn't work well when published to the docs website. So I removed the last column.
2021-01-29 15:59:17 +01:00
Rudolf Meijering
eed9383969
Migrations v2 docs ( #88820 )
...
* Migrations v2 docs
* Not all kibana distributions automatically restarted a killed process
* Mention that we add a write block to the outdated index
* Formating: collapse three notes into a single note with three bullet points
* Update docs/setup/upgrade/upgrade-standard.asciidoc
Co-authored-by: Josh Dover <1813008+joshdover@users.noreply.github.com>
* Add table of outdated / upgraded indices per version of Kibana
* Review feedback: separate section for multi-instance upgrade migrations
* Review feedback: link to saved objects management
* Review feedback: stronger wording for not deleting any indices
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Josh Dover <1813008+joshdover@users.noreply.github.com>
2021-01-25 15:36:48 +01:00
Rudolf Meijering
d2a5ebd1fc
[docs] Resolving failed Kibana upgrade migrations ( #80999 )
...
* Resolving failed Kibana upgrade migrations
* Move warning against rolling upgrades into upgrade-standard and call out stopping all instances in specific upgrade steps
* Add preventing migration failures section
* Add incompatible xpack.tasks.index: .tasks setting to preventing migration failures
* Fix link
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2020-10-27 17:31:36 +01:00
gchaps
56ed61e303
[DOCS] Edits titles in Setup section for consistency ( #68451 )
...
* [DOCS] Fixes titles in Setup section for consistency
* [DOCS] Fixes to titles and orders of docs in Set up
2020-06-08 14:46:26 -07:00
gchaps
75444a9f18
[DOCS] Adds note to troubleshooting migration topic ( #46815 )
2019-09-27 09:31:00 -07:00
Sarah Hersh
73c68b8e0b
[DOCS] Updates 7.0 upgrade guide ( #34121 ) ( #34346 )
2019-04-03 14:50:47 -04:00
Court Ewing
c48cea9265
[DOCS] Saved object migrations ( #25558 )
...
* Add a note about index migrations to the kibana setup docs
* Tewak the migrations asciidocs for clarity
* docs: refine saved object migration details
Breaking down the migration process into sections helps people find
and link to relevant information more easily.
The focus is on ongoing maintenance of Kibana, whereas the initial new
experience in 6.5.0 is treated as a note of clarification.
Error handling should be expanded in the future to include details about
specific known error cases.
2018-11-13 18:38:10 -05:00
Lisa Cawley
42af0fcde9
[DOCS] Added monitoring upgrade details ( #17138 )
2018-03-14 13:18:53 -07:00
Lisa Cawley
e21a133e00
[DOCS] Update Kibana Guide to use shared attributes ( #12505 )
...
* [DOCS] Update Kibana Guide to use shared attributes
* [DOCS] Add docs repository path
2017-06-27 10:13:42 -07:00
gmarnin
19db0a95fe
Fixed Kinana typo ( #8901 )
2016-11-01 11:17:46 -07:00
Court Ewing
ccc2c7737e
docs: More comprehensive upgrade docs for 5.0+
...
These changes include all three known upgrade scenarios:
1. New installation (K3 -> K5)
2. Standard upgrade (K4.2 -> K5)
3. Standard upgrade with reindex (K4.1 -> K5)
2016-10-25 12:24:24 -04:00
