Skip to content

Add a note about saved object migrations to the kibana setup docs#23251

Closed
chrisdavies wants to merge 2 commits intoelastic:masterfrom
chrisdavies:migrations/docs
Closed

Add a note about saved object migrations to the kibana setup docs#23251
chrisdavies wants to merge 2 commits intoelastic:masterfrom
chrisdavies:migrations/docs

Conversation

@chrisdavies
Copy link
Copy Markdown
Contributor

This PR adds a note about index migrations to the Kibana setup docs. The target for this doc is probably someone in the sys admin role. The goal is to give them a heads up about new log messages they may see when booting up Kibana, and to set some expectations about some edge cases.

I'm not sure exactly how detailed we should get here.

@@ -0,0 +1,16 @@
[[migrations]]
== Kibana index migrations
Copy link
Copy Markdown
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 call this "saved object migrations" instead, to better distance itself from things like generic index management/reindex. Thoughts?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yep. I think that's a valid point.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hm. How about "saved object index migrations"? The reason being, "Only one server will perform saved object migrations." is an incorrect statement, but "Only one server will perform saved object index migrations." is correct.

@epixa
Copy link
Copy Markdown
Contributor

epixa commented Sep 17, 2018

Thanks for creating this so quickly. I want to give this some more thought before we press forward with a merge. It's all good information that I do want to document, but I want to do so in a way that makes it easiest for folks to consume without making them feel like every upgrade of Kibana is super risky.

@elasticmachine
Copy link
Copy Markdown
Contributor

💚 Build Succeeded

@chrisdavies
Copy link
Copy Markdown
Contributor Author

chrisdavies commented Sep 18, 2018

Regarding the "risky" sound of things, I think this paragraph in particular could use some work. I'll wait for your feedback before tweaking, though!

If the Kibana crashes or terminates unexpectedly while migrating an index, Kibana is left in a "pending" state, and will fail to start until the underlying issue is resolved. To get past this, the new index will need to be deleted or renamed so that Kibana can reattempt the index migration.

@chrisdavies
Copy link
Copy Markdown
Contributor Author

One other thing. It's hard to know what Kibana index you should point the .kibana alias to if you want to rollback. (e.g. if the .kibana alias is pointing to .kibana_8, and you want to roll Kibana back to 6.6, should you point .kibana to .kibana_7? Or .kibana_6? You don't know. It's trial-and-error. I wonder if we should store the Kibana version in the index metadata so admins can more easily systematize this?

@elasticmachine
Copy link
Copy Markdown
Contributor

💔 Build Failed

@rayafratkina
Copy link
Copy Markdown
Contributor

@epixa sounds like this is not going into 6.5. Should we clean up version labels?

@epixa
Copy link
Copy Markdown
Contributor

epixa commented Nov 5, 2018

@rayafratkina Docs changes can happen at any time and are not bound by feature freeze. Since this feature is going out in 6.5, it makes sense to backport it to 6.5 docs.

@epixa epixa self-assigned this Nov 5, 2018
@epixa epixa changed the title Add a note about index migrations to the kibana setup docs Add a note about saved object migrations to the kibana setup docs Nov 6, 2018
@spalger spalger added v6.5.1 and removed v6.5.0 labels Nov 9, 2018
@epixa
Copy link
Copy Markdown
Contributor

epixa commented Nov 12, 2018

Closing in favor of #25558

@epixa epixa closed this Nov 12, 2018
@chrisdavies chrisdavies deleted the migrations/docs branch January 16, 2019 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants