Skip to content

Latest commit

 

History

History
125 lines (80 loc) · 3 KB

README.md

File metadata and controls

125 lines (80 loc) · 3 KB

Open Distro For Elasticsearch Security Parent

Open Distro for Elasticsearch Security Parent is the parent repo for the Open Distro for Elasticsearch security plugin repositories, including:

Security

Security-SSL

Security Advanced Modules

Security Kibana Plugin

Documentation

Please refer to the technical documentation for detailed information.

Requirements

Make sure you are in the elasticsearch/linux_distributions folder. Here are the instructions for installing Java (OpenJDK 11) for Debian based distributions.

sudo add-apt-repository ppa:openjdk-r/ppa
sudo apt-get update
sudo apt install openjdk-11-jdk

Build

To build the security plugin from source follow these instructions in this order:

  1. Download the security-parent source code:
git clone https://github.com/opendistro-for-elasticsearch/security-parent.git
  1. Install to the local repository folder named .m2:
cd security-parent
mvn clean install
cd ..
  1. Download the security source code:
git clone https://github.com/opendistro-for-elasticsearch/security.git
  1. Install to the local repository folder named .m2:
cd security
mvn clean install
cd ..
  1. Download the security-ssl source code:

(Note: This step is needed only for the security plug-in for Open Distro version 0.9.0 supporting Elasticsearch 6.7.1 and below.)

git clone https://github.com/opendistro-for-elasticsearch/security-ssl.git
  1. Install to the local repository folder named .m2:
cd security-ssl
mvn clean install
cd ..
  1. Download the security-advanced-modules source code:
git clone https://github.com/opendistro-for-elasticsearch/security-advanced-modules.git
  1. Install to the local repository folder named .m2:
cd security-advanced-modules
mvn clean install
cd ..
  1. Build the Elasticsearch plugin and install final artifacts:
cd security
mvn clean package -Padvanced

The above builds the final artifacts in zip format.

cd target/releases/

The artifacts can be found in the folder listed above.

  1. Detailed instructions on how to build the security-kibana plugin can be found here:

https://github.com/opendistro-for-elasticsearch/security-kibana-plugin/blob/master/README.md#build

Install

Install the plugin to your Elasticsearch cluster with the following commands:

cd elasticsearch/bin
./elasticsearch-plugin install file:///path/to/security/target/releases/opendistro_security-<version>.zip

License

This code is licensed under the Apache 2.0 License.

Copyright

Open Distro For Elasticsearch Security Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.