| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
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 |
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
AuditService Service Deployment (Jar)
Create a directory under folder opt “zephyrservice”
| Code Block |
|---|
mkdir zephyrservice |
Download the ze-audit-service.jar and copy it under
zephyrserviceCreate a ze-audit-service.jar config file Named “
zeAuditService.properties" under folderzephyrservice
| Code Block |
|---|
vi zeAuditService.properties |
Add the below line
...
to the file zeAuditService.properties
...
| Code Block |
|---|
server.port=80828083 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:
| View file | ||
|---|---|---|
|
| Code Block |
|---|
server.port=80828083 #Rabbitmq config zephyr.queue.name=ze_audit_queue zephyr.queue.exchange=ze_audit_exchange zephyr.queue.routing.key=ze_audit_routing_key spring.rabbitmq.host=localhost spring.rabbitmq.port=5672 spring.rabbitmq.username=guest spring.rabbitmq.password=guest |
| Info |
|---|
|
Start the AuditService with the following command.
| Code Block |
|---|
sudo nohup java -jar -DzeAuditConfigPath="<config file path till root folder>" ze-audit-service.jar & |
Example command:
| Code Block |
|---|
sudo nohup java -jar -DzeAuditConfigPath="/homeopt/ubuntu/Foldernamezephyrservice" ze-audit-service.jar & |
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”
| Code Block |
|---|
mkdir zephyrservice |
Download the Docker compose and copy it under zephyrservice
| View file | ||
|---|---|---|
|
| Code Block | ||
|---|---|---|
| ||
#dockercompose
version: '3.5'
services:
#AuditService
ze-audit-service:
image: smartbear/zeauditservices:ze-audit-service
container_name: ze-audit-service
ports:
- "8083:8083"
environment:
- server_port=8083
volumes:
- ./propertiesFile/zeAuditService.properties:/usr/src/app/zeAuditService.properties
networks:
- audit_service
networks:
audit_service:
name: webhook_service
external: true |
Create a ze-audit-service.jar config file Named “
zeAuditService.properties" under folderzephyrservice
| Code Block |
|---|
vi zeAuditService.properties |
Add the below line to the file zeAuditService.properties
| Code Block |
|---|
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:
| View file | ||
|---|---|---|
|
| Code Block |
|---|
server.port=8083
#Rabbitmq config
zephyr.queue.name=ze_audit_queue
zephyr.queue.exchange=ze_audit_exchange
zephyr.queue.routing.key=ze_audit_routing_key
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest |
| Info |
|---|
|
Start the ze-jira-webhook with docker with the following command:
Navigate to zephyrservice and run the below command:
| Code Block |
|---|
docker-compose up -d |
The audit started snapshot for reference: -
...
Verification in the browser:
Verify webhook application status by using HTTP://<hostname>:8083/actuator/health.