Merge pull request #172 from opendistro/1.4.0

1.4.0

Author: aetter

README.md

@@ -35,7 +35,7 @@ This repository contains the documentation for Open Distro for Elasticsearch, a
 
    Alternately, run `build.sh`, which includes some convenience flags and is faster to type.
 
-   You'll probably receive a couple `Invalid theme folder: _sass` warnings from Jekyll. You can safely ignore them.
+   You might receive a couple `Invalid theme folder: _sass` warnings from Jekyll. You can safely ignore them.
 
 1. Open [http://localhost:4000/for-elasticsearch-docs/](http://localhost:4000/for-elasticsearch-docs/).
 

docs/ad/index.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Anomaly Detection (Alpha)
-nav_order: 34
+nav_order: 36
 has_children: true
 ---
 

docs/alerting/monitors.md

@@ -102,7 +102,7 @@ Destination | A reusable location for an action, such as Amazon Chime, Slack, or
 
      "Start" and "end" refer to the interval at which the monitor runs. See [Available variables](#available-variables).
 
-   - Anomaly detection works for pairing with the anomaly detection plugin. See [Anomaly Detection](../ad/).
+   - Anomaly detection works for pairing with the anomaly detection plugin. See [Anomaly Detection](../../ad/).
 
 
 1. To define a monitor visually, choose **Define using visual graph**. Then choose an aggregation (for example, `count()` or `average()`), a set of documents, and a timeframe. Visual definition works well for most monitors.

docs/elasticsearch/snapshot-restore.md

@@ -101,7 +101,7 @@ readonly | Whether the repository is read-only. Useful when migrating from one c
    If you're using the Docker installation, see [Customize the Docker image](../../install/docker/#customize-the-docker-image). Your `Dockerfile` should look something like this:
 
    ```
-   FROM amazon/opendistro-for-elasticsearch:1.3.0
+   FROM amazon/opendistro-for-elasticsearch:1.4.0
 
    ENV AWS_ACCESS_KEY_ID <access-key>
    ENV AWS_SECRET_ACCESS_KEY <secret-key>
@@ -144,12 +144,15 @@ readonly | Whether the repository is read-only. Useful when migrating from one c
 1. (Optional) Add other settings to `elasticsearch.yml`:
 
    ```yml
+   disable_chunked_encoding: false # Disables chunked encoding for compatibility with some storage services, but you probably don't need to change this value.
    endpoint: s3.amazonaws.com # S3 has alternate endpoints, but you probably don't need to change this value.
+   max_retries: 3 # number of retries if a request fails
+   path_style_access: false # whether to use the deprecated path-style bucket URLs.
+   # You probably don't need to change this value, but for more information, see https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#path-style-access.
    protocol: https # http or https
    proxy.host: my-proxy-host # the hostname for your proxy server
    proxy.port: 8080 # port for your proxy server
    read_timeout: 50s # the S3 connection timeout
-   max_retries: 3 # number of retries if a request fails
    use_throttle_retries: true # whether the client should wait a progressively longer amount of time (exponential backoff) between each successive retry
    ```
 

docs/install/deb.md

@@ -37,8 +37,8 @@ These steps assume you're using Ubuntu 18.04.
 1. Install Elasticsearch OSS:
 
    ```bash
-   wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-oss-7.3.2-amd64.deb
-   sudo dpkg -i elasticsearch-oss-7.3.2-amd64.deb
+   wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-oss-7.4.2-amd64.deb
+   sudo dpkg -i elasticsearch-oss-7.4.2-amd64.deb
    ```
 
 1. Install the latest version of Open Distro for Elasticsearch:

docs/install/docker-security.md

@@ -16,7 +16,7 @@ Before deploying to a production environment, you should replace the demo securi
 version: '3'
 services:
   odfe-node1:
-    image: amazon/opendistro-for-elasticsearch:1.3.0
+    image: amazon/opendistro-for-elasticsearch:1.4.0
     container_name: odfe-node1
     environment:
       - cluster.name=odfe-cluster
@@ -52,7 +52,7 @@ services:
     networks:
       - odfe-net
   odfe-node2:
-    image: amazon/opendistro-for-elasticsearch:1.3.0
+    image: amazon/opendistro-for-elasticsearch:1.4.0
     container_name: odfe-node2
     environment:
       - cluster.name=odfe-cluster
@@ -85,7 +85,7 @@ services:
     networks:
       - odfe-net
   kibana:
-    image: amazon/opendistro-for-elasticsearch-kibana:1.3.0
+    image: amazon/opendistro-for-elasticsearch-kibana:1.4.0
     container_name: odfe-kibana
     ports:
       - 5601:5601

docs/install/docker.md

@@ -10,8 +10,8 @@ nav_order: 1
 You can pull the Open Distro for Elasticsearch Docker image just like any other image:
 
 ```bash
-docker pull amazon/opendistro-for-elasticsearch:1.3.0
-docker pull amazon/opendistro-for-elasticsearch-kibana:1.3.0
+docker pull amazon/opendistro-for-elasticsearch:1.4.0
+docker pull amazon/opendistro-for-elasticsearch-kibana:1.4.0
 ```
 
 To check available versions, see [Docker Hub](https://hub.docker.com/r/amazon/opendistro-for-elasticsearch/tags).
@@ -33,7 +33,7 @@ Open Distro for Elasticsearch images use `centos:7` as the base image. If you ru
 To run the image for local development:
 
 ```bash
-docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" amazon/opendistro-for-elasticsearch:1.3.0
+docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" amazon/opendistro-for-elasticsearch:1.4.0
 ```
 
 Then send requests to the server to verify that Elasticsearch is up and running:
@@ -86,7 +86,7 @@ This sample file starts two data nodes and Kibana.
 version: '3'
 services:
   odfe-node1:
-    image: amazon/opendistro-for-elasticsearch:1.3.0
+    image: amazon/opendistro-for-elasticsearch:1.4.0
     container_name: odfe-node1
     environment:
       - cluster.name=odfe-cluster
@@ -110,7 +110,7 @@ services:
     networks:
       - odfe-net
   odfe-node2:
-    image: amazon/opendistro-for-elasticsearch:1.3.0
+    image: amazon/opendistro-for-elasticsearch:1.4.0
     container_name: odfe-node2
     environment:
       - cluster.name=odfe-cluster
@@ -131,7 +131,7 @@ services:
     networks:
       - odfe-net
   kibana:
-    image: amazon/opendistro-for-elasticsearch-kibana:1.3.0
+    image: amazon/opendistro-for-elasticsearch-kibana:1.4.0
     container_name: odfe-kibana
     ports:
       - 5601:5601
@@ -164,7 +164,7 @@ docker run \
 -p 9200:9200 -p 9600:9600 \
 -e "discovery.type=single-node" \
 -v /<full-path-to>/custom-elasticsearch.yml:/usr/share/elasticsearch/config/elasticsearch.yml \
-amazon/opendistro-for-elasticsearch:1.3.0
+amazon/opendistro-for-elasticsearch:1.4.0
 ```
 
 You can perform the same operation in `docker-compose.yml` using a relative path:
@@ -220,7 +220,7 @@ The `docker-compose.yml` file above also contains several key settings: `bootstr
 To run the image with a custom plugin, first create a [`Dockerfile`](https://docs.docker.com/engine/reference/builder/):
 
 ```
-FROM amazon/opendistro-for-elasticsearch:1.3.0
+FROM amazon/opendistro-for-elasticsearch:1.4.0
 RUN /usr/share/elasticsearch/bin/elasticsearch-plugin install --batch <plugin-name-or-url>
 ```
 
@@ -234,7 +234,7 @@ docker run -p 9200:9200 -p 9600:9600 -v /usr/share/elasticsearch/data odfe-custo
 You can also use a `Dockerfile` to pass your own certificates for use with the [Security](../../security-configuration/) plugin, similar to the `-v` argument in [Configure Elasticsearch](#configure-elasticsearch):
 
 ```
-FROM amazon/opendistro-for-elasticsearch:1.3.0
+FROM amazon/opendistro-for-elasticsearch:1.4.0
 COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
 COPY --chown=elasticsearch:elasticsearch my-key-file.pem /usr/share/elasticsearch/config/
 COPY --chown=elasticsearch:elasticsearch my-certificate-chain.pem /usr/share/elasticsearch/config/

docs/install/helm.md

@@ -49,7 +49,7 @@ Run the `helm init` command to make sure you also have the Tiller server install
 1. Deploy Elasticsearch:
 
    ```bash
-   helm install opendistro-es opendistro-es-1.3.0.tgz
+   helm install opendistro-es opendistro-es-1.4.0.tgz
    ```
 
 If you see a `namespaces "default" is forbidden` error, create a Tiller service account and deploy with a cluster binding role, as shown in the following example. See the [Tiller documentation](https://tiller.readthedocs.io/en/latest/) for more information.
@@ -66,7 +66,7 @@ The output shows you the specifications instantiated from the install.
 To customize the deployment, pass in the values that you want to override with a custom YAML file:
 
 ```bash
-helm install --values=customevalues.yaml opendistro-es-1.3.0.tgz
+helm install --values=customevalues.yaml opendistro-es-1.4.0.tgz
 ```
 
 #### Sample output
@@ -105,24 +105,6 @@ You can send requests to the pod to verify that Elasticsearch is up and running:
 
 ```bash
 $ curl -XGET https://localhost:9200 -u admin:admin --insecure
-
-{
-  "name" : "opendistro-es-master-1",
-  "cluster_name" : "elasticsearch",
-  "cluster_uuid" : "-bGzvzXvRmifC54-gt2pWA",
-  "version" : {
-    "number" : "7.3.2",
-    "build_flavor" : "oss",
-    "build_type" : "tar",
-    "build_hash" : "1c1faf1",
-    "build_date" : "2019-09-06T14:40:30.409026Z",
-    "build_snapshot" : false,
-    "lucene_version" : "8.1.0",
-    "minimum_wire_compatibility_version" : "6.8.0",
-    "minimum_index_compatibility_version" : "6.0.0-beta1"
-  },
-  "tagline" : "You Know, for Search"
-}
 ```
 
 To set up port forwarding to access Kibana, exit the Elasticsearch shell and run the following command:

docs/install/plugins.md

@@ -29,6 +29,19 @@ If you don't want to use the all-in-one Open Distro for Elasticsearch installati
     </tr>
   </thead>
   <tbody>
+  <tr>
+    <td>7.4.2</td>
+    <td>
+      <pre>opendistro-job-scheduler        1.4.0.0
+opendistro_alerting             1.4.0.0
+opendistro_index_management     1.4.0.0
+opendistro_performance_analyzer 1.4.0.0
+opendistro_security             1.4.0.0
+opendistro_sql                  1.4.0.0
+opendistro-knn                  1.4.0.0
+</pre>
+    </td>
+  </tr>
   <tr>
     <td>7.3.2</td>
     <td>
@@ -141,7 +154,7 @@ Navigate to the Elasticsearch home directory (most likely, it is `/usr/share/ela
 ### Security
 
 ```bash
-sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-security/opendistro_security-1.3.0.0.zip
+sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-security/opendistro_security-1.4.0.0.zip
 ```
 
 After installing the Security plugin, you can run `sudo sh /usr/share/elasticsearch/plugins/opendistro_security/tools/install_demo_configuration.sh` to quickly get started with demo certificates. Otherwise, you must configure it manually and run [securityadmin.sh](../../security-configuration/security-admin/).
@@ -152,7 +165,7 @@ Security has a corresponding [Kibana plugin](../../kibana/plugins) that you prob
 ### Alerting
 
 ```bash
-sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-alerting/opendistro_alerting-1.3.0.1.zip
+sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-alerting/opendistro_alerting-1.4.0.0.zip
 ```
 
 Alerting has a corresponding [Kibana plugin](../../kibana/plugins) that you probably want to install as well.
@@ -161,28 +174,34 @@ Alerting has a corresponding [Kibana plugin](../../kibana/plugins) that you prob
 ### SQL
 
 ```bash
-sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-sql/opendistro_sql-1.3.0.0.zip
+sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-sql/opendistro_sql-1.4.0.0.zip
 ```
 
 
 ### Index State Management
 
 ```bash
-sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-index-management/opendistro_index_management-1.3.0.1.zip
+sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-index-management/opendistro_index_management-1.4.0.0.zip
 ```
 
 
+### KNN
+
+KNN is currently only available as part of the Docker image.
+{: .warning }
+
+
 ### Anomaly Detection
 
 This is a preview plugin, which we do not recommend using in production. It's currently in development and is subject to change.
 
-To test this plugin, clone [the anomaly detection repository](https://github.com/opendistro-for-elasticsearch/anomaly-detection) and build it manually using instructions in the README.
+To test this plugin, clone [the Anomaly Detection repository](https://github.com/opendistro-for-elasticsearch/anomaly-detection) and build it manually using instructions in the README.
 
 
 ### Performance Analyzer
 
 ```bash
-sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/performance-analyzer/opendistro_performance_analyzer-1.3.0.0.zip
+sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/performance-analyzer/opendistro_performance_analyzer-1.4.0.0.zip
 ```
 
 Performance Analyzer requires some manual configuration after installing the plugin:

docs/install/rpm.md

@@ -35,7 +35,7 @@ Installing and running Open Distro for Elasticsearch from an RPM package is a mo
 1. Choose the version you'd like and install it:
 
    ```bash
-   sudo yum install opendistroforelasticsearch-1.3.0
+   sudo yum install opendistroforelasticsearch-1.4.0
    ```
 
 1. **If you installed Java 8**, run the following command:

docs/install/tar.md

@@ -14,19 +14,19 @@ The tarball supports CentOS 7, Amazon Linux 2, Ubuntu 18.04, and most other Linu
 1. Download the tarball:
 
    ```bash
-   curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistro-elasticsearch/opendistroforelasticsearch-1.3.0.tar.gz -o opendistroforelasticsearch-1.3.0.tar.gz
+   curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistro-elasticsearch/opendistroforelasticsearch-1.4.0.tar.gz -o opendistroforelasticsearch-1.4.0.tar.gz
    ```
 
 1. Download the checksum:
 
    ```bash
-   curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistro-elasticsearch/opendistroforelasticsearch-1.3.0.tar.gz.sha512 -o opendistroforelasticsearch-1.3.0.tar.gz.sha512
+   curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistro-elasticsearch/opendistroforelasticsearch-1.4.0.tar.gz.sha512 -o opendistroforelasticsearch-1.4.0.tar.gz.sha512
    ```
 
 1. Verify the tarball against the checksum:
 
    ```bash
-   shasum -a 512 -c opendistroforelasticsearch-1.3.0.tar.gz.sha512
+   shasum -a 512 -c opendistroforelasticsearch-1.4.0.tar.gz.sha512
    ```
 
    On CentOS, you might not have `shasum`. Install this package:
@@ -38,8 +38,8 @@ The tarball supports CentOS 7, Amazon Linux 2, Ubuntu 18.04, and most other Linu
 1. Extract the TAR file to a directory and change to that directory:
 
    ```bash
-   tar -zxf opendistroforelasticsearch-1.3.0.tar.gz
-   cd opendistroforelasticsearch-1.3.0
+   tar -zxf opendistroforelasticsearch-1.4.0.tar.gz
+   cd opendistroforelasticsearch-1.4.0
    ```
 
 1. Run Open Distro for Elasticsearch:

docs/install/windows.md

@@ -17,7 +17,7 @@ As an alternative, we recommend [Ubuntu for Windows 10](https://www.microsoft.co
 
 ## ZIP install
 
-1. Download [the ZIP file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/odfe-windows/ode-windows-zip/odfe-1.3.0.zip).
+1. Download [the ZIP file](https://d3g5vo6xdbdb9a.cloudfront.net/downloads/odfe-windows/ode-windows-zip/odfe-1.4.0.zip).
 
 1. Extract the file to a directory, and open that directory at the command prompt.
 

docs/ism/settings.md

@@ -5,7 +5,7 @@ parent: Index State Management
 nav_order: 4
 ---
 
-# Settings
+# ISM Settings
 
 We don't recommend changing these settings; the defaults should work well for most use cases.
 
@@ -14,7 +14,7 @@ Index State Management (ISM) stores its configuration in the `.opendistro-ism-co
 All settings are available using the Elasticsearch `_cluster/settings` operation. None require a restart, and all can be marked `persistent` or `transient`.
 
 Setting | Default | Description
-:--| :- | :--------------
+:--- | :--- | :---
 `opendistro.index_state_management.enabled` | True | Specifies whether ISM is enabled or not.
 `opendistro.index_state_management.job_interval` | 5 minutes | The interval at which the managed index jobs are run.
 `opendistro.index_state_management.coordinator.sweep_period` | 10 minutes | How often the routine background sweep is run.