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

Commit

Permalink
Merge pull request #154 from opendistro/windows
Browse files Browse the repository at this point in the history
Minimal Windows docs
  • Loading branch information
aetter authored Dec 18, 2019
2 parents a26f280 + a9529ee commit f5202d6
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/install/docker-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Docker Security Configuration
parent: Install and Configure
nav_order: 6
nav_order: 7
---

# Docker security configuration
Expand Down
64 changes: 64 additions & 0 deletions docs/install/windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
layout: default
title: Windows (Alpha)
parent: Install and Configure
nav_order: 6
---

# Windows

Like the [tarball installation](../tar/), we only recommend the Windows installation of Open Distro for Elasticsearch for testing and development purposes. The install package is an alpha, and we only test on Windows 10 and Windows Server 2019.

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


## ZIP install

1. Download [the ZIP file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/odfe-windows/ode-windows-zip/odfe-1.3.0.zip).

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

1. Run Open Distro for Elasticsearch:

```
.\bin\elasticsearch.bat
```


## EXE install

1. Install Java 11.

1. Download [the EXE file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/odfe-windows/odfe-executables/Open_Distro_for_Elasticsearch_windows-x64_1.3.0.exe), run it, and click through the steps.

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

1. Run Open Distro for Elasticsearch:

```
.\bin\elasticsearch.bat
```


## Verify the install

After you start Open Distro for Elasticsearch, open a second 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
curl -XGET https://localhost:9200/_cat/plugins?v -u admin:admin --insecure
```

You must have [curl](https://curl.haxx.se/windows/) installed for these commands to work. Alternatives include [Invoke-RestMethod](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/invoke-restmethod?view=powershell-6) (only PowerShell 6 and later support the `-SkipCertificateCheck` flag) and [Postman](https://www.getpostman.com/downloads/).


## Configuration

You can modify `config\elasticsearch.yml` or specify environment variables as arguments using `-E`:

```
.\bin\elasticsearch.bat -Ecluster.name=odfe-cluster -Enode.name=odfe-node1 -Ehttp.host=0.0.0.0 -Ediscovery.type=single-node
```

For other settings, see [Important settings](../docker/#important-settings).
32 changes: 32 additions & 0 deletions docs/kibana/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,38 @@ You can also modify the values in `/etc/kibana/kibana.yml`.
```


## Run Kibana on Windows (ZIP, alpha)

1. Download the ZIP.

1. Extract [the ZIP file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/odfe-windows/ode-windows-zip/odfe-1.3.0-kibana.zip) to a directory and open that directory at the command prompt.

1. If desired, modify `config/kibana.yml`.

1. Run Kibana:

```
.\bin\kibana.bat
```


## Run Kibana on Windows (EXE, alpha)

1. Download [the EXE file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/odfe-windows/odfe-executables/Open_Distro_for_Elasticsearch_Kibana_windows-x64_1_3_0.exe), run it, and click through the steps.

1. Open the command prompt.

1. Navigate to the Kibana install directory.

1. If desired, modify `config/kibana.yml`.

1. Run Kibana:

```
.\bin\kibana.bat
```


## Get started with Kibana

1. After starting Kibana, you can access it at port 5601. For example, [http://localhost:5601](http://localhost:5601){:target='\_blank'}
Expand Down
10 changes: 10 additions & 0 deletions docs/troubleshoot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ This section contains a list of issues and workarounds.
You might see `[ERROR][c.a.o.s.s.t.OpenDistroSecuritySSLNettyTransport] [odfe-node1] SSL Problem Insufficient buffer remaining for AEAD cipher fragment (2). Needs to be more than tag size (16)` when starting Open Distro for Elasticsearch. This problem is a [known issue with Java](https://bugs.openjdk.java.net/browse/JDK-8221218) and doesn't affect the operation of the cluster.


## Kibana fails to start

If you encounter the error `FATAL Error: Request Timeout after 30000ms` during startup, try running Kibana on a more powerful machine. We recommend four CPU cores and 8 GB of RAM.


## Can't open Kibana on Windows

Kibana doesn't support Microsoft Edge and many versions of Internet Explorer. We recommend using Firefox or Chrome.


## Illegal reflective access operation in logs

This is a [known issue](https://github.com/opendistro-for-elasticsearch/performance-analyzer/issues/21) with Performance Analyzer that shouldn't affect functionality.
Expand Down

0 comments on commit f5202d6

Please sign in to comment.