Installation tweaks
This commit is contained in:
aetter
parent
c61ea535d7
commit
a4d5b11939
|
|
@ -283,25 +283,6 @@ docker exec -it <container-id> /bin/bash
|
|||
```
|
||||
|
||||
|
||||
## Important settings
|
||||
|
||||
For production workloads, make sure the [Linux setting](https://www.kernel.org/doc/Documentation/sysctl/vm.txt) `vm.max_map_count` is set to at least 262144. On the OpenSearch Docker image, this setting is the default. To verify, start a Bash session in the container and run:
|
||||
|
||||
```bash
|
||||
cat /proc/sys/vm/max_map_count
|
||||
```
|
||||
|
||||
To increase this value, you have to modify the Docker image. For other install types, add this setting to the host machine's `/etc/sysctl.conf` file with the following line:
|
||||
|
||||
```
|
||||
vm.max_map_count=262144
|
||||
```
|
||||
|
||||
Then run `sudo sysctl -p` to reload.
|
||||
|
||||
The `docker-compose.yml` file above also contains several key settings: `bootstrap.memory_lock=true`, `ES_JAVA_OPTS=-Xms512m -Xmx512m`, `nofile 65536` and `port 9600`. Respectively, these settings disable memory swapping (along with `memlock`), set the size of the Java heap (we recommend half of system RAM), set a limit of 65536 open files for the OpenSearch user, and allow you to access Performance Analyzer on port 9600.
|
||||
|
||||
|
||||
## Customize the Docker image
|
||||
|
||||
To run the image with a custom plugin, first create a [`Dockerfile`](https://docs.docker.com/engine/reference/builder/):
|
||||
|
|
|
|||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
layout: default
|
||||
title: Important settings
|
||||
parent: Install and configure
|
||||
nav_order: 70
|
||||
---
|
||||
|
||||
# Important settings
|
||||
|
||||
For production workloads, make sure the [Linux setting](https://www.kernel.org/doc/Documentation/sysctl/vm.txt) `vm.max_map_count` is set to at least 262144. On the OpenSearch Docker image, this setting is the default. To check, start a Bash session in the container and run:
|
||||
|
||||
```bash
|
||||
cat /proc/sys/vm/max_map_count
|
||||
```
|
||||
|
||||
To increase this value, you have to modify the Docker image. For other install types, add this setting to the host machine's `/etc/sysctl.conf` file with the following line:
|
||||
|
||||
```
|
||||
vm.max_map_count=262144
|
||||
```
|
||||
|
||||
Then run `sudo sysctl -p` to reload.
|
||||
|
||||
The [sample docker-compose.yml](../docker/#sample-docker-compose-file) file also contains several key settings:
|
||||
|
||||
- `bootstrap.memory_lock=true`
|
||||
|
||||
Disbles swapping (along with `memlock`). Swapping can dramatically decrease performance and stability, so you should ensure it is disabled on production clusters.
|
||||
|
||||
- `ES_JAVA_OPTS=-Xms512m -Xmx512m`
|
||||
|
||||
Sets the size of the Java heap (we recommend half of system RAM).
|
||||
|
||||
- `nofile 65536`
|
||||
|
||||
Sets a limit of 65536 open files for the OpenSearch user.
|
||||
|
||||
- `port 9600`
|
||||
|
||||
Allows you to access Performance Analyzer on port 9600.
|
||||
|
|
@ -7,4 +7,4 @@ has_children: true
|
|||
|
||||
# Install and configure OpenSearch
|
||||
|
||||
OpenSearch two installation options at this time: Docker images and tarballs.
|
||||
OpenSearch has two installation options at this time: Docker images and tarballs.
|
||||
|
|
|
|||
|
|
@ -7,44 +7,11 @@ nav_order: 50
|
|||
|
||||
# Tarball
|
||||
|
||||
The tarball installation works on Linux systems and provides a self-contained directory with everything you need to run OpenSearch, including an integrated Java Development Kit (JDK). The tarball is a good option for testing and development.
|
||||
The tarball installation provides a self-contained directory with everything you need to run OpenSearch, including an integrated Java Development Kit (JDK). The tarball is a good option for testing and development.
|
||||
|
||||
The tarball supports CentOS 7, Amazon Linux 2, Ubuntu 18.04, and most other Linux distributions. If you have your own Java installation and you set `JAVA_HOME` in the terminal, macOS works as well.
|
||||
The tarball supports most Linux distributions, including CentOS 7, Amazon Linux 2, and Ubuntu 18.04. If you have your own Java installation and set `JAVA_HOME` in the terminal, macOS works, as well.
|
||||
|
||||
1. Download the tarball:
|
||||
|
||||
```bash
|
||||
# x64
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch/opensearch-{{site.opensearch_version}}-linux-x64.tar.gz -o opensearch-{{site.opensearch_version}}-linux-x64.tar.gz
|
||||
# ARM64
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch/opensearch-{{site.opensearch_version}}-linux-arm64.tar.gz -o opensearch-{{site.opensearch_version}}-linux-arm64.tar.gz
|
||||
```
|
||||
|
||||
1. Download the checksum:
|
||||
|
||||
```bash
|
||||
# x86
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch/opensearch-{{site.opensearch_version}}-linux-x64.tar.gz.sha512 -o opensearch-{{site.opensearch_version}}-linux-x64.tar.gz.sha512
|
||||
# ARM64
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch/opensearch-{{site.opensearch_version}}-linux-arm64.tar.gz.sha512 -o opensearch-{{site.opensearch_version}}-linux-arm64.tar.gz.sha512
|
||||
```
|
||||
|
||||
1. Verify the tarball against the checksum:
|
||||
|
||||
```bash
|
||||
# x64
|
||||
shasum -a 512 -c opensearch-{{site.opensearch_version}}-linux-x64.tar.gz.sha512
|
||||
# ARM64
|
||||
shasum -a 512 -c opensearch-{{site.opensearch_version}}-linux-arm64.tar.gz.sha512
|
||||
```
|
||||
|
||||
On CentOS, you might not have `shasum`. Install this package:
|
||||
|
||||
```bash
|
||||
sudo yum install perl-Digest-SHA
|
||||
```
|
||||
|
||||
Due to a [known issue](https://github.com/opensearch/opensearch-build/issues/81) with the checksum, this step might fail. You can still proceed with the installation.
|
||||
1. Download the tarball from the [OpenSearch downloads page](https://opensearch.org/downloads/){:target='\_blank'}.
|
||||
|
||||
1. Extract the TAR file to a directory and change to that directory:
|
||||
|
||||
|
|
@ -79,7 +46,7 @@ You can modify `config/opensearch.yml` or specify environment variables as argum
|
|||
./opensearch-tar-install.sh -Ecluster.name=opensearch-cluster -Enode.name=opensearch-node1 -Ehttp.host=0.0.0.0 -Ediscovery.type=single-node
|
||||
```
|
||||
|
||||
For other settings, see [Important settings](../docker/#important-settings).
|
||||
For other settings, see [Important settings](../important-settings/).
|
||||
|
||||
|
||||
### (Optional) Set up Performance Analyzer
|
||||
|
|
@ -172,7 +139,10 @@ In a tarball installation, Performance Analyzer collects data when it is enabled
|
|||
curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k
|
||||
```
|
||||
|
||||
{% comment %}
|
||||
|
||||
### (Optional) Removing Performance Analyzer
|
||||
|
||||
See [Clean up Performance Analyzer files](../plugins/#optional-clean-up-performance-analyzer-files).
|
||||
|
||||
{% endcomment %}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ has_toc: false
|
|||
|
||||
# OpenSearch Dashboards
|
||||
|
||||
OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for the OpenSearch [security](../security/configuration/), [alerting](../alerting/), and [Index State Management](../ism/) plugins.
|
||||
OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more.
|
||||
|
||||
|
||||
## Run OpenSearch Dashboards using Docker
|
||||
|
|
@ -28,52 +28,10 @@ You *can* start OpenSearch Dashboards using `docker run` after [creating a Docke
|
|||
|
||||
1. When finished, run `docker-compose down`.
|
||||
|
||||
### Configuration
|
||||
|
||||
To run OpenSearch Dashboards when the system starts:
|
||||
|
||||
```bash
|
||||
sudo /bin/systemctl daemon-reload
|
||||
sudo /bin/systemctl enable opensearch-dashboards.service
|
||||
```
|
||||
|
||||
You can also modify the values in `/etc/opensearch-dashboards/opensearch_dashboards.yml`.
|
||||
|
||||
|
||||
## Run OpenSearch Dashboards using the tarball
|
||||
|
||||
1. Download the tarball:
|
||||
|
||||
```bash
|
||||
# x64
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch-dashboards/opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz -o opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz
|
||||
# ARM64
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch-dashboards/opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz -o opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz
|
||||
```
|
||||
|
||||
1. Download the checksum:
|
||||
|
||||
```bash
|
||||
# x64
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch-dashboards/opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz.sha512 -o opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz.sha512
|
||||
# ARM64
|
||||
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opensearch-dashboards/opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz.sha512 -o opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz.sha512
|
||||
```
|
||||
|
||||
1. Verify the tarball against the checksum:
|
||||
|
||||
```bash
|
||||
# x64
|
||||
shasum -a 512 -c opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz.sha512
|
||||
# ARM64
|
||||
shasum -a 512 -c opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz.sha512
|
||||
```
|
||||
|
||||
On CentOS, you might not have `shasum`. Install this package:
|
||||
|
||||
```bash
|
||||
sudo yum install perl-Digest-SHA
|
||||
```
|
||||
1. Download the tarball from the [OpenSearch downloads page](https://opensearch.org/downloads/){:target='\_blank'}.
|
||||
|
||||
1. Extract the TAR file to a directory and change to that directory:
|
||||
|
||||
|
|
@ -94,6 +52,7 @@ You can also modify the values in `/etc/opensearch-dashboards/opensearch_dashboa
|
|||
./bin/opensearch-dashboards
|
||||
```
|
||||
|
||||
|
||||
## Get started with OpenSearch Dashboards
|
||||
|
||||
1. After starting OpenSearch Dashboards, you can access it at port 5601. For example, http://localhost:5601.
|
||||
|
|
|
|||
Loading…
Reference in New Issue