Add steps for upgrading OpenSearch with Security enabled (#3052) (#3412)

* Adding appendix that I want to use for reading aids or additional context for the user and reader * Saving - trying to multitask and follow a migrations workshop so not a lot of progress should be expected today * Working on splitting up the content * Sanitized example commands * Added intro blurb to the appendix - I will revisit the wording after the doc grows a bit to see how much sense it makes * Redid headers and added cross-link * Changed headings again to make them simpler * Expanding on intro and starting to add steps * Removed disclaimer about prerequisite skills since I backed-off with the specifics in this guide * Adding more context to the overview * Added more details to the snapshot recommendation including links to the supported repository solutions * Wording changes in appendix * Adding process steps and testing the copy html button function - so far so good as long as indentation is correct * Stashing changes because I need to get the script uploaded to the repo so I can make sure the permalink works * Working out steps * Added one-liner for resetting the environment * Added one-liner for resetting the environment * Adding more steps * Still adding * Reorganizing the page layout * Improving landing page * Breaking up the content for sustainability * Phrasing * Clip index page to keep it concise - I think Jekyll will automatically add a related articles section since it has_children is true * Clean up environment * Clean up environment * Testing out codeblock labels * Stashing changes while I pull down a remote branch for a PR review * Adding steps * Continuing to build out process and added code block labels to improve readability * Stashing to check another branch for PR review * Continuing to add steps * Added headings to backups section so I can link the bullet list * Adding steps and cleaning up sections for readability * Completed some additional research on security and started adding steps with commentary * Wrapping up security settings backup procedure * Stashing changes * Upgrade steps * Adding upgrade steps * Added final steps to the actual upgrade procedure * Added steps for upgrading OpenSearch Dashboards * Almost forgot to re-enabled shard replica allocation * Wrapped up first part of validation and working on next * Adding more checks * Finished adding steps which completes first draft now starting a first round review of the doc * Fixed typo * Reordering of intro and removal of a tip box in favor of just adding to the existing sentences * Further trimmed intro and removed the other box * Fixed wording in intro * Fixed wording and ordering in set up the environment * Revisions * Gerunds * Cleaning up phrasing * Added tip about curl * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Make wording more reader-friendly and informative * Make wording more reader-friendly and informative * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Edits * Doc review edits * Changed h1 and title to sentence case per other review comments * Implementing review feedback on h2 header * Making gerunds * Editorial fixes * Editorial fixes * Editorial fixes * Editorial fixes * Editorial fixes * Editorial fixes * Editorial fixes * Editorial fixes * Editorial fixes * Editorial fixes * Final editorial changes * Final editorial changes --------- (cherry picked from commit 9fd6cf9) Signed-off-by: JeffH-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Mar 10, 2023 · d66b0ec · d66b0ec
1 parent 4b01049
commit d66b0ec
Show file tree

Hide file tree

Showing 4 changed files with 973 additions and 38 deletions.
diff --git a/_install-and-configure/upgrade-opensearch/appendix/index.md b/_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}