Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.

Commit 46e735b

Browse files
committed
Renaming install section
1 parent cbc31fb commit 46e735b

File tree

11 files changed

+36
-36
lines changed

11 files changed

+36
-36
lines changed

docs/install/ami.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ nav_order: 97
77

88
# Amazon Machine Image
99

10-
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.
10+
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.
1111

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

1414
- Choose an instance type with at least 2 GiB of RAM.
1515
- Configuration and usage is no different than the standard [RPM](../rpm/#configuration) install.

docs/install/deb.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ nav_order: 3
77

88
# Debian package
99

10-
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.
10+
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.
1111

12-
[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.
12+
[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.
1313
{: .note }
1414

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

54-
1. Install the latest version of Open Distro for Elasticsearch:
54+
1. Install the latest version of Open Distro:
5555

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

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

76-
1. To start Open Distro for Elasticsearch:
76+
1. To start Open Distro:
7777

7878
```bash
7979
sudo systemctl start elasticsearch.service
@@ -95,7 +95,7 @@ These steps assume you're using Ubuntu 18.04.
9595
systemctl status elasticsearch.service
9696
```
9797

98-
1. To stop Open Distro for Elasticsearch:
98+
1. To stop Open Distro:
9999

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

105105
## Configuration
106106

107-
To run Open Distro for Elasticsearch when the system starts:
107+
To run Open Distro when the system starts:
108108

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

203-
1. Before installing Open Distro for Elasticsearch, run:
203+
1. Before installing Open Distro, run:
204204

205205
```bash
206206
apt install apt-transport-https

docs/install/docker.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 1
77

88
# Docker image
99

10-
You can pull the Open Distro for Elasticsearch Docker image just like any other image:
10+
You can pull the Open Distro Docker image just like any other image:
1111

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

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

19-
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**.
19+
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**.
2020

2121

2222
---
@@ -285,7 +285,7 @@ docker exec -it <container-id> /bin/bash
285285

286286
## Important settings
287287

288-
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:
288+
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:
289289

290290
```bash
291291
cat /proc/sys/vm/max_map_count
@@ -336,7 +336,7 @@ RUN /usr/share/elasticsearch/bin/elasticsearch-plugin remove opendistro_security
336336
COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
337337
```
338338

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

341341
```yml
342342
cluster.name: "docker-cluster"

docs/install/encryption-at-rest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 99
77

88
# Encryption at rest
99

10-
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:
10+
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:
1111

1212
```bash
1313
cryptsetup luksFormat --key-file <key> <partition>

docs/install/helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The instructions here assume you have a Kubernetes cluster with Helm preinstalle
3333
git clone https://github.com/opendistro-for-elasticsearch/opendistro-build
3434
```
3535

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

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

docs/install/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ nav_order: 3
55
has_children: true
66
---
77

8-
# Install and configure Open Distro for Elasticsearch
8+
# Install and configure Open Distro
99

10-
Open Distro for Elasticsearch has many download options: Docker image, RPM package, Debian package, tarball, and Windows executable.
10+
Open Distro has many download options: Docker image, RPM package, Debian package, tarball, and Windows executable.

docs/install/other-components.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ nav_order: 98
77

88
# Other components
99

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

1212
- [Java Database Connectivity (JDBC) driver](../../sql/jdbc)
1313
- [PerfTop client for Performance Analyzer](../../pa/)
14-
- [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
14+
- [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

docs/install/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 90
77

88
# Standalone Elasticsearch plugin installation
99

10-
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.
10+
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.
1111

1212

1313
---

docs/install/rpm.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 2
77

88
# RPM package
99

10-
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.
10+
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.
1111

1212
1. Create the repository file:
1313

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

35-
1. List all available Open Distro for Elasticsearch versions:
35+
1. List all available Open Distro versions:
3636

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

55-
1. To start Open Distro for Elasticsearch:
55+
1. To start Open Distro:
5656

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

86-
1. To stop Open Distro for Elasticsearch:
86+
1. To stop Open Distro:
8787

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

9393
## Configuration
9494

95-
To run Open Distro for Elasticsearch when the system starts:
95+
To run Open Distro when the system starts:
9696

9797
```bash
9898
sudo /bin/systemctl daemon-reload

docs/install/tar.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 5
77

88
# Tarball
99

10-
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.
10+
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.
1111

1212
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.
1313

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

61-
1. Run Open Distro for Elasticsearch:
61+
1. Run Open Distro:
6262

6363
```bash
6464
./opendistro-tar-install.sh
6565
```
6666

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

6969
```bash
7070
curl -XGET https://localhost:9200 -u 'admin:admin' --insecure

0 commit comments

Comments
 (0)