ZE-AuditService Deployment
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/zephyr-enterprise-services/ze-auditservice-deployment.html
Prerequisite
Install Java 17.
Ensure your Zephyr and Rabbit MQ application is set up and running, For RabbitMq Setup follow the instructions on the following page.
[By launching the application in the browser:Launch Zephyr with your respective host/domain. Ex: https://test.yourzephyr.com
Launch RabbitMq with the host and configured port. Ex: http://localhost:15672]
Launch RabbitMq Management in the browser with the host and port (Ex: http://localhost:15672).
AuditService Service Deployment (Jar)
Create a directory under folder opt “zephyrservice”
mkdir zephyrservice
Download the ze-audit-service.jar and copy it under
zephyrservice
Create a ze-audit-service.jar config file Named “
zeAuditService.properties
" under folderzephyrservice
vi zeAuditService.properties
Add the below line to the file zeAuditService.properties
server.port=8083
zephyr.queue.name=ze_audit_queue
zephyr.queue.exchange=ze_audit_exchange
zephyr.queue.routing.key=ze_audit_routing_key
# hostname should point to continer name if in case you are running webhook on docker
spring.rabbitmq.host=<rabbitmq_hostname>
spring.rabbitmq.port=<rabbitmq_port>
spring.rabbitmq.username=<rabbitmq_username>
spring.rabbitmq.password=<rabbitmq_password>
An example of zeAuditService.properties
should look like the below:
Make sure port 8083 is available.
zeAuditService
should be able to connect with RabbitMQ.
Start the AuditService with the following command.
Example command:
The audit started snapshot for reference: -
Note: -
The Logs folder will be created where your jars are deployed. Separate log files will be created for each jar.
Verification in the browser:
Verify webhook application status by using HTTP://<hostname>:8083/actuator/health.
AuditService Service Deployment (Docker)
Install Docker in the System
Create a directory under folder opt “zephyrservice”
Download the Docker compose and copy it under zephyrservice
Create a ze-audit-service.jar config file Named “
zeAuditService.properties
" under folderzephyrservice
Add the below line to the file zeAuditService.properties
An example of zeAuditService.properties
should look like the below:
Start the ze-jira-webhook with docker with the following command:
Navigate to zephyrservice and run the below command:
The audit started snapshot for reference: -
Verification in the browser:
Verify webhook application status by using HTTP://<hostname>:8083/actuator/health.
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