Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update saved objects migrations documentation for 8.8.0 #158241

Merged
merged 2 commits into from
May 23, 2023

Conversation

gsoldevila
Copy link
Contributor

@gsoldevila gsoldevila commented May 23, 2023

Documentation must reflect changes brought by the dot kibana split.

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".

@gsoldevila gsoldevila added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:skip Skip the PR/issue when compiling release notes documentation Feature:Migrations backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.8.0 v8.9.0 labels May 23, 2023
@gsoldevila gsoldevila requested review from gchaps and a team May 23, 2023 09:35
@github-actions
Copy link
Contributor

Documentation preview:

@gsoldevila gsoldevila marked this pull request as ready for review May 23, 2023 10:41
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@@ -8,34 +8,66 @@ To access the assistant, go to *Stack Management > Upgrade Assistant*.

WARNING: {kib} 7.12.0 and later uses a new migration process and index naming scheme. Before you upgrade, read the documentation for your version of {kib}.

WARNING: The following instructions assumes {kib} is using the default index names. If the `kibana.index` or `xpack.tasks.index` configuration settings are different from the default, adapt the instructions accordingly.
WARNING: The `kibana.index` and `xpack.tasks.index` configuration settings are obsolete and no longer taken into account in 8.x. If you are using custom index names, please perform the necessary adaptations before attempting to upgrade to 8.x.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove this warning completely because if you have these config values Kibana will fail to start and there's a separate breaking change notification about this. But it might make sense to do that as a separate PR that we backport to all 8.x versions

@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 23, 2023
Documentation must reflect changes brought by the [dot kibana
split](elastic#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".

(cherry picked from commit 70eb9d3)
kibanamachine added a commit that referenced this pull request May 23, 2023
… (#158270)

# Backport

This will backport the following commits from `main` to `8.8`:
- [Update saved objects migrations documentation for 8.8.0
(#158241)](#158241)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Gerard
Soldevila","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-05-23T13:53:52Z","message":"Update
saved objects migrations documentation for 8.8.0
(#158241)\n\nDocumentation must reflect changes brought by the [dot
kibana\r\nsplit](https://github.com/elastic/kibana/pull/154888).\r\n\r\nOur
public facing documentation just mentions two indices
e.g.\r\n\r\nhttps://www.elastic.co/guide/en/kibana/8.8/saved-object-migrations.html\r\n\r\nhttps://www.elastic.co/guide/en/kibana/8.8/resolve-migrations-failures.html#upgrade-migrations-old-indices\r\nthis
one in particular mentions that \"all other indices are safe
to\r\ndelete\".","sha":"70eb9d3ecbb11768d091fca385bad4f20960deef","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","documentation","Feature:Migrations","backport:prev-minor","v8.8.0","v8.9.0","v8.8.1"],"number":158241,"url":"https://github.com/elastic/kibana/pull/158241","mergeCommit":{"message":"Update
saved objects migrations documentation for 8.8.0
(#158241)\n\nDocumentation must reflect changes brought by the [dot
kibana\r\nsplit](https://github.com/elastic/kibana/pull/154888).\r\n\r\nOur
public facing documentation just mentions two indices
e.g.\r\n\r\nhttps://www.elastic.co/guide/en/kibana/8.8/saved-object-migrations.html\r\n\r\nhttps://www.elastic.co/guide/en/kibana/8.8/resolve-migrations-failures.html#upgrade-migrations-old-indices\r\nthis
one in particular mentions that \"all other indices are safe
to\r\ndelete\".","sha":"70eb9d3ecbb11768d091fca385bad4f20960deef"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/158241","number":158241,"mergeCommit":{"message":"Update
saved objects migrations documentation for 8.8.0
(#158241)\n\nDocumentation must reflect changes brought by the [dot
kibana\r\nsplit](https://github.com/elastic/kibana/pull/154888).\r\n\r\nOur
public facing documentation just mentions two indices
e.g.\r\n\r\nhttps://www.elastic.co/guide/en/kibana/8.8/saved-object-migrations.html\r\n\r\nhttps://www.elastic.co/guide/en/kibana/8.8/resolve-migrations-failures.html#upgrade-migrations-old-indices\r\nthis
one in particular mentions that \"all other indices are safe
to\r\ndelete\".","sha":"70eb9d3ecbb11768d091fca385bad4f20960deef"}}]}]
BACKPORT-->

Co-authored-by: Gerard Soldevila <[email protected]>
delanni pushed a commit to delanni/kibana that referenced this pull request May 25, 2023
Documentation must reflect changes brought by the [dot kibana
split](elastic#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".
@rudolf rudolf added the Epic:ScaleMigrations Scale upgrade migrations to millions of saved objects label Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) documentation Epic:ScaleMigrations Scale upgrade migrations to millions of saved objects Feature:Migrations release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.8.0 v8.8.1 v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants