Enable Authentication for Elasticsearch 7.16.2
Enable Authentication in Elasticsearch
By default, Elasticsearch doesn’t have authentication enabled. Typically, the Elasticsearch and Zephyr servers work in the same local network, and the connection between them is not “visible” outside that network.
You may need to turn on authentication in Elasticsearch, if your local security policy requires this, or if your Elasticsearch server can be accessed from the Web. Generally speaking, it is considered to be good practice to do this to increase the security level.
Supported Elasticsearch version
Use Elasticsearch version 7.16.2. You can download it from the Elasticsearch website:
https://www.elastic.co/downloads/past-releases/elasticsearch-7-16-2
1. Install and configure Elasticsearch
You can enable Elasticsearch authentication at any time after installing Zephyr Enterprise Server.
To enable authentication, you will have to restart the Zephyr server. So, select the appropriate time for this not to affect other users or automated test runs.
The configuration steps vary a little depending on the server operating system: Windows or Linux. See below for details.
Download Elasticsearch and unpack the downloaded .zip archive.
Find the <Elasticsearch>/config/elasticsearch.yml file and set the
xpack.security.enabled
setting in it totrue
(by default, this setting isfalse
):xpack.security.enabled: true
Configure the other settings in the file as described in Install and Run Elasticsearch.
Now we will generate a certificate and user passwords.
2. Configure Zephyr instance
After you install and configure Elasticsearch, you need to configure your Zephyr instance:
Stop the Zephyr service and Elasticsearch if they are is running.
Open the <Zephyr>/tomcat/webapps/flex/WEB-INF/classes/jdbc.properties file in any text editor and add the following line to it:
elastic.rest.prop.xpack.security.user = username:password
Note: Use the username and password of your Elasticsearch server you configured earlier.
3. Start Elasticsearch.
4. Restart the Zephyr service.
See Also
Zephyr On-Premise Production Installation
Zephyr On-Premise Upgrade Instructions
Install & Run Elasticsearch
Starting Release 8.2, Zephyr Enterprise documentation is moving from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise Documentation page. https://support.smartbear.com/zephyr-enterprise/docs/en/welcome-to-zephyr-enterprise.html