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

Commit

Permalink
Preparing for 1.9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
aetter committed Jun 30, 2020
1 parent e97ebd4 commit 96dcd7c
Show file tree
Hide file tree
Showing 18 changed files with 68 additions and 53 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This repository contains the documentation for Open Distro for Elasticsearch, a
## New releases

1. Branch.
1. Run a find and replace for `:x.y.z` and `-x.y.z` and replace with the new version string.
1. Run a find and replace for `:x.y.z`, `-x.y.z`, and `_x.y.z` and replace with the new version string.
1. Run a find for the underlying Elasticsearch version and update it as necessary (probably just `docs/install/deb.md`).
1. Start up a new cluster using the updated Docker Compose file in `docs/install/docker.md`.
1. Update the version table in `version-history.md`.
Expand Down
2 changes: 1 addition & 1 deletion docs/elasticsearch/snapshot-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0
FROM amazon/opendistro-for-elasticsearch:1.9.0

ENV AWS_ACCESS_KEY_ID <access-key>
ENV AWS_SECRET_ACCESS_KEY <secret-key>
Expand Down
4 changes: 2 additions & 2 deletions docs/install/deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,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.7.0-amd64.deb
sudo dpkg -i elasticsearch-oss-7.7.0-amd64.deb
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-oss-7.8.0-amd64.deb
sudo dpkg -i elasticsearch-oss-7.8.0-amd64.deb
```

1. Install the latest version of Open Distro for Elasticsearch:
Expand Down
6 changes: 3 additions & 3 deletions docs/install/docker-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0
image: amazon/opendistro-for-elasticsearch:1.9.0
container_name: odfe-node1
environment:
- cluster.name=odfe-cluster
Expand Down Expand Up @@ -52,7 +52,7 @@ services:
networks:
- odfe-net
odfe-node2:
image: amazon/opendistro-for-elasticsearch:1.8.0
image: amazon/opendistro-for-elasticsearch:1.9.0
container_name: odfe-node2
environment:
- cluster.name=odfe-cluster
Expand Down Expand Up @@ -85,7 +85,7 @@ services:
networks:
- odfe-net
kibana:
image: amazon/opendistro-for-elasticsearch-kibana:1.8.0
image: amazon/opendistro-for-elasticsearch-kibana:1.9.0
container_name: odfe-kibana
ports:
- 5601:5601
Expand Down
20 changes: 10 additions & 10 deletions docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0
docker pull amazon/opendistro-for-elasticsearch-kibana:1.8.0
docker pull amazon/opendistro-for-elasticsearch:1.9.0
docker pull amazon/opendistro-for-elasticsearch-kibana:1.9.0
```

To check available versions, see [Docker Hub](https://hub.docker.com/r/amazon/opendistro-for-elasticsearch/tags).
Expand All @@ -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.8.0
docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" amazon/opendistro-for-elasticsearch:1.9.0
```

Then send requests to the server to verify that Elasticsearch is up and running:
Expand Down Expand Up @@ -86,7 +86,7 @@ This sample file starts two data nodes and Kibana.
version: '3'
services:
odfe-node1:
image: amazon/opendistro-for-elasticsearch:1.8.0
image: amazon/opendistro-for-elasticsearch:1.9.0
container_name: odfe-node1
environment:
- cluster.name=odfe-cluster
Expand All @@ -110,7 +110,7 @@ services:
networks:
- odfe-net
odfe-node2:
image: amazon/opendistro-for-elasticsearch:1.8.0
image: amazon/opendistro-for-elasticsearch:1.9.0
container_name: odfe-node2
environment:
- cluster.name=odfe-cluster
Expand All @@ -131,7 +131,7 @@ services:
networks:
- odfe-net
kibana:
image: amazon/opendistro-for-elasticsearch-kibana:1.8.0
image: amazon/opendistro-for-elasticsearch-kibana:1.9.0
container_name: odfe-kibana
ports:
- 5601:5601
Expand Down Expand Up @@ -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.8.0
amazon/opendistro-for-elasticsearch:1.9.0
```

You can perform the same operation in `docker-compose.yml` using a relative path:
Expand Down Expand Up @@ -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.8.0
FROM amazon/opendistro-for-elasticsearch:1.9.0
RUN /usr/share/elasticsearch/bin/elasticsearch-plugin install --batch <plugin-name-or-url>
```

Expand All @@ -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.8.0
FROM amazon/opendistro-for-elasticsearch:1.9.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/
Expand All @@ -244,7 +244,7 @@ COPY --chown=elasticsearch:elasticsearch my-root-cas.pem /usr/share/elasticsearc
Alternately, you might want to remove a plugin. This `Dockerfile` removes the security plugin:
```
FROM amazon/opendistro-for-elasticsearch:1.8.0
FROM amazon/opendistro-for-elasticsearch:1.9.0
RUN /usr/share/elasticsearch/bin/elasticsearch-plugin remove opendistro_security
COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
```
Expand Down
4 changes: 2 additions & 2 deletions docs/install/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0.tgz
helm install opendistro-es opendistro-es-1.9.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.
Expand All @@ -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.8.0.tgz
helm install --values=customevalues.yaml opendistro-es-1.9.0.tgz
```

#### Sample output
Expand Down
28 changes: 21 additions & 7 deletions docs/install/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ If you don't want to use the all-in-one Open Distro for Elasticsearch installati
</tr>
</thead>
<tbody>
<tr>
<td>7.8.0</td>
<td>
<pre>opendistro-anomaly-detection 1.9.0.0
opendistro-job-scheduler 1.9.0.0
opendistro-knn 1.9.0.0
opendistro_alerting 1.9.0.0
opendistro_index_management 1.9.0.0
opendistro_performance_analyzer 1.9.0.0
opendistro_security 1.9.0.0
opendistro_sql 1.9.0.0
</pre>
</td>
</tr>
<tr>
<td>7.7.0</td>
<td>
Expand Down Expand Up @@ -182,7 +196,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.8.0.0.zip
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-security/opendistro_security-1.9.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/).
Expand All @@ -193,14 +207,14 @@ The security plugin has a corresponding [Kibana plugin](../../kibana/plugins) th
### Job Scheduler

```bash
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-job-scheduler/opendistro-job-scheduler-1.8.0.0.zip
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-job-scheduler/opendistro-job-scheduler-1.9.0.0.zip
```


### Alerting

```bash
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-alerting/opendistro_alerting-1.8.0.0.zip
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-alerting/opendistro_alerting-1.9.0.0.zip
```

To install Alerting, you must first install the Job Scheduler plugin. Alerting has a corresponding [Kibana plugin](../../kibana/plugins) that you probably want to install as well.
Expand All @@ -209,14 +223,14 @@ To install Alerting, you must first install the Job Scheduler plugin. Alerting h
### SQL

```bash
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-sql/opendistro_sql-1.8.0.0.zip
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-sql/opendistro_sql-1.9.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.8.0.0.zip
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-index-management/opendistro_index_management-1.9.0.0.zip
```

To install Index State Management, you must first install the Job Scheduler plugin.
Expand All @@ -230,14 +244,14 @@ KNN is only available as part of the all-in-one installs: Docker, RPM, and Debia
### Anomaly Detection

```bash
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-anomaly-detection/opendistro-anomaly-detection-1.8.0.0.zip
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/opendistro-anomaly-detection/opendistro-anomaly-detection-1.9.0.0.zip
```


### Performance Analyzer

```bash
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/performance-analyzer/opendistro_performance_analyzer-1.8.0.0.zip
sudo bin/elasticsearch-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/elasticsearch-plugins/performance-analyzer/opendistro_performance_analyzer-1.9.0.0.zip
```

Performance Analyzer requires some manual configuration after installing the plugin:
Expand Down
2 changes: 1 addition & 1 deletion docs/install/rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,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.8.0
sudo yum install opendistroforelasticsearch-1.9.0
```

1. **If you installed Java 8**, run the following command:
Expand Down
10 changes: 5 additions & 5 deletions docs/install/tar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.8.0.tar.gz -o opendistroforelasticsearch-1.8.0.tar.gz
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistro-elasticsearch/opendistroforelasticsearch-1.9.0.tar.gz -o opendistroforelasticsearch-1.9.0.tar.gz
```

1. Download the checksum:

```bash
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistro-elasticsearch/opendistroforelasticsearch-1.8.0.tar.gz.sha512 -o opendistroforelasticsearch-1.8.0.tar.gz.sha512
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistro-elasticsearch/opendistroforelasticsearch-1.9.0.tar.gz.sha512 -o opendistroforelasticsearch-1.9.0.tar.gz.sha512
```

1. Verify the tarball against the checksum:

```bash
shasum -a 512 -c opendistroforelasticsearch-1.8.0.tar.gz.sha512
shasum -a 512 -c opendistroforelasticsearch-1.9.0.tar.gz.sha512
```

On CentOS, you might not have `shasum`. Install this package:
Expand All @@ -40,8 +40,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.8.0.tar.gz
cd opendistroforelasticsearch-1.8.0
tar -zxf opendistroforelasticsearch-1.9.0.tar.gz
cd opendistroforelasticsearch-1.9.0
```

1. Run Open Distro for Elasticsearch:
Expand Down
4 changes: 2 additions & 2 deletions docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ As an alternative, try [Ubuntu for Windows 10](https://www.microsoft.com/en-us/p

## ZIP install

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

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

Expand All @@ -30,7 +30,7 @@ As an alternative, try [Ubuntu for Windows 10](https://www.microsoft.com/en-us/p

1. Install Java 11.

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

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

Expand Down
12 changes: 6 additions & 6 deletions docs/kibana/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Kibana is the default visualization tool for data in Elasticsearch. It also serv

You *can* start Kibana using `docker run` after [creating a Docker network](https://docs.docker.com/engine/reference/commandline/network_create/) and starting Elasticsearch, but the process of connecting Kibana to Elasticsearch is significantly easier with a Docker Compose file.

1. Run `docker pull amazon/opendistro-for-elasticsearch-kibana:1.8.0`.
1. Run `docker pull amazon/opendistro-for-elasticsearch-kibana:1.9.0`.

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).

Expand Down Expand Up @@ -59,19 +59,19 @@ You can also modify the values in `/etc/kibana/kibana.yml`.
1. Download the tarball:

```bash
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistroforelasticsearch-kibana/opendistroforelasticsearch-kibana-1.8.0.tar.gz -o opendistroforelasticsearch-kibana-1.8.0.tar.gz
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistroforelasticsearch-kibana/opendistroforelasticsearch-kibana-1.9.0.tar.gz -o opendistroforelasticsearch-kibana-1.9.0.tar.gz
```

1. Download the checksum:

```bash
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistroforelasticsearch-kibana/opendistroforelasticsearch-kibana-1.8.0.tar.gz.sha512 -o opendistroforelasticsearch-kibana-1.8.0.tar.gz.sha512
curl https://d3g5vo6xdbdb9a.cloudfront.net/tarball/opendistroforelasticsearch-kibana/opendistroforelasticsearch-kibana-1.9.0.tar.gz.sha512 -o opendistroforelasticsearch-kibana-1.9.0.tar.gz.sha512
```

1. Verify the tarball against the checksum:

```bash
shasum -a 512 -c opendistroforelasticsearch-kibana-1.8.0.tar.gz.sha512
shasum -a 512 -c opendistroforelasticsearch-kibana-1.9.0.tar.gz.sha512
```

On CentOS, you might not have `shasum`. Install this package:
Expand All @@ -83,7 +83,7 @@ You can also modify the values in `/etc/kibana/kibana.yml`.
1. Extract the TAR file to a directory and change to that directory:

```bash
tar -zxf opendistroforelasticsearch-kibana-1.8.0.tar.gz
tar -zxf opendistroforelasticsearch-kibana-1.9.0.tar.gz
cd opendistroforelasticsearch-kibana
```

Expand All @@ -100,7 +100,7 @@ You can also modify the values in `/etc/kibana/kibana.yml`.

1. Download the ZIP.

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

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

Expand Down
6 changes: 3 additions & 3 deletions docs/kibana/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Navigate to the Kibana home directory (likely `/usr/share/kibana`) and run the i
#### Security

```bash
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-security/opendistro_security_kibana_plugin-1.8.0.0.zip
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-security/opendistro_security_kibana_plugin-1.9.0.0.zip
```

This plugin provides a user interface for managing users, roles, mappings, action groups, and tenants.
Expand All @@ -34,7 +34,7 @@ This plugin provides a user interface for managing users, roles, mappings, actio
#### Alerting

```bash
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-alerting/opendistro-alerting-1.8.0.0.zip
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-alerting/opendistro-alerting-1.9.0.0.zip
```

This plugin provides a user interface for creating monitors and managing alerts.
Expand All @@ -43,7 +43,7 @@ This plugin provides a user interface for creating monitors and managing alerts.
#### Index State Management

```bash
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-index-management/opendistro_index_management_kibana-1.8.0.0.zip
sudo bin/kibana-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/kibana-plugins/opendistro-index-management/opendistro_index_management_kibana-1.9.0.0.zip
```

This plugin provides a user interface for managing policies.
Expand Down
Loading

0 comments on commit 96dcd7c

Please sign in to comment.