Skip to content

Commit 851c523

Browse files
author
Jeff Huss
authored
Clean up RPM/YUM installation guide (opensearch-project#2371)
* Cleaning up Signed-off-by: JeffH-AWS <[email protected]> * Cleaning up Signed-off-by: JeffH-AWS <[email protected]> * Cleaning up Signed-off-by: JeffH-AWS <[email protected]> Signed-off-by: JeffH-AWS <[email protected]>
1 parent 2587360 commit 851c523

File tree

1 file changed

+11
-38
lines changed
  • _install-and-configure/install-opensearch

1 file changed

+11
-38
lines changed

_install-and-configure/install-opensearch/rpm.md

Lines changed: 11 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ Installing OpenSearch using RPM Package Manager (RPM) simplifies the process con
1818
Generally speaking, installing OpenSearch from the RPM distribution can be broken down into a few steps:
1919

2020
1. **Download and install OpenSearch.**
21-
- Install manually from an RPM distribution or by creating a local YUM repository.
22-
1. **Configure important system settings.**
23-
- These settings are applied to the host before modifying any OpenSearch files.
21+
- Install manually from an RPM package or from a YUM repository.
2422
1. **(Optional) Test OpenSearch.**
2523
- Confirm that OpenSearch is able to run before you apply any custom configuration.
2624
- This can be done without any security (no password, no certificates) or with a demo security configuration that can be applied by a packaged script.
@@ -42,17 +40,16 @@ This guide assumes that you are comfortable working from the Linux command line
4240
sudo rpm --import https://artifacts.opensearch.org/publickeys/opensearch.pgp
4341
```
4442
1. From the CLI, you can install the package with `rpm` or `yum`.
45-
**x64**
4643
```bash
4744
# Install the x64 package using yum.
4845
sudo yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
46+
4947
# Install the x64 package using rpm.
5048
sudo rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
51-
```
52-
**arm64**
53-
```bash
49+
5450
# Install the arm64 package using yum.
5551
sudo yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
52+
5653
# Install the arm64 package using rpm.
5754
sudo rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
5855
```
@@ -69,22 +66,22 @@ This guide assumes that you are comfortable working from the Linux command line
6966
sudo systemctl status opensearch
7067
```
7168

72-
### Install OpenSearch from a local YUM repository
69+
### Install OpenSearch from a YUM repository
7370

7471
YUM, the primary package management tool for Red Hat–based operating systems, allows you to download and install the RPM package from the YUM repository.
7572

7673
1. Create a local repository file for OpenSearch:
7774
```bash
7875
sudo curl -SL https://artifacts.opensearch.org/releases/bundle/opensearch/{{major_version_mask}}/opensearch-{{major_version_mask}}.repo -o /etc/yum.repos.d/opensearch-{{major_version_mask}}.repo
7976
```
80-
1. Verify that the repository was created successfully.
81-
```bash
82-
sudo yum repolist
83-
```
8477
1. Clean your YUM cache to ensure a smooth installation:
8578
```bash
8679
sudo yum clean all
8780
```
81+
1. Verify that the repository was created successfully.
82+
```bash
83+
sudo yum repolist
84+
```
8885
1. With the repository file downloaded, list all available versions of OpenSearch:
8986
```bash
9087
sudo yum list opensearch --showduplicates
@@ -112,31 +109,7 @@ YUM, the primary package management tool for Red Hat–based operating systems,
112109
sudo systemctl status opensearch
113110
```
114111

115-
## Step 2: Configure important system settings
116-
117-
Before launching OpenSearch you should review some [important system settings]({{site.url}}{{site.baseurl}}/opensearch/install/important-settings/){:target='\_blank'}.
118-
1. Disable memory paging and swapping performance on the host to improve performance.
119-
```bash
120-
sudo swapoff -a
121-
```
122-
1. Increase the number of memory maps available to OpenSearch.
123-
```bash
124-
# Edit the sysctl config file
125-
sudo vi /etc/sysctl.conf
126-
127-
# Add a line to define the desired value
128-
# or change the value if the key exists,
129-
# and then save your changes.
130-
vm.max_map_count=262144
131-
132-
# Reload the kernel parameters using sysctl
133-
sudo sysctl -p
134-
135-
# Verify that the change was applied by checking the value
136-
cat /proc/sys/vm/max_map_count
137-
```
138-
139-
## Step 3: (Optional) Test OpenSearch
112+
## Step 2: (Optional) Test OpenSearch
140113

141114
Before proceeding with any configuration, you should test your installation of OpenSearch. Otherwise, it can be difficult to determine whether future problems are due to installation issues or custom settings you applied after installation.
142115

@@ -195,7 +168,7 @@ An OpenSearch node in its default configuration (with demo certificates and user
195168
hostname opensearch-sql 2.1.0.0
196169
```
197170

198-
## Step 4: Set up OpenSearch in your environment
171+
## Step 3: Set up OpenSearch in your environment
199172

200173
Users who do not have prior experience with OpenSearch may want a list of recommended settings in order to get started with the service. By default, OpenSearch is not bound to a network interface and cannot be reached by external hosts. Additionally, security settings are populated by default user names and passwords. The following recommendations will enable a user to bind OpenSearch to a network interface, create and sign TLS certificates, and configure basic authentication.
201174

0 commit comments

Comments
 (0)