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

RPM/Yum Installation Enhancements #1020

Merged
merged 26 commits into from
Oct 3, 2022
Merged

RPM/Yum Installation Enhancements #1020

merged 26 commits into from
Oct 3, 2022

Conversation

JeffHuss
Copy link

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

Description

Providing a complete "out of the box experience" guide within the setup instructions.

Issues Resolved

Relates to #789

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@JeffHuss JeffHuss added 2 - In progress Issue/PR: The issue or PR is in progress. backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x v-All This issue is valid for all versions through 1.3 installation Documentation for installing OpenSearch across various platforms backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 labels Aug 29, 2022
@JeffHuss JeffHuss added this to the 2022-Q3 milestone Aug 29, 2022
@JeffHuss JeffHuss self-assigned this Aug 29, 2022
@JeffHuss JeffHuss requested a review from a team as a code owner August 29, 2022 17:53
@JeffHuss JeffHuss marked this pull request as draft August 29, 2022 17:53
@JeffHuss
Copy link
Author

First commit is lazy looking - I just wanted to drop the tarball guide, which is still pending editorial review, in the RPM/Yum doc so I can work through and create a parallel structure. The bulk of the differences will relate to the actual "download/install" steps and the configuration paths.

@hdhalter hdhalter removed v-All This issue is valid for all versions through 1.3 installation Documentation for installing OpenSearch across various platforms labels Sep 9, 2022
JeffH-AWS added 2 commits September 12, 2022 10:12
Signed-off-by: JeffH-AWS <[email protected]>
Signed-off-by: JeffH-AWS <[email protected]>
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
Copy link
Contributor

@cwillum cwillum left a comment

Choose a reason for hiding this comment

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

Looks great. Just one question from me about Steps below (or, above this comment).
Also, when I launch this locally, I see this text below Recommended links:

"– content above this line is generally “complete” and that below this line needs formatted, validated from a technical perspective, and then fit into this guide –"

Is that supposed to be there?

Copy link
Contributor

@alicejw1 alicejw1 left a comment

Choose a reason for hiding this comment

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

Looks great! i only had a couple suggestions.

Signed-off-by: JeffH-AWS <[email protected]>
@JeffHuss JeffHuss added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Sep 30, 2022
@JeffHuss
Copy link
Author

Sent to editorial for review. Editor is currently OoO so it may take some time before they have a chance to look at this.

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@JeffH-AWS Please see my comments and let me know if you have any questions. Thanks!

_opensearch/install/rpm.md Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
_opensearch/install/rpm.md Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
_opensearch/install/rpm.md Outdated Show resolved Hide resolved
@natebower natebower removed the 5 - Editorial review PR: Editorial review in progress label Oct 3, 2022
@JeffHuss JeffHuss merged commit c2fa272 into main Oct 3, 2022
@JeffHuss JeffHuss deleted the rpm-yum-install-steps branch October 3, 2022 16:18
@opensearch-trigger-bot
Copy link
Contributor

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.3 1.3
# Navigate to the new working tree
cd .worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-1020-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c2fa272305653f38865df14021a7a0cb097ccbd0
# Push it to GitHub
git push --set-upstream origin backport/backport-1020-to-1.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-1020-to-1.3.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.0 2.0
# Navigate to the new working tree
cd .worktrees/backport-2.0
# Create a new branch
git switch --create backport/backport-1020-to-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 c2fa272305653f38865df14021a7a0cb097ccbd0
# Push it to GitHub
git push --set-upstream origin backport/backport-1020-to-2.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.0

Then, create a pull request where the base branch is 2.0 and the compare/head branch is backport/backport-1020-to-2.0.

@JeffHuss JeffHuss added the 6 - Done but waiting to merge PR: The work is done and ready to merge label Oct 3, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2022
* Dropped the new tarball guide in here to work off of

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

* Added comment tags to make it even more clear what isn't permanent

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

* Incorporating editorial feedback from tar guide and updated the template here

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

* Overview section added

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

* More changes

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

* Working on download and install steps

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

* Added liquid syntax for major version in yum repo and removed references to dashboards

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

* Finished Install OpenSearch from a package

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

* Added Yum steps

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

* Removed redundant steps

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

* Removed PA plugin references

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

* Added important settings and removed a couple missed dashboards references

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

* Starting work on testing opensearch

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

* Revisions to testing opensearch because security is enabled by default

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

* Wording change

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

* Added a missing step

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

* Wording

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

* Adding testing steps

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

* Removed extra section since security is always enabled out of the box

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

* Added configuration steps and verified functionality

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

* Working through the TLS certs portion and adding content as I vet it

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

* Finalized steps

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

* Final draft before review

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

* Revisions from doc review

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

* Committing editorial fixes

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

Signed-off-by: JeffH-AWS <[email protected]>
(cherry picked from commit c2fa272)
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2022
* Dropped the new tarball guide in here to work off of

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

* Added comment tags to make it even more clear what isn't permanent

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

* Incorporating editorial feedback from tar guide and updated the template here

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

* Overview section added

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

* More changes

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

* Working on download and install steps

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

* Added liquid syntax for major version in yum repo and removed references to dashboards

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

* Finished Install OpenSearch from a package

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

* Added Yum steps

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

* Removed redundant steps

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

* Removed PA plugin references

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

* Added important settings and removed a couple missed dashboards references

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

* Starting work on testing opensearch

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

* Revisions to testing opensearch because security is enabled by default

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

* Wording change

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

* Added a missing step

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

* Wording

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

* Adding testing steps

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

* Removed extra section since security is always enabled out of the box

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

* Added configuration steps and verified functionality

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

* Working through the TLS certs portion and adding content as I vet it

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

* Finalized steps

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

* Final draft before review

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

* Revisions from doc review

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

* Committing editorial fixes

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

Signed-off-by: JeffH-AWS <[email protected]>
(cherry picked from commit c2fa272)
JeffHuss pushed a commit that referenced this pull request Oct 3, 2022
* Dropped the new tarball guide in here to work off of

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

* Added comment tags to make it even more clear what isn't permanent

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

* Incorporating editorial feedback from tar guide and updated the template here

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

* Overview section added

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

* More changes

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

* Working on download and install steps

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

* Added liquid syntax for major version in yum repo and removed references to dashboards

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

* Finished Install OpenSearch from a package

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

* Added Yum steps

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

* Removed redundant steps

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

* Removed PA plugin references

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

* Added important settings and removed a couple missed dashboards references

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

* Starting work on testing opensearch

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

* Revisions to testing opensearch because security is enabled by default

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

* Wording change

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

* Added a missing step

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

* Wording

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

* Adding testing steps

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

* Removed extra section since security is always enabled out of the box

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

* Added configuration steps and verified functionality

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

* Working through the TLS certs portion and adding content as I vet it

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

* Finalized steps

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

* Final draft before review

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

* Revisions from doc review

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

* Committing editorial fixes

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

Signed-off-by: JeffH-AWS <[email protected]>
(cherry picked from commit c2fa272)

Co-authored-by: Jeff Huss <[email protected]>
JeffHuss pushed a commit that referenced this pull request Oct 3, 2022
* Dropped the new tarball guide in here to work off of

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

* Added comment tags to make it even more clear what isn't permanent

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

* Incorporating editorial feedback from tar guide and updated the template here

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

* Overview section added

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

* More changes

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

* Working on download and install steps

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

* Added liquid syntax for major version in yum repo and removed references to dashboards

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

* Finished Install OpenSearch from a package

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

* Added Yum steps

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

* Removed redundant steps

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

* Removed PA plugin references

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

* Added important settings and removed a couple missed dashboards references

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

* Starting work on testing opensearch

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

* Revisions to testing opensearch because security is enabled by default

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

* Wording change

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

* Added a missing step

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

* Wording

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

