Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFBDAD

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation---upgrade-guides/zephyr-on-premise-production-installation/elastic-search/elasticsearch-8-6-2/elasticsearch-single-node---in-windows.html

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

...

Code Block
languageyaml
cluster.name: zephyr
node.name: node-1
http.port: 9200
network.host: 192.168.0.1
xpack.security.enabled: true
xpack.security.enrollment.enabled: true
xpack.security.http.ssl:
  enabled: true
  keystore.path: certs/http.p12
xpack.security.transport.ssl:
  enabled: true
  verification_mode: certificate
  keystore.path: certs/transport.p12
  truststore.path: certs/transport.p12
http.host: 0.0.0.0
indices.query.bool.max_clause_count: 9024
action.auto_create_index: ".watches,.triggered_watches,.watcher-history-*,-zephyr*,+*"

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

...

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.

...

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.

    Code Block
    languageyaml
    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*,+*"

...

8. Now install Zephyr with Elasticsearch 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.

...

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

...

Info

You can also install ES on Windows as a service.

To install ES,

  1. Open the command prompt as a user or admin.

  2. Navigate to the <Elasticsearch>/bin folder.

  3. Run the following command:
    elasticsearch-service.bat install

Now check your Windows services. You will see the running Elasticsearch service.

Connect Zephyr to Elasticsearch

...

ES service.

Enable TLS 1.2 and 1.3 versions for Elasticsearch

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

Code Block
xpack.security.http.ssl:
  supported_protocols: TLSv1.3, TLSv1.2
xpack.security.transport.ssl:
  supported_protocols: TLSv1.3, TLSv1.2

The following is the sample .yml file:

Code Block
cluster.name: zephyr
node.name: node-1
http.port: 9200
network.host: 192.168.0.1
xpack.security.enabled: true
xpack.security.enrollment.enabled: true
xpack.security.http.ssl:
  enabled: true
  keystore.path: certs/http.p12
  supported_protocols: TLSv1.3, TLSv1.2
xpack.security.transport.ssl:
  enabled: true
  verification_mode: certificate
  keystore.path: certs/transport.p12
  truststore.path: certs/transport.p12
  supported_protocols: TLSv1.3, TLSv1.2
http.host: 0.0.0.0
indices.query.bool.max_clause_count: 9024
action.auto_create_index: ".watches,.triggered_watches,.watcher-history-*,-zephyr*,+*"

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

...