ZE - Webhook Deployment

Install Java 17.0.10

Ensure your Zephyr and Rabbit MQ application is set up and running, For RabbitMq Setup follow the instructions here RabbitMQ Deployment

[By launching the application in the browser:

Launch RabbitMq Management in the browser with the host and port (Ex http://localhost:15672/).

Create a directory under folder opt “zephyrservice”.

mkdir zephyrservice

Download the ze-jira-webhook.jar and copy it under zephyrservice.

Create a ze-jira-webhook config file Named “zeJiraWebhook.properties" under folder zephyrservice.

vi zeJiraWebhook.properties

Add the below line in the file zeJiraWebhook.properties.

#Webhook Service port server.port=8081 #context path property server.servlet.context-path=/webhook #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 #ssl properties #uncomment the below line and add the SSL #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>

An example of zeJiraWebhook.properties should look like:

#Webhook Service portserver.port=443#Rabbitmq configzephyr.queue.name=ze_queuezephyr.queue.exchange=ze_exchangezephyr.queue.routing.key=ze_routing_keyspring.rabbitmq.host=localhostspring.rabbitmq.port=5672spring.rabbitmq.username=guestspring.rabbitmq.password=guest# ze_jira_webhook flagsevent.validator.json.file=classpath:webhook-events-validation.jsonze.jira.webhook.event.validation_flag = false

#Webhook Service port server.port=8081 #context path property server.servlet.context-path=/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

Open the “Terminal” or “Command Prompt”

Navigate to folder /opt/zephyrservice

Type the below command:

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:
  #webhookservice
  ze-jira-webhook:
    image: smartbear/zejirawebhook:ze-jira-webhook
    container_name: ze-jira-webhook
    ports:
      - "8081:8081"
      - "8000:8000"
    environment:
      - server_port=8081
    volumes:
      - ./zeJiraWebhook.properties:/usr/src/app/zeJiraWebhook.properties
    networks:
      - webhook_service
networks:
  webhook_service:
    name: zephyr
    external: true

Create a ze-jira-webhook config file Named “zeJiraWebhook.properties" under the folder zephyrservice

vi zeJiraWebhook.properties

Add the below line in the file zeJiraWebhook.properties

#Webhook Service port
server.port=8081

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

#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

#ssl properties 
#uncomment the below line and add the SSL 
#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>

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

#Webhook Service port
server.port=8081

#context path property
server.servlet.context-path=/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

Navigate to zephyrservice and run the below command.

docker-compose up -d