ZE-AuditService Deployment
Prerequisite
Install Java 17.0.10.
Ensure your Zephyr and Rabbit MQ application is set up and running. See, RabbitMQ Deployment.
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”
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:server.port=8082#Rabbitmq configzephyr.queue.name=ze_audit_queuezephyr.queue.exchange=ze_audit_exchangezephyr.queue.routing.key=ze_audit_routing_keyspring.rabbitmq.host=localhostspring.rabbitmq.port=5672spring.rabbitmq.username=guestspring.rabbitmq.password=guest
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
Notice
Make sure port 8083 is available.
zeAuditService
should be able to connect with RabbitMQ.
Start the AuditService with the following command
sudo nohup java -jar -DzeAuditConfigPath="<config file path till root folder>" ze-audit-service.jar &
Example command:
sudo nohup java -jar -DzeAuditConfigPath="/opt/zephyrservice" 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"
mkdir zephyrservice
Download the Docker compose and copy it under
zephyrservice
#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
vi zeAuditService.properties
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:server.port=8082#Rabbitmq configzephyr.queue.name=ze_audit_queuezephyr.queue.exchange=ze_audit_exchangezephyr.queue.routing.key=ze_audit_routing_keyspring.rabbitmq.host=localhostspring.rabbitmq.port=5672spring.rabbitmq.username=guestspring.rabbitmq.password=guest
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
Notice
Make sure port 8083 is available.
zeAuditService
should be able to connect with RabbitMQ.
Start the ze-jira-webhook with docker with the following command:
Navigate to zephyrservice and run the below command:
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.