This section explains the installation and configuration of Elasticsearch (ES) in Windows.

Installation with zip file

Install and configure ES on HTTPS (with authentication using username and password)

1. Download Elasticsearch 8.6.2

2. Unzip the file in the preferred location.

3. Open the command prompt as administrator and go to {directory}\elasticsearch-8.6.2\bin path.

4. Run ES with the elasticsearch.bat command.
5. When you run ES in a terminal for the first time, you get a password on the terminal as below. You must note down the password for future reference.

Open

The following is the sample .yml file.

6. Run https://localhost:9200 in browser with default user 'elastic'. Use the ES password that you got in the step4.

Open

7. Install Zephyr by giving ES URL as https://localhost:9200

8. Upon successful Zephyr installation, stop the Zephyr and navigate to the {ZephyrDir}\tomcat\webapps\flex\WEB-INF\classes location.

9. Make changes as mentioned in the below steps, to the jdbc.properties for ES running on HTTPS.

10. Uncomment elastic.rest.prop.xpack.security.user and change password after colon(:) with the ES password you got after step 4. The default username is “elastic”.

9. Start the Zephyr application after making these changes.

Install and configure ES on HTTP(without authentication)

1. Download Elasticsearch 8.6.2

2. Unzip the file in the preferred location.

3. Open the command prompt as administrator and go to {directory}\elasticsearch-8.6.2\bin path.

4. Run ES with the elasticsearch.bat command.

5. Stop the Elasticsearch.

6. Change the SSL security to false in elasticsearch.yml file in config folder as mentioned in the following sample.

   cluster.name: zephyr node.name: node-1 http.port: 9200 network.host: 192.168.0.1 xpack.security.enabled: false xpack.security.enrollment.enabled: false xpack.security.http.ssl: enabled: false xpack.security.transport.ssl: enabled: false http.host: 0.0.0.0 indices.query.bool.max_clause_count: 9024 action.auto_create_index: ".watches,.triggered_watches,.watcher-history-*,-zephyr*,+*"

7. Start Elasticsearch.

8. Now install Zephyr with ES URL http://localhost:9200

Install ES on HTTPS (using id and secret key)

1. Download Elasticsearch 8.6.2

2. Unzip the file in the preferred location.

3. Open the command prompt as administrator and go to

{directory}\elasticsearch-8.6.2\bin path.

4. Run ES with the

elasticsearch.bat command.

5. When you run ES in a terminal for the first time, you get a password on the terminal as below. You must note down the password for future reference.

The following is the sample .yml file.

6. Execute the below given cURL to generate an API key:

7. Refer to the generated API key response:

8. The <apiKey> would be base64 encoding of id:api_key i.e. base64 encoding of o3PG-n0Bf9efLymhVjzN:eR9bKD5OTeywOxovC7It2Q. You can use online utility (Base64 Encode and Decode - Online ) for base64 encoding.
9. Install the Zephyr application.

10. Upon successful Zephyr installation, stop the Zephyr and navigate to the {ZephyrDir}\tomcat\webapps\flex\WEB-INF\classes location.

11. Make changes as mentioned in the below steps, to the

jdbc.properties for ES running on HTTPS.

12. Add following properties in jdbc.properties file:

13. Start the Zephyr service.

Install ES as a service in Windows

Enable TLS 1.2 and 1.3 versions for Elasticsearch

You need to add the following two lines in the elasticsearch.yml file:

The following is the sample .yml file:

Connect Zephyr to ES

ES must be running before you install Zephyr Enterprise. You connect Zephyr to ES during the product installation. To do this, specify either the IP address of your ES server, or its host name depending on the settings you have specified in the elasticsearch.yml file.

• Single-node installation
  Specify http://192.168.0.1:9200, or http://localhost:9200 when prompted to configure Elasticsearch.