ZE - Webhook Deployment

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: https://smartbear.atlassian.net/wiki/spaces/PD/pages/3852992664
  [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).

Webhook Service Deployment(Jar) :-

• Download the ze-jira-webhook.jar

• Create a ze-jira-webhook config file Named “zeJiraWebhook.properties"

• Add the below line in the file zeJiraWebhook.properties.

  #Webhook Service port
  server.port=443
  
  #Rabbitmq config
  zephyr.queue.name=ze_queue
  zephyr.queue.exchange=ze_exchange
  zephyr.queue.routing.key=ze_routing_key
  spring.rabbitmq.host=<hostname>
  spring.rabbitmq.port=<port>
  spring.rabbitmq.username=<username>
  spring.rabbitmq.password=<password>
  
  #ze_jira_webhook flags
  event.validator.json.file=classpath:webhook-events-validation.json
  ze.jira.webhook.event.validation_flag = false
  

• Append below lines for ssl

  #ssl properties
  server.ssl.enabled=true
  server.ssl.key-store-type=PKCS12
  server.ssl.key-alias=<aliasname>
  server.ssl.key-store=file:<path of the certificate>
  server.ssl.key-store-password=<password>

• Append below lines for context path

  #Add below property for context path
  server.servlet.context-path=/ze-webhook

An example of zeJiraWebhook.properties should look like the below: -

#Webhook Service port
server.port=443

#context path property
server.servlet.context-path=/ze-webhook

#Rabbitmq config
zephyr.queue.name=ze_queue
zephyr.queue.exchange=ze_exchange
zephyr.queue.routing.key=ze_routing_key
spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest

# ze_jira_webhook flags
event.validator.json.file=classpath:webhook-events-validation.json
ze.jira.webhook.event.validation_flag = false

#ssl properties
server.ssl.enabled=true
server.ssl.key-store-type=PKCS12
server.ssl.key-alias=mycert
server.ssl.key-store=file:/home/ubuntu/keystore.p12
server.ssl.key-store-password=changeit

Start the ze-jira-webhook with the following command.

java -jar -DzeWebhookConfigPath="<config file path till root folder>" ze-jira-webhook_<version>

Example command:

java -jar -DzeWebhookConfigPath="/home/ubuntu/Foldername" ze-jira-webhook.jar

Verification

Verify webhook application status by using http://<hostname>:8080/actuator/health

Webhook started snapshot for reference: -

Verification in the browser: