Add RPM installation instructions #532

Naarcha-AWS · 2022-04-27T19:30:05Z

Signed-off-by: Naarcha-AWS naarcha@amazon.com

Description

Adds installation instructions for RPM through manual and YUM install.

Issues Resolved

Closes #511

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.

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

peterzhuamazon

A lot of comment I give here, thanks.

_opensearch/install/rpm.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

_opensearch/install/rpm.md

alicejw1

LGTM, added some minor in-line suggestions

_opensearch/install/rpm.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

_opensearch/install/rpm.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Naarcha-AWS · 2022-05-03T21:34:44Z

@natebower: This PR is ready for Editorial Review.

_opensearch/install/rpm.md

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

natebower

Please see my suggested changes and let me know if you have any questions. Thanks!

natebower · 2022-05-04T13:19:55Z

_opensearch/install/rpm.md

+
+# RPM
+
+The RPM Package Manager (RPM) installation provides everything you need to run OpenSearch inside Red Hat or Red Hat-based Linux Distributions.  


The hyphen in "Hat-based" should technically be an en dash ("Hat–based"), as it applies to both words in the proper noun, but we can't hyphenate the proper noun. Also, please lowercase "distributions."

natebower · 2022-05-04T13:26:46Z

_opensearch/install/rpm.md

+
+The RPM Package Manager (RPM) installation provides everything you need to run OpenSearch inside Red Hat or Red Hat-based Linux Distributions.  
+
+RPM supports CentOS 7 and 8, and Amazon Linux 2. If you have your own Java installation and set `JAVA_HOME` in your terminal application, macOS works, as well.


Please remove the comma following "8" and the comma following "works".

natebower · 2022-05-04T13:27:52Z

_opensearch/install/rpm.md

+
+RPM supports CentOS 7 and 8, and Amazon Linux 2. If you have your own Java installation and set `JAVA_HOME` in your terminal application, macOS works, as well.
+
+There are two methods for installing OpenSearch on RPM: 


It looks like the colon here should actually be a period, as the sentence does not directly introduce a list but rather introduces a heading. Or it might even be better to provide the two methods after the colon ("There are two methods for installing OpenSearch on RPM: manually or by using YUM.").

natebower · 2022-05-04T13:33:40Z

_opensearch/install/rpm.md

+## Manual method
+
+
+1. Download the RPM package directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}. The RPM package can be download both as `x64` and `arm64`. 


Please change the second instance of "download" to "downloaded".

natebower · 2022-05-04T13:35:45Z

_opensearch/install/rpm.md

+
+1. Download the RPM package directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}. The RPM package can be download both as `x64` and `arm64`. 
+
+2. Import the public GPG key. This key verifies that the your OpenSearch instance is signed.


