Fix formatting
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
This commit is contained in:
Naarcha-AWS
parent
6f2b8b90c3
commit
64741ac258
|
|
@ -5,6 +5,8 @@ parent: Install OpenSearch
|
|||
nav_order: 51
|
||||
---
|
||||
|
||||
# RPM
|
||||
|
||||
The RPM Package Manager (RPM) installation provides everything you need to run OpenSearch inside Red Hat or CentOS 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.
|
||||
|
|
@ -18,31 +20,31 @@ There are two methods for installing OpenSearch on RPM:
|
|||
|
||||
2. On your host, use `yum install` or `rpm -ivh` to install the package. We recommend using `yum install`, so that the required dependecies can be pulled from the YUM library.
|
||||
|
||||
```bash
|
||||
yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
|
||||
yum install opensearch-dashboards-{{site.opensearch_version}}-linux-x64.rpm
|
||||
```
|
||||
```bash
|
||||
yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
|
||||
yum install opensearch-dashboards-{{site.opensearch_version}}-linux-x64.rpm
|
||||
```
|
||||
|
||||
```bash
|
||||
rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
|
||||
rpm -ivh opensearch-dashboards-{{site.opensearch_version}}-linux-x64.rpm
|
||||
```
|
||||
```bash
|
||||
rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
|
||||
rpm -ivh opensearch-dashboards-{{site.opensearch_version}}-linux-x64.rpm
|
||||
```
|
||||
|
||||
3. Run OpenSearch and OpenSearch Dashboards using `systemctl`.
|
||||
|
||||
```bash
|
||||
systemctl start opensearch
|
||||
systemctl start opensearch-dashboards
|
||||
```
|
||||
```bash
|
||||
systemctl start opensearch
|
||||
systemctl start opensearch-dashboards
|
||||
```
|
||||
|
||||
If you configure the security plugin for production use (or disable it), you can run OpenSearch using `./bin/opensearch`.
|
||||
If you configure the security plugin for production use (or disable it), you can run OpenSearch using `./bin/opensearch`.
|
||||
|
||||
4. Open a second terminal session, and send requests to the server to verify that OpenSearch is running:
|
||||
|
||||
```bash
|
||||
curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
|
||||
curl -XGET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure
|
||||
```
|
||||
```bash
|
||||
curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
|
||||
curl -XGET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure
|
||||
```
|
||||
|
||||
## YUM method
|
||||
|
||||
|
|
@ -50,77 +52,77 @@ YUM allows you to pull the RPM package from the YUM repository library.
|
|||
|
||||
1. Create a repository file for both OpenSearch and OpenSearch dashboards:
|
||||
|
||||
```curl
|
||||
sudo curl -SL https://artifacts.opensearch.org/releases/bundle/opensearch/2.x/opensearch-{{site.opensearch_version}}.repo -o /etc/yum.repos.d/{{site.opensearch_version}}.repo
|
||||
```
|
||||
```bash
|
||||
sudo curl -SL https://artifacts.opensearch.org/releases/bundle/opensearch/2.x/opensearch-{{site.opensearch_version}}.repo -o /etc/yum.repos.d/{{site.opensearch_version}}.repo
|
||||
```
|
||||
|
||||
```curl
|
||||
sudo curl -SL https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{site.opensearch_version}}/opensearch-dashboards-{{site.opensearch_version}}.repo -o /etc/yum.repos.d/{{site.opensearch_version}}.repo
|
||||
```
|
||||
```bash
|
||||
sudo curl -SL https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{site.opensearch_version}}/opensearch-dashboards-{{site.opensearch_version}}.repo -o /etc/yum.repos.d/{{site.opensearch_version}}.repo
|
||||
```
|
||||
|
||||
2. Navigate to your YUM repository directory:
|
||||
|
||||
```bash
|
||||
cd /etc/yum.repos.d/
|
||||
```
|
||||
```bash
|
||||
cd /etc/yum.repos.d/
|
||||
```
|
||||
|
||||
3. Clean your YUM cache, to ensure a smooth installation:
|
||||
|
||||
```bash
|
||||
sudo yum clean all
|
||||
```
|
||||
```bash
|
||||
sudo yum clean all
|
||||
```
|
||||
|
||||
4. With the repository file downloaded, list all available versions of OpenSearch:
|
||||
|
||||
```curl
|
||||
sudo yum list | grep opensearch
|
||||
```
|
||||
```bash
|
||||
sudo yum list | grep opensearch
|
||||
```
|
||||
|
||||
5. Chose the version of OpenSearch you want to install:
|
||||
|
||||
```bash
|
||||
yum install opensearch
|
||||
yum install opensearch-dashboards
|
||||
```
|
||||
```bash
|
||||
yum install opensearch
|
||||
yum install opensearch-dashboards
|
||||
```
|
||||
|
||||
Unless otherwise indicated, the highest minor version of OpenSearch installs.
|
||||
Unless otherwise indicated, the highest minor version of OpenSearch installs.
|
||||
|
||||
To install a specific version of OpenSearch
|
||||
To install a specific version of OpenSearch
|
||||
|
||||
```bash
|
||||
yum install 'opensearch-{{site.opensearch_version}}'
|
||||
```
|
||||
```bash
|
||||
yum install 'opensearch-{{site.opensearch_version}}'
|
||||
```
|
||||
|
||||
6. During installation, the installer stops to see if the GPG key matches the OpenSearch project. Verify that the `Fingerprint` matches the following:
|
||||
|
||||
```
|
||||
Fingerprint: c5b7 4989 65ef d1c2 924b a9d5 39d3 1987 9310 d3fc
|
||||
```
|
||||
```bash
|
||||
Fingerprint: c5b7 4989 65ef d1c2 924b a9d5 39d3 1987 9310 d3fc
|
||||
```
|
||||
|
||||
If correct, enter `yes`. The OpenSearch installation continues.
|
||||
If correct, enter `yes`. The OpenSearch installation continues.
|
||||
|
||||
7. Run OpenSearch and OpenSearch Dashboards using `systemctl`.
|
||||
|
||||
```bash
|
||||
systemctl start opensearch.service
|
||||
systemctl start opensearch-dashboards.service
|
||||
```
|
||||
```bash
|
||||
systemctl start opensearch.service
|
||||
systemctl start opensearch-dashboards.service
|
||||
```
|
||||
|
||||
If you configure the security plugin for production use (or disable it), you can run OpenSearch using `./bin/opensearch`.
|
||||
|
||||
8. Open a second terminal session, and send requests to the server to verify that OpenSearch is running:
|
||||
|
||||
```bash
|
||||
curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
|
||||
curl -XGET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure
|
||||
```
|
||||
```bash
|
||||
curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
|
||||
curl -XGET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure
|
||||
```
|
||||
|
||||
To stop running OpenSearch, enter:
|
||||
To stop running OpenSearch, enter:
|
||||
|
||||
```bash
|
||||
systemctl stop opensearch.service
|
||||
systemctl stop opensearch-dashboards.service
|
||||
```
|
||||
```bash
|
||||
systemctl stop opensearch.service
|
||||
systemctl stop opensearch-dashboards.service
|
||||
```
|
||||
|
||||
|
||||
## (Optional) Set up Performance Analyzer
|
||||
|
|
@ -129,71 +131,71 @@ When enabled, the Performance Analyzer plugin collects data related to the perfo
|
|||
|
||||
1. Make Performance Analyzer accessible outside of the host machine
|
||||
|
||||
```bash
|
||||
cd /usr/share/opensearch # navigate to the OpenSearch home directory
|
||||
cd plugins/opensearch_performance_analyzer/pa_config/
|
||||
vi performance-analyzer.properties
|
||||
```
|
||||
```bash
|
||||
cd /usr/share/opensearch # navigate to the OpenSearch home directory
|
||||
cd plugins/opensearch_performance_analyzer/pa_config/
|
||||
vi performance-analyzer.properties
|
||||
```
|
||||
|
||||
Uncomment the line `#webservice-bind-host` and set it to `0.0.0.0`:
|
||||
Uncomment the line `#webservice-bind-host` and set it to `0.0.0.0`:
|
||||
|
||||
```
|
||||
# ======================== OpenSearch performance analyzer plugin config =========================
|
||||
```
|
||||
# ======================== OpenSearch performance analyzer plugin config =========================
|
||||
|
||||
# NOTE: this is an example for Linux. Please modify the config accordingly if you are using it under other OS.
|
||||
# NOTE: this is an example for Linux. Please modify the config accordingly if you are using it under other OS.
|
||||
|
||||
# WebService bind host; default to all interfaces
|
||||
webservice-bind-host = 0.0.0.0
|
||||
# WebService bind host; default to all interfaces
|
||||
webservice-bind-host = 0.0.0.0
|
||||
|
||||
# Metrics data location
|
||||
metrics-location = /dev/shm/performanceanalyzer/
|
||||
# Metrics data location
|
||||
metrics-location = /dev/shm/performanceanalyzer/
|
||||
|
||||
# Metrics deletion interval (minutes) for metrics data.
|
||||
# Interval should be between 1 to 60.
|
||||
metrics-deletion-interval = 1
|
||||
# Metrics deletion interval (minutes) for metrics data.
|
||||
# Interval should be between 1 to 60.
|
||||
metrics-deletion-interval = 1
|
||||
|
||||
# If set to true, the system cleans up the files behind it. So at any point, we should expect only 2
|
||||
# metrics-db-file-prefix-path files. If set to false, no files are cleaned up. This can be useful, if you are archiving
|
||||
# the files and wouldn't like for them to be cleaned up.
|
||||
cleanup-metrics-db-files = true
|
||||
# If set to true, the system cleans up the files behind it. So at any point, we should expect only 2
|
||||
# metrics-db-file-prefix-path files. If set to false, no files are cleaned up. This can be useful, if you are archiving
|
||||
# the files and wouldn't like for them to be cleaned up.
|
||||
cleanup-metrics-db-files = true
|
||||
|
||||
# WebService exposed by App's port
|
||||
webservice-listener-port = 9600
|
||||
# WebService exposed by App's port
|
||||
webservice-listener-port = 9600
|
||||
|
||||
# Metric DB File Prefix Path location
|
||||
metrics-db-file-prefix-path = /tmp/metricsdb_
|
||||
# Metric DB File Prefix Path location
|
||||
metrics-db-file-prefix-path = /tmp/metricsdb_
|
||||
|
||||
https-enabled = false
|
||||
https-enabled = false
|
||||
|
||||
#Setup the correct path for certificates
|
||||
certificate-file-path = specify_path
|
||||
#Setup the correct path for certificates
|
||||
certificate-file-path = specify_path
|
||||
|
||||
private-key-file-path = specify_path
|
||||
private-key-file-path = specify_path
|
||||
|
||||
# Plugin Stats Metadata file name, expected to be in the same location
|
||||
plugin-stats-metadata = plugin-stats-metadata
|
||||
# Plugin Stats Metadata file name, expected to be in the same location
|
||||
plugin-stats-metadata = plugin-stats-metadata
|
||||
|
||||
# Agent Stats Metadata file name, expected to be in the same location
|
||||
agent-stats-metadata = agent-stats-metadata
|
||||
```
|
||||
# Agent Stats Metadata file name, expected to be in the same location
|
||||
agent-stats-metadata = agent-stats-metadata
|
||||
```
|
||||
|
||||
2. Restart the OpenSearch service:
|
||||
|
||||
```bash
|
||||
systemctl restart opensearch.service
|
||||
```
|
||||
```bash
|
||||
systemctl restart opensearch.service
|
||||
```
|
||||
|
||||
3. After OpenSearch is running, start the Performance Analyzer plugin:
|
||||
|
||||
```bash
|
||||
sudo systemctl start opensearch-performance-analyzer.service
|
||||
```
|
||||
```bash
|
||||
sudo systemctl start opensearch-performance-analyzer.service
|
||||
```
|
||||
|
||||
To stop the Performance Analyzer, enter:
|
||||
To stop the Performance Analyzer, enter:
|
||||
|
||||
```
|
||||
sudo systemctl stop opensearch-performance-analyzer.service
|
||||
```
|
||||
```bash
|
||||
sudo systemctl stop opensearch-performance-analyzer.service
|
||||
```
|
||||
|
||||
|
||||
## Upgrade RPM
|
||||
|
|
|
|||
Loading…
Reference in New Issue