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

Add more details to Upgrade assistant API docs #63862

Closed
LeeDr opened this issue Apr 17, 2020 · 3 comments
Closed

Add more details to Upgrade assistant API docs #63862

LeeDr opened this issue Apr 17, 2020 · 3 comments
Labels
bug Fixes for quality problems that affect the customer experience Feature:Upgrade Assistant needs_docs Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more

Comments

@LeeDr
Copy link

LeeDr commented Apr 17, 2020

Kibana version: 7.7.0

Elasticsearch version: 7.7.0

Describe the bug: Upgrade assistant API docs should describe more details.
https://www.elastic.co/guide/en/kibana/7.7/upgrade-assistant-api.html

  1. They should say that your original index will be deleted at the end of the reindexing and that an alias will be created with the original index name and pointing to the new index.

  2. Does the index get locked for writes, and/or reads during the reindex? Maybe the Kibana reindex API uses an underlying Elasticsearch reindex API and these details are covered there? A user might assume they can continue writing and reading from the index during the reindex and that the replacement of the original index with the alias is atomic. I don't know if that's true or not.

  3. Our APIs should document what privileges are required. This is a pretty widespread problem and doesn't have to be addressed as part of this issue. This operation might typically be performed by a superuser even if we documented specific privs required.

@LeeDr LeeDr added bug Fixes for quality problems that affect the customer experience Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more Feature:Upgrade Assistant needs_docs labels Apr 17, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/es-ui (Team:Elasticsearch UI)

@cjcenizal
Copy link
Contributor

@yuliacech Could you please review this and close if it's been addressed by #112960? If there are any outstanding details that weren't included in that PR, would you mind addressing them in a followup? Thanks!

@yuliacech
Copy link
Contributor

Closing this issue as we addressed comments 1 and 2 in #112960. The privileges needed to use Upgrade Assistant are also already listed in these docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Feature:Upgrade Assistant needs_docs Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Development

No branches or pull requests

4 participants