Jeff Huss 9fd6cf9caf
Add steps for upgrading OpenSearch with Security enabled (#3052)
* Adding appendix that I want to use for reading aids or additional context for the user and reader

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Saving - trying to multitask and follow a migrations workshop so not a lot of progress should be expected today

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working on splitting up the content

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Sanitized example commands

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added intro blurb to the appendix - I will revisit the wording after the doc grows a bit to see how much sense it makes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Redid headers and added cross-link

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changed headings again to make them simpler

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Expanding on intro and starting to add steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Removed disclaimer about prerequisite skills since I backed-off with the specifics in this guide

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding more context to the overview

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added more details to the snapshot recommendation including links to the supported repository solutions

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Wording changes in appendix

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding process steps and testing the copy html button function - so far so good as long as indentation is correct

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Stashing changes because I need to get the script uploaded to the repo so I can make sure the permalink works

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Working out steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added one-liner for resetting the environment

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added one-liner for resetting the environment

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding more steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Still adding

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Reorganizing the page layout

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Improving landing page

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Breaking up the content for sustainability

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Phrasing

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Clip index page to keep it concise - I think Jekyll will automatically add a related articles section since it has_children is true

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Clean up environment

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Clean up environment

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Testing out codeblock labels

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Stashing changes while I pull down a remote branch for a PR review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing to build out process and added code block labels to improve readability

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Stashing to check another branch for PR review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Continuing to add steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added headings to backups section so I can link the bullet list

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding steps and cleaning up sections for readability

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Completed some additional research on security and started adding steps with commentary

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Wrapping up security settings backup procedure

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Stashing changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Upgrade steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding upgrade steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added final steps to the actual upgrade procedure

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added steps for upgrading OpenSearch Dashboards

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Almost forgot to re-enabled shard replica allocation

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Wrapped up first part of validation and working on next

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding more checks

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finished adding steps which completes first draft now starting a first round review of the doc

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed typo

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Reordering of intro and removal of a tip box in favor of just adding to the existing sentences

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Further trimmed intro and removed the other box

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed wording in intro

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed wording and ordering in set up the environment

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Revisions

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Gerunds

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Cleaning up phrasing

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added tip about curl

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Make wording more reader-friendly and informative

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Make wording more reader-friendly and informative

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Doc review edits

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changed h1 and title to sentence case per other review comments

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Implementing review feedback on h2 header

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Making gerunds

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final editorial changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final editorial changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

---------

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2023-03-10 13:43:20 -08:00

1.4 KiB

layout title parent has_children nav_order redirect_from
default Upgrades appendix Upgrading OpenSearch true 30
/upgrade-opensearch/appendix/

Upgrades appendix

Use the upgrades appendix to find additional supporting documentation, such as labs that include example API requests and configuration files to supplement the related process documentation. Specific procedures outlined in the appendix section can be used in a variety of ways:

  • New OpenSearch users can use the steps and example resources we provide to learn about configuring and using OpenSearch and OpenSearch Dashboards.
  • System administrators who work with OpenSearch clusters can use the examples we provide to simulate cluster maintenance in a test environment before applying any changes to a production workload.

If you would like to request a specific topic, please comment on issue #2830 in the OpenSearch Project on GitHub.

The specific commands included in this appendix serve as examples of interacting with the OpenSearch API, and the underlying host, in order to demonstrate the steps described in the related upgrade process documents. The intention is not to be overly prescriptive but instead to add context for users who are new to OpenSearch and want to see practical examples. {:.note}