* Adding testing steps

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

* Removed extra section since security is always enabled out of the box

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

* Added configuration steps and verified functionality

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

* Working through the TLS certs portion and adding content as I vet it

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

* Finalized steps

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

* Final draft before review

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

* Revisions from doc review

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

* Committing editorial fixes

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

Signed-off-by: JeffH-AWS <[email protected]>
(cherry picked from commit c2fa272)

Co-authored-by: Jeff Huss <[email protected]>
@JeffHuss JeffHuss added backport 2.3 PR: Backport label for 2.3 and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Oct 3, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2022
* Dropped the new tarball guide in here to work off of

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

* Added comment tags to make it even more clear what isn't permanent

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

* Incorporating editorial feedback from tar guide and updated the template here

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

* Overview section added

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

* More changes

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

* Working on download and install steps

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

* Added liquid syntax for major version in yum repo and removed references to dashboards

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

* Finished Install OpenSearch from a package

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

* Added Yum steps

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

* Removed redundant steps

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

* Removed PA plugin references

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

* Added important settings and removed a couple missed dashboards references

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

* Starting work on testing opensearch

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

* Revisions to testing opensearch because security is enabled by default

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

* Wording change

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

* Added a missing step

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

* Wording

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

* Adding testing steps

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

* Removed extra section since security is always enabled out of the box

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

* Added configuration steps and verified functionality

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

* Working through the TLS certs portion and adding content as I vet it

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

* Finalized steps

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

* Final draft before review

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

* Revisions from doc review

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

* Committing editorial fixes

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

Signed-off-by: JeffH-AWS <[email protected]>
(cherry picked from commit c2fa272)
ariamarble pushed a commit that referenced this pull request Oct 3, 2022
* Dropped the new tarball guide in here to work off of

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

* Added comment tags to make it even more clear what isn't permanent

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

* Incorporating editorial feedback from tar guide and updated the template here

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

* Overview section added

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

* More changes

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

* Working on download and install steps

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

* Added liquid syntax for major version in yum repo and removed references to dashboards

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

* Finished Install OpenSearch from a package

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

* Added Yum steps

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

* Removed redundant steps

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

* Removed PA plugin references

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

* Added important settings and removed a couple missed dashboards references

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

* Starting work on testing opensearch

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

* Revisions to testing opensearch because security is enabled by default

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

* Wording change

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

* Added a missing step

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

* Wording

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

* Adding testing steps

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

* Removed extra section since security is always enabled out of the box

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

* Added configuration steps and verified functionality

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

* Working through the TLS certs portion and adding content as I vet it

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

* Finalized steps

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

* Final draft before review

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

* Revisions from doc review

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

* Committing editorial fixes

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

Signed-off-by: JeffH-AWS <[email protected]>
(cherry picked from commit c2fa272)

Co-authored-by: Jeff Huss <[email protected]>
Naarcha-AWS pushed a commit that referenced this pull request Oct 6, 2022
* Dropped the new tarball guide in here to work off of

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

* Added comment tags to make it even more clear what isn't permanent

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

* Incorporating editorial feedback from tar guide and updated the template here

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

* Overview section added

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

* More changes

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

* Working on download and install steps

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

* Added liquid syntax for major version in yum repo and removed references to dashboards

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

* Finished Install OpenSearch from a package

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

* Added Yum steps

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

* Removed redundant steps

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

* Removed PA plugin references

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

* Added important settings and removed a couple missed dashboards references

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

* Starting work on testing opensearch

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

* Revisions to testing opensearch because security is enabled by default

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

* Wording change

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

* Added a missing step

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

* Wording

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

* Adding testing steps

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

* Removed extra section since security is always enabled out of the box

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

* Added configuration steps and verified functionality

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

* Working through the TLS certs portion and adding content as I vet it

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

* Finalized steps

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

* Final draft before review

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

* Revisions from doc review

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

* Committing editorial fixes

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

Signed-off-by: JeffH-AWS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants