Logstash tar installation instructions (#5129)
* Update the documentation for the Logstash tar installation per the deprecation of the bundled Logstash distribution. Part of logstash-output-opensearch #208. Signed-off-by: David Venable <dlv@amazon.com> * Style correction Signed-off-by: David Venable <dlv@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update index.md --------- Signed-off-by: David Venable <dlv@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
This commit is contained in:
parent
27798ba8e5
commit
1084f476fb
|
@ -54,32 +54,47 @@ You can also write conditional statements within pipeline configurations to perf
|
||||||
|
|
||||||
## Install Logstash
|
## Install Logstash
|
||||||
|
|
||||||
The OpenSearch Logstash plugin has two installation options at this time: Linux (ARM64/X64) and Docker (ARM64/X64).
|
To install Logstash on OpenSearch, first install Logstash on your cluster, then the OpenSearch Logstash plugin, as described in the following steps.
|
||||||
|
|
||||||
Make sure you have [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-downloads.html) version 8 or 11 installed.
|
|
||||||
|
|
||||||
If you're migrating from an existing Logstash installation, you can install the [OpenSearch output plugin](https://rubygems.org/gems/logstash-output-opensearch/) manually and [update pipeline.conf](https://opensearch.org/docs/latest/tools/logstash/index/). We include this plugin by default in our tarball and Docker downloads.
|
|
||||||
{: .note }
|
|
||||||
|
|
||||||
### Tarball
|
### Tarball
|
||||||
|
|
||||||
1. Download the Logstash tarball from [OpenSearch downloads](https://opensearch.org/downloads.html).
|
Make sure you have [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-downloads.html) version 8 or 11 installed.
|
||||||
|
|
||||||
2. Navigate to the downloaded folder in the terminal and extract the files:
|
1. Download the Logstash tarball from [Logstash downloads](https://www.elastic.co/downloads/logstash).
|
||||||
|
|
||||||
|
2. Navigate to the downloaded folder in the terminal and extract the files. Make sure that your version of Logstash and platform matches the one downloaded:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tar -zxvf logstash-oss-with-opensearch-output-plugin-7.16.2-linux-x64.tar.gz
|
tar -zxvf logstash-8.8.2-linux-x86_64.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Navigate to the `logstash-7.16.2` directory.
|
3. Navigate to the `logstash-8.8.2` directory.
|
||||||
- You can add your pipeline configurations to the `config` directory. Logstash saves any data from the plugins in the `data` directory. The `bin` directory contains the binaries for starting Logstash and managing plugins.
|
|
||||||
|
4. Use the following command to install the plugin:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bin/logstash-plugin install logstash-output-opensearch
|
||||||
|
```
|
||||||
|
|
||||||
|
You should receive the following output:
|
||||||
|
|
||||||
|
```
|
||||||
|
Validating logstash-output-opensearch
|
||||||
|
Resolving mixin dependencies
|
||||||
|
Updating mixin dependencies logstash-mixin-ecs_compatibility_support
|
||||||
|
Bundler attempted to update logstash-mixin-ecs_compatibility_support but its version stayed the same
|
||||||
|
Installing logstash-output-opensearch
|
||||||
|
Installation successful
|
||||||
|
```
|
||||||
|
|
||||||
|
You can add your pipeline configurations to the `config` directory. Logstash saves any data from the plugins in the `data` directory. The `bin` directory contains the binaries for starting Logstash and managing plugins.
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
1. Pull the Logstash oss package with the OpenSearch output plugin image:
|
1. Pull the latest Logstash image as stated in the [Logstash downloads](https://www.elastic.co/downloads/logstash).
|
||||||
|
|
||||||
```
|
```
|
||||||
docker pull opensearchproject/logstash-oss-with-opensearch-output-plugin:7.16.2
|
docker pull docker.elastic.co/logstash/logstash:8.8.2
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Create a Docker network:
|
1. Create a Docker network:
|
||||||
|
|
Loading…
Reference in New Issue