Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/elasticsearch/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ PUT /_cluster/settings

You can find `elasticsearch.yml` in `/usr/share/elasticsearch/config/elasticsearch.yml` (Docker) or `/etc/elasticsearch/elasticsearch.yml` (RPM and DEB) on each node.

The demo configuration includes a number of settings for the security plugin that you should modify before using Open Distro for Elasticsearch for a production workload. To learn more, see [Security](../../security/).
The demo configuration includes a number of settings for the security plugin that you should modify before using Open Distro for a production workload. To learn more, see [Security](../../security/).
2 changes: 1 addition & 1 deletion docs/elasticsearch/tasksapis.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ has_math: false

# Tasks API operation

A task is any operation you run in a cluster. For example, searching your data collection of books for a title or author name is a task. When you run Open Distro for Elasticsearch, a task is automatically created to monitor your cluster's health and performance. For more information about all of the tasks currently executing in your cluster, you can use the `tasks` API operation.
A task is any operation you run in a cluster. For example, searching your data collection of books for a title or author name is a task. When you run Open Distro, a task is automatically created to monitor your cluster's health and performance. For more information about all of the tasks currently executing in your cluster, you can use the `tasks` API operation.

The following request returns information about all of your tasks:

Expand Down
4 changes: 2 additions & 2 deletions docs/install/ami.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ nav_order: 97

# Amazon Machine Image

For convenience, Open Distro for Elasticsearch publishes Amazon Machine Images (AMIs) for use with Amazon Elastic Compute Cloud (Amazon EC2). These images use Amazon Linux 2 for their base image and come with Open Distro for Elasticsearch preinstalled.
For convenience, Open Distro publishes Amazon Machine Images (AMIs) for use with Amazon Elastic Compute Cloud (Amazon EC2). These images use Amazon Linux 2 for their base image and come with Open Distro preinstalled.

You can find the images in the **Community AMIs** section of the EC2 console if you search for `Open Distro for Elasticsearch`.
You can find the images in the **Community AMIs** section of the EC2 console if you search for `Open Distro`.

- Choose an instance type with at least 2 GiB of RAM.
- Configuration and usage is no different than the standard [RPM](../rpm/#configuration) install.
14 changes: 7 additions & 7 deletions docs/install/deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ nav_order: 3

# Debian package

Installing and running Open Distro for Elasticsearch from an Debian package is a more manual process than the Docker image. We recommend Ubuntu 16.04 or 18.04, but any Debian-based distribution that uses [systemd](https://en.wikipedia.org/wiki/Systemd) should work.
Installing and running Open Distro from an Debian package is a more manual process than the Docker image. We recommend Ubuntu 16.04 or 18.04, but any Debian-based distribution that uses [systemd](https://en.wikipedia.org/wiki/Systemd) should work.

[RPM](../rpm/) lets you install specific versions of Open Distro for Elasticsearch. You *can* install specific versions using Apt, but you have to manually install each dependency.
[RPM](../rpm/) lets you install specific versions of Open Distro. You *can* install specific versions using Apt, but you have to manually install each dependency.
{: .note }

These steps assume you're using Ubuntu 18.04.
Expand Down Expand Up @@ -51,7 +51,7 @@ These steps assume you're using Ubuntu 18.04.
sudo dpkg -i elasticsearch-oss-{{site.es_version}}-arm64.deb
```

1. Install the latest version of Open Distro for Elasticsearch:
1. Install the latest version of Open Distro:

```bash
sudo apt-get update
Expand All @@ -73,7 +73,7 @@ These steps assume you're using Ubuntu 18.04.

For compatibility by Elasticsearch version, see [Plugin compatibility](../plugins/#plugin-compatibility).

1. To start Open Distro for Elasticsearch:
1. To start Open Distro:

```bash
sudo systemctl start elasticsearch.service
Expand All @@ -95,7 +95,7 @@ These steps assume you're using Ubuntu 18.04.
systemctl status elasticsearch.service
```

1. To stop Open Distro for Elasticsearch:
1. To stop Open Distro:

```bash
sudo systemctl stop elasticsearch.service
Expand All @@ -104,7 +104,7 @@ These steps assume you're using Ubuntu 18.04.

## Configuration

To run Open Distro for Elasticsearch when the system starts:
To run Open Distro when the system starts:

```bash
sudo /bin/systemctl daemon-reload
Expand Down Expand Up @@ -200,7 +200,7 @@ If you are using Debian 9 (Strech), you likely need to make some modifications t
sudo echo 'deb http://deb.debian.org/debian stretch-backports main' > /etc/apt/sources.list.d/backports.list
```

1. Before installing Open Distro for Elasticsearch, run:
1. Before installing Open Distro, run:

```bash
apt install apt-transport-https
Expand Down
8 changes: 4 additions & 4 deletions docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 1

# Docker image

You can pull the Open Distro for Elasticsearch Docker image just like any other image:
You can pull the Open Distro Docker image just like any other image:

```bash
docker pull amazon/opendistro-for-elasticsearch:{{site.odfe_version}}
Expand All @@ -16,7 +16,7 @@ docker pull amazon/opendistro-for-elasticsearch-kibana:latest

To check available versions, see [Docker Hub](https://hub.docker.com/r/amazon/opendistro-for-elasticsearch/tags).

Open Distro for Elasticsearch images use `centos:7` as the base image. If you run Docker locally, we recommend allowing Docker to use at least 4 GB of RAM in **Preferences** > **Resources**.
Open Distro images use `centos:7` as the base image. If you run Docker locally, we recommend allowing Docker to use at least 4 GB of RAM in **Preferences** > **Resources**.


---
Expand Down Expand Up @@ -285,7 +285,7 @@ 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 Open Distro for Elasticsearch Docker image, this setting is the default. To verify, start a Bash session in the container and run:
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 Open Distro 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
Expand Down Expand Up @@ -336,7 +336,7 @@ RUN /usr/share/elasticsearch/bin/elasticsearch-plugin remove opendistro_security
COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
```

In this case, `elasticsearch.yml` is a "vanilla" version of the file with no Open Distro for Elasticsearch entries. It might look like this:
In this case, `elasticsearch.yml` is a "vanilla" version of the file with no Open Distro entries. It might look like this:

```yml
cluster.name: "docker-cluster"
Expand Down
2 changes: 1 addition & 1 deletion docs/install/encryption-at-rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 99

# Encryption at rest

The operating system for each Open Distro for Elasticsearch node handles encryption of data at rest. To enable encryption at rest in most Linux distributions, use the `cryptsetup` command:
The operating system for each Open Distro node handles encryption of data at rest. To enable encryption at rest in most Linux distributions, use the `cryptsetup` command:

```bash
cryptsetup luksFormat --key-file <key> <partition>
Expand Down
2 changes: 1 addition & 1 deletion docs/install/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The instructions here assume you have a Kubernetes cluster with Helm preinstalle
git clone https://github.com/opendistro-for-elasticsearch/opendistro-build
```

You can use the release tag (e.g. `v1.7.0` or `v1.8.0`) to get the specific Open Distro for Elasticsearch version.
You can use the release tag (e.g. `v1.7.0` or `v1.8.0`) to get the specific Open Distro version.

1. Change to the `opendistro-es` directory:

Expand Down
4 changes: 2 additions & 2 deletions docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ nav_order: 3
has_children: true
---

# Install and configure Open Distro for Elasticsearch
# Install and configure Open Distro

Open Distro for Elasticsearch has many download options: Docker image, RPM package, Debian package, tarball, and Windows executable.
Open Distro has many download options: Docker image, RPM package, Debian package, tarball, and Windows executable.
4 changes: 2 additions & 2 deletions docs/install/other-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ nav_order: 98

# Other components

Open Distro for Elasticsearch has a number of additional components that you might want to use:
Open Distro has a number of additional components that you might want to use:

- [Java Database Connectivity (JDBC) driver](../../sql/jdbc)
- [PerfTop client for Performance Analyzer](../../pa/)
- [Alerting CLI](https://github.com/mihirsoni/odfe-monitor-cli), a command line interface that lets you use YAML files to manage your Open Distro for Elasticsearch monitors
- [Alerting CLI](https://github.com/mihirsoni/odfe-monitor-cli), a command line interface that lets you use YAML files to manage your Open Distro monitors
2 changes: 1 addition & 1 deletion docs/install/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 90

# Standalone Elasticsearch plugin installation

If you don't want to use the all-in-one Open Distro for Elasticsearch installation options, you can install the individual plugins on a compatible Elasticsearch cluster, just like any other Elasticsearch plugins.
If you don't want to use the all-in-one Open Distro installation options, you can install the individual plugins on a compatible Elasticsearch cluster, just like any other Elasticsearch plugins.


---
Expand Down
10 changes: 5 additions & 5 deletions docs/install/rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 2

# RPM package

Installing and running Open Distro for Elasticsearch from an RPM package is a more manual process than the Docker image. We recommend CentOS 7 and Amazon Linux 2, but any RPM-based distribution that uses [systemd](https://en.wikipedia.org/wiki/Systemd) should work. These steps assume you're using CentOS 7.
Installing and running Open Distro from an RPM package is a more manual process than the Docker image. We recommend CentOS 7 and Amazon Linux 2, but any RPM-based distribution that uses [systemd](https://en.wikipedia.org/wiki/Systemd) should work. These steps assume you're using CentOS 7.

1. Create the repository file:

Expand All @@ -32,7 +32,7 @@ Installing and running Open Distro for Elasticsearch from an RPM package is a mo
sudo yum install wget unzip
```

1. List all available Open Distro for Elasticsearch versions:
1. List all available Open Distro versions:

```bash
sudo yum list opendistroforelasticsearch --showduplicates
Expand All @@ -52,7 +52,7 @@ Installing and running Open Distro for Elasticsearch from an RPM package is a mo
sudo ln -s /usr/lib/jvm/java-1.8.0/lib/tools.jar /usr/share/elasticsearch/lib/
```

1. To start Open Distro for Elasticsearch:
1. To start Open Distro:

```bash
sudo systemctl start elasticsearch.service
Expand Down Expand Up @@ -83,7 +83,7 @@ Installing and running Open Distro for Elasticsearch from an RPM package is a mo
elasticsearch[3969]: java.net.MalformedURLException: unknown protocol: jrt
```

1. To stop Open Distro for Elasticsearch:
1. To stop Open Distro:

```bash
sudo systemctl stop elasticsearch.service
Expand All @@ -92,7 +92,7 @@ Installing and running Open Distro for Elasticsearch from an RPM package is a mo

## Configuration

To run Open Distro for Elasticsearch when the system starts:
To run Open Distro when the system starts:

```bash
sudo /bin/systemctl daemon-reload
Expand Down
6 changes: 3 additions & 3 deletions docs/install/tar.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 5

# Tarball

The tarball installation works on Linux systems and provides a self-contained directory with everything you need to run Open Distro for Elasticsearch, including an integrated Java Development Kit (JDK). The tarball is a good option for testing and development, but we recommend Docker or a package manager for production deployments.
The tarball installation works on Linux systems and provides a self-contained directory with everything you need to run Open Distro, including an integrated Java Development Kit (JDK). The tarball is a good option for testing and development, but we recommend Docker or a package manager for production deployments.

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.

Expand Down Expand Up @@ -58,13 +58,13 @@ The tarball supports CentOS 7, Amazon Linux 2, Ubuntu 18.04, and most other Linu
cd opendistroforelasticsearch-{{site.odfe_version}}
```

1. Run Open Distro for Elasticsearch:
1. Run Open Distro:

```bash
./opendistro-tar-install.sh
```

1. Open a second terminal session, and send requests to the server to verify that Open Distro for Elasticsearch is up and running:
1. Open a second terminal session, and send requests to the server to verify that Open Distro is up and running:

```bash
curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
Expand Down
16 changes: 8 additions & 8 deletions docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 6

# Windows

Like the [tarball installation](../tar/), the Windows installation of Open Distro for Elasticsearch is a good option for testing and development, but we recommend Docker or a package manager for production deployments. We test on Windows 10 and Windows Server 2019, but other versions might work.
Like the [tarball installation](../tar/), the Windows installation of Open Distro is a good option for testing and development, but we recommend Docker or a package manager for production deployments. We test on Windows 10 and Windows Server 2019, but other versions might work.

As an alternative, try [Ubuntu for Windows 10](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6), which you can use to install [Debian packages](../deb/).
{: .tip }
Expand All @@ -19,7 +19,7 @@ As an alternative, try [Ubuntu for Windows 10](https://www.microsoft.com/en-us/p

1. Extract the file to a directory, and open that directory at the command prompt.

1. Run Open Distro for Elasticsearch:
1. Run Open Distro:

```
.\bin\elasticsearch.bat
Expand All @@ -32,9 +32,9 @@ As an alternative, try [Ubuntu for Windows 10](https://www.microsoft.com/en-us/p

1. Download [the EXE file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/odfe-windows/odfe-executables/opendistroforelasticsearch-{{site.odfe_version}}-windows-x64.exe), run it, and click through the steps.

1. Open the command prompt and navigate to the Open Distro for Elasticsearch install directory.
1. Open the command prompt and navigate to the Open Distro install directory.

1. Run Open Distro for Elasticsearch:
1. Run Open Distro:

```
.\bin\elasticsearch.bat
Expand All @@ -43,17 +43,17 @@ As an alternative, try [Ubuntu for Windows 10](https://www.microsoft.com/en-us/p

## Install as a Windows service

Installing Open Distro for Elasticsearch as a Windows service lets it run in the background and makes it easier to monitor. You can also configure the service to start automatically after a reboot.
Installing Open Distro as a Windows service lets it run in the background and makes it easier to monitor. You can also configure the service to start automatically after a reboot.

1. Open the command prompt and navigate to the Open Distro for Elasticsearch install directory.
1. Open the command prompt and navigate to the Open Distro install directory.

1. Set the JAVA_HOME environment variable:

```
set JAVA_HOME=C:\path\to\jdk
```

1. (Optional) Set the `ES_START_TYPE` environment variable if you want Open Distro for Elasticsearch to start automatically when Windows starts:
1. (Optional) Set the `ES_START_TYPE` environment variable if you want Open Distro to start automatically when Windows starts:

```
set ES_START_TYPE=auto
Expand All @@ -80,7 +80,7 @@ Installing Open Distro for Elasticsearch as a Windows service lets it run in the

## Verify the install

After you start Open Distro for Elasticsearch, open a new command prompt window. Then send requests to the server to verify that it is up and running:
After you start Open Distro, open a new command prompt window. Then send requests to the server to verify that it is up and running:

```
curl -XGET https://localhost:9200 -u "admin:admin" --insecure
Expand Down
2 changes: 1 addition & 1 deletion docs/kibana/gantt.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 10

# Gantt charts

Open Distro for Elasticsearch includes a new Kibana visualization: Gantt charts. These charts show the start, end, and duration of unique events in a sequence. Gantt charts are useful in trace analytics, telemetry, and anomaly detection use cases, where you want to understand interactions and dependencies between various events in a schedule.
Open Distro includes a new Kibana visualization: Gantt charts. These charts show the start, end, and duration of unique events in a sequence. Gantt charts are useful in trace analytics, telemetry, and anomaly detection use cases, where you want to understand interactions and dependencies between various events in a schedule.

For example, consider an index of log data. The fields in a typical set of log data, especially audit logs, contain a specific operation or event with a start time and duration.

Expand Down
4 changes: 2 additions & 2 deletions docs/kibana/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ has_toc: false

# Kibana

Kibana is the default visualization tool for data in Elasticsearch. It also serves as a user interface for the Open Distro for Elasticsearch [security](../security/configuration/), [alerting](../alerting/), and [Index State Management](../ism/) plugins.
Kibana is the default visualization tool for data in Elasticsearch. It also serves as a user interface for the Open Distro [security](../security/configuration/), [alerting](../alerting/), and [Index State Management](../ism/) plugins.


## Run Kibana using Docker
Expand All @@ -17,7 +17,7 @@ You *can* start Kibana using `docker run` after [creating a Docker network](http

1. Run `docker pull amazon/opendistro-for-elasticsearch-kibana:{{site.odfe_version}}`.

1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes Kibana is available on the Open Distro for Elasticsearch [Docker installation page](../install/docker/#sample-docker-compose-file).
1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes Kibana is available on the Open Distro [Docker installation page](../install/docker/#sample-docker-compose-file).

Just like `elasticsearch.yml`, you can pass a custom `kibana.yml` to the container in the Docker Compose file.
{: .tip }
Expand Down
2 changes: 1 addition & 1 deletion docs/kibana/maptiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 5

# Configure WMS map server

Due to licensing restrictions, the default installation of Kibana does in Open Distro for Elasticsearch doesn't include a map server for tile map visualizations. To configure Kibana to use a WMS map server:
Due to licensing restrictions, the default installation of Kibana in Open Distro doesn't include a map server for tile map visualizations. To configure Kibana to use a WMS map server:

1. Open Kibana at `https://<host>:<port>`. For example, [https://localhost:5601](https://localhost:5601).
1. If necessary, log in.
Expand Down
2 changes: 1 addition & 1 deletion docs/kibana/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 1

# Standalone Kibana plugin install

If you don't want to use the all-in-one Open Distro for Elasticsearch installation options, you can install the security, alerting, and Index State Management plugins for Kibana individually.
If you don't want to use the all-in-one Open Distro installation options, you can install the security, alerting, and Index State Management plugins for Kibana individually.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/kibana/reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav_order: 20

# Reporting

The Open Distro for Elasticsearch Kibana reports feature lets you create PNG, PDF, and CSV reports. To use reports, you must have the correct permissions. For summaries of the predefined roles and the permissions they grant, see the [security plugin](../../security/access-control/users-roles/#predefined-roles).
The Open Distro Kibana reports feature lets you create PNG, PDF, and CSV reports. To use reports, you must have the correct permissions. For summaries of the predefined roles and the permissions they grant, see the [security plugin](../../security/access-control/users-roles/#predefined-roles).


## Create reports from Discovery, Visualize, or Dashboard
Expand Down
Loading