Should we define "GPG"? Please delete "the" in the second sentence (should just be "that your OpenSearch".

natebower · 2022-05-04T13:40:39Z

_opensearch/install/rpm.md

+
+   To verify that the repos appear in your repo list, use `sudo yum repolist`.
+
+2. Clean your YUM cache, to ensure a smooth installation:


Please remove the comma following "cache".

natebower · 2022-05-04T13:43:33Z

_opensearch/install/rpm.md

+   sudo yum clean all
+   ```
+
+3. With the repository file downloaded, list all available versions of OpenSearch:


I suggest changing "repository" to "repo," as you switched to this usage in the last instance.

natebower · 2022-05-04T13:44:37Z

_opensearch/install/rpm.md

+
+   Unless otherwise indicated, the highest minor version of OpenSearch installs.
+
+   To install a specific version of OpenSearch:


Should this be a complete sentence?

natebower · 2022-05-04T13:46:14Z

_opensearch/install/rpm.md

+
+## Run OpenSearch
+
+1. Run OpenSearch and OpenSearch Dashboards using `systemctl`.


It looks like this step should end in a colon rather than a period.

Naarcha-AWS added 3 commits April 27, 2022 14:28

Add RPM installation instructions

99a87a3

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Add more accurante instructions

6bb7bbd

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

fix typo

0ba789a

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

peterzhuamazon mentioned this pull request May 3, 2022

[RELEASE] Release version 2.0.0 (RC1) opensearch-project/opensearch-build#1624

Closed

51 tasks

Naarcha-AWS added 2 commits May 3, 2022 11:27

Fix typos, part deux

82e642a

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Add more specific intro

6f2b8b9

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

alicejw1 self-requested a review May 3, 2022 16:29

Naarcha-AWS marked this pull request as ready for review May 3, 2022 16:42

Naarcha-AWS requested a review from a team as a code owner May 3, 2022 16:42

Fix formatting

64741ac

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

peterzhuamazon requested changes May 3, 2022

View reviewed changes

Naarcha-AWS added 3 commits May 3, 2022 13:07

Add Peter's feedback

4a7d99a

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Add sudo to commands. Remove PA custom section

3b6e105

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

More review feedback

a6cc676

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Naarcha-AWS requested a review from peterzhuamazon May 3, 2022 19:09

alicejw1 reviewed May 3, 2022

View reviewed changes

_opensearch/install/rpm.md Outdated Show resolved Hide resolved

alicejw1 reviewed May 3, 2022

View reviewed changes

_opensearch/install/rpm.md Outdated Show resolved Hide resolved

alicejw1 reviewed May 3, 2022

View reviewed changes

_opensearch/install/rpm.md Show resolved Hide resolved

alicejw1 reviewed May 3, 2022

View reviewed changes

_opensearch/install/rpm.md Outdated Show resolved Hide resolved

alicejw1 approved these changes May 3, 2022

View reviewed changes

peterzhuamazon reviewed May 3, 2022

View reviewed changes

_opensearch/install/rpm.md Outdated Show resolved Hide resolved

Add additional feedback.

f683c01

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Naarcha-AWS requested a review from peterzhuamazon May 3, 2022 21:04

peterzhuamazon reviewed May 3, 2022

View reviewed changes

_opensearch/install/rpm.md Outdated Show resolved Hide resolved

Last update

33656ea

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Naarcha-AWS requested a review from peterzhuamazon May 3, 2022 21:14

peterzhuamazon approved these changes May 3, 2022

View reviewed changes

lizsnyder self-requested a review May 3, 2022 21:39

lizsnyder approved these changes May 3, 2022

View reviewed changes

lizsnyder reviewed May 3, 2022

View reviewed changes

_opensearch/install/rpm.md Outdated Show resolved Hide resolved

One last typo

6c7a814

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

Naarcha-AWS merged commit 009ef9f into main May 3, 2022

natebower reviewed May 4, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RPM installation instructions #532

Add RPM installation instructions #532

Naarcha-AWS commented Apr 27, 2022

peterzhuamazon left a comment

alicejw1 left a comment

Naarcha-AWS commented May 3, 2022

natebower left a comment

natebower May 4, 2022

natebower May 4, 2022

natebower May 4, 2022

natebower May 4, 2022

natebower May 4, 2022

natebower May 4, 2022

natebower May 4, 2022

natebower May 4, 2022

natebower May 4, 2022


		# RPM

		The RPM Package Manager (RPM) installation provides everything you need to run OpenSearch inside Red Hat or Red Hat-based Linux Distributions.


		The RPM Package Manager (RPM) installation provides everything you need to run OpenSearch inside Red Hat or Red Hat-based Linux Distributions.

		RPM supports CentOS 7 and 8, and Amazon Linux 2. If you have your own Java installation and set `JAVA_HOME` in your terminal application, macOS works, as well.


		RPM supports CentOS 7 and 8, and Amazon Linux 2. If you have your own Java installation and set `JAVA_HOME` in your terminal application, macOS works, as well.

		There are two methods for installing OpenSearch on RPM:

		## Manual method


		1. Download the RPM package directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}. The RPM package can be download both as `x64` and `arm64`.


		1. Download the RPM package directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}. The RPM package can be download both as `x64` and `arm64`.

		2. Import the public GPG key. This key verifies that the your OpenSearch instance is signed.


		To verify that the repos appear in your repo list, use `sudo yum repolist`.

		2. Clean your YUM cache, to ensure a smooth installation:


		Unless otherwise indicated, the highest minor version of OpenSearch installs.

		To install a specific version of OpenSearch:


		## Run OpenSearch

		1. Run OpenSearch and OpenSearch Dashboards using `systemctl`.

Add RPM installation instructions #532

Add RPM installation instructions #532

Conversation

Naarcha-AWS commented Apr 27, 2022

Description

Issues Resolved

peterzhuamazon left a comment

Choose a reason for hiding this comment

alicejw1 left a comment

Choose a reason for hiding this comment

Naarcha-AWS commented May 3, 2022

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment