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

Document retired node replacement in ES #4326

Merged
merged 6 commits into from
May 24, 2024
Merged

Conversation

zackkrida
Copy link
Member

Description

This PR documents the procedure to follow for replacing a retired Elasticsearch node in our custom, self-managed Elasticsearch cluster.

Testing Instructions

Review the plan and make sure the instructions are clear.

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 (just catalog/generate-docs for catalog
    PRs) or the media properties generator (just catalog/generate-docs media-props
    for the catalog or just api/generate-docs for the API) where 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.

@zackkrida zackkrida requested a review from a team as a code owner May 14, 2024 16:15
@github-actions github-actions bot added the 🧱 stack: documentation Related to Sphinx documentation label May 14, 2024
@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label May 14, 2024
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/4326

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

Changed files 🔄:

@zackkrida zackkrida 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 and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels May 15, 2024
Copy link
Contributor

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

Thanks for adding this documentation! It all makes sense, just a few small notes.

documentation/meta/maintenance/elasticsearch_cluster.md Outdated Show resolved Hide resolved
documentation/meta/maintenance/elasticsearch_cluster.md Outdated Show resolved Hide resolved
documentation/meta/maintenance/elasticsearch_cluster.md Outdated Show resolved Hide resolved
@zackkrida zackkrida marked this pull request as draft May 16, 2024 21:59
@zackkrida
Copy link
Member Author

zackkrida commented May 16, 2024

Drafting this PR while I:

  • Make adjustments to the specific deployment process
  • Reconsider it's existence; this might be better suited as an ansible playbook in the infra repository

@AetherUnbound
Copy link
Contributor

@zackkrida Since the node replacement is complete, do you think we can undraft this? Even if we eventually move this to a playbook, it'd be good to have the documentation in the meantime just in case, IMO!

@zackkrida zackkrida marked this pull request as ready for review May 23, 2024 19:01
@zackkrida
Copy link
Member Author

@AetherUnbound it's updated, undrafted, and ready for review 😄

Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@zackkrida do you plan to create an issue to convert this to a playbook (with prompts as we discussed)? I think that's a good idea, and a fine interim solution for this until we can fix how we deploy Elasticsearch.

@zackkrida zackkrida merged commit 6e8d0bf into main May 24, 2024
42 checks passed
@zackkrida zackkrida deleted the document-es-node-replacement branch May 24, 2024 15:53
@zackkrida
Copy link
Member Author

@sarayourfriend issue here https://github.com/WordPress/openverse-infrastructure/issues/911

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.

None yet

5 participants