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 <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Working on splitting up the content

Signed-off-by: JeffH-AWS <[email protected]>

* Sanitized example commands

Signed-off-by: JeffH-AWS <[email protected]>

* 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 <[email protected]>

* Redid headers and added cross-link

Signed-off-by: JeffH-AWS <[email protected]>

* Changed headings again to make them simpler

Signed-off-by: JeffH-AWS <[email protected]>

* Expanding on intro and starting to add steps

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Adding more context to the overview

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Wording changes in appendix

Signed-off-by: JeffH-AWS <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* Working out steps

Signed-off-by: JeffH-AWS <[email protected]>

* Added one-liner for resetting the environment

Signed-off-by: JeffH-AWS <[email protected]>

* Added one-liner for resetting the environment

Signed-off-by: JeffH-AWS <[email protected]>

* Adding more steps

Signed-off-by: JeffH-AWS <[email protected]>

* Still adding

Signed-off-by: JeffH-AWS <[email protected]>

* Reorganizing the page layout

Signed-off-by: JeffH-AWS <[email protected]>

* Improving landing page

Signed-off-by: JeffH-AWS <[email protected]>

* Breaking up the content for sustainability

Signed-off-by: JeffH-AWS <[email protected]>

* Phrasing

Signed-off-by: JeffH-AWS <[email protected]>

* 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 <[email protected]>

* Clean up environment

Signed-off-by: JeffH-AWS <[email protected]>

* Clean up environment

Signed-off-by: JeffH-AWS <[email protected]>

* Testing out codeblock labels

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Adding steps

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Stashing to check another branch for PR review

Signed-off-by: JeffH-AWS <[email protected]>

* Continuing to add steps

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Adding steps and cleaning up sections for readability

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Wrapping up security settings backup procedure

Signed-off-by: JeffH-AWS <[email protected]>

* Stashing changes

Signed-off-by: JeffH-AWS <[email protected]>

* Upgrade steps

Signed-off-by: JeffH-AWS <[email protected]>

* Adding upgrade steps

Signed-off-by: JeffH-AWS <[email protected]>

* Added final steps to the actual upgrade procedure

Signed-off-by: JeffH-AWS <[email protected]>

* Added steps for upgrading OpenSearch Dashboards

Signed-off-by: JeffH-AWS <[email protected]>

* Almost forgot to re-enabled shard replica allocation

Signed-off-by: JeffH-AWS <[email protected]>

* Wrapped up first part of validation and working on next

Signed-off-by: JeffH-AWS <[email protected]>

* Adding more checks

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Fixed typo

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Further trimmed intro and removed the other box

Signed-off-by: JeffH-AWS <[email protected]>

* Fixed wording in intro

Signed-off-by: JeffH-AWS <[email protected]>

* Fixed wording and ordering in set up the environment

Signed-off-by: JeffH-AWS <[email protected]>

* Revisions

Signed-off-by: JeffH-AWS <[email protected]>

* Gerunds

Signed-off-by: JeffH-AWS <[email protected]>

* Cleaning up phrasing

Signed-off-by: JeffH-AWS <[email protected]>

* Added tip about curl

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Make wording more reader-friendly and informative

Signed-off-by: JeffH-AWS <[email protected]>

* Make wording more reader-friendly and informative

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Edits

Signed-off-by: JeffH-AWS <[email protected]>

* Doc review edits

Signed-off-by: JeffH-AWS <[email protected]>

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

Signed-off-by: JeffH-AWS <[email protected]>

* Implementing review feedback on h2 header

Signed-off-by: JeffH-AWS <[email protected]>

* Making gerunds

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Final editorial changes

Signed-off-by: JeffH-AWS <[email protected]>

* Final editorial changes

Signed-off-by: JeffH-AWS <[email protected]>

---------

Signed-off-by: JeffH-AWS <[email protected]>
(cherry picked from commit 9fd6cf9)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

_install-and-configure/upgrade-opensearch/appendix/index.md

@@ -0,0 +1,21 @@
+---
+layout: default
+title: Upgrades appendix
+parent: Upgrading OpenSearch
+has_children: true
+nav_order: 30
+redirect_from:
+  - /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](https://github.com/opensearch-project/documentation-website/issues/2830) in the [OpenSearch Project](https://github.com/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}