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 a guide for upgrading and migrating ES indices #3321

Merged
merged 8 commits into from
Nov 9, 2023
Merged

Add a guide for upgrading and migrating ES indices #3321

merged 8 commits into from
Nov 9, 2023

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Nov 7, 2023

Fixes

Fixes #3314 by @dhruvkb

Description

This PR documents the process for upgrading and migrating ES indices without API downtime. It also adds documentation regarding the ingestion server /task API that the process uses and also documents the process for stopping a reindex job midway in staging.

Testing Instructions

Read the updated documentation.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: documentation Related to Sphinx documentation labels Nov 7, 2023
@dhruvkb dhruvkb requested a review from a team as a code owner November 7, 2023 11:26
@dhruvkb dhruvkb requested review from fcoveram, stacimc and obulat and removed request for fcoveram November 7, 2023 11:26
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Thank you for such detailed and clear documentation, @dhruvkb !

documentation/ingestion_server/guides/migrate.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/migrate.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/migrate.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/migrate.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/troubleshoot.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/upgrade.md Outdated Show resolved Hide resolved
@dhruvkb dhruvkb marked this pull request as draft November 7, 2023 15:11
dhruvkb and others added 2 commits November 7, 2023 20:45
@dhruvkb dhruvkb requested a review from obulat November 7, 2023 17:18
@dhruvkb dhruvkb marked this pull request as ready for review November 7, 2023 17:19
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Awesome 🎉

Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

This is fantastic documentation Dhruv, thank you for taking the time to distill all the steps you took with the recent deployments! I have a few suggestions/improvements, nothing to block a merge 🚀 📓

documentation/ingestion_server/guides/upgrade.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/upgrade.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/upgrade.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/migrate.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/migrate.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/migrate.md Outdated Show resolved Hide resolved
documentation/ingestion_server/guides/troubleshoot.md Outdated Show resolved Hide resolved
@dhruvkb dhruvkb merged commit 57bf632 into main Nov 9, 2023
40 checks passed
@dhruvkb dhruvkb deleted the es_doc branch November 9, 2023 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Write a documentation page for zero-downtime ES index migrations
3 participants