Upgrade the App to v1.1.0
For v1.1.0, Host Detection ticketing templates have new fields added hence it advised users to update their existing templates as follows,
- Stop both running containers of the Jira Connector by executing the docker-compose down command
- Update the selected ticketing template by following the steps listed below,
- Navigate to <docker-volume-dir>/_data/templates/
- Open your selected ticketing scheme template json file.
- For ticketing scheme 2,
- Open Per_Detection_Separate_Ticket_Scheme.json'
- Under 'metadata' section add new field as - "projectKey": "${PROJECT_KEY}"
- Navigate to 'payload', and remove the field "primaryKey": "${ID}-${QID}-${PORT}",
- Navigate to its 'custom_fields' section and add
- "Primary Key": "Host ID:${ID}-QID:${QID}-Port:${PORT}"
- "Asset Risk Score": "${ASSET_RISK_SCORE}",
- "Asset Criticality Score": "${ASSET_CRITICALITY_SCORE}",
- Save the file.
- For ticketing scheme 1,
- Open Host_Vuln_Linking_Ticket_Scheme.json.
- Under 'metadata' section add new field as - "projectKey": "${PROJECT_KEY}"
- Navigate to 'parent' section and remove the field - "primaryKey": "${ID}",
- Navigate to 'custom_fields' section and add,
- "Primary Key": "Host ID:${ID}"
- "Asset Risk Score": "${ASSET_RISK_SCORE}",
- "Asset Criticality Score": "${ASSET_CRITICALITY_SCORE}",
- Save the file.
- Navigate to 'relatedTicket' section
- Remove the field - "primaryKey": "${QID}-${PORT}",
- Navigate to 'custom_fields' section and add, "Primary Key": "QID:${QID}-Port:${PORT}"
- Save the file.
Get Latest Docker Images
If you are using docker compose,
- Update your docker-compose.yml file with latest images of Jira connector application, (you can get the latest images in docker-compose.yml file maintained on Github).
- Update the redis-related inputs in the docker-compose.yml file for fields 'SPRING_REDIS_HOST' and Port (if custom ports are to be used). Ensure the SPRING_REDIS_HOST' is the Host IP address where the Jira Connector app is running.
Refer below for the v1.1.0 specific docker-compose.yml file content with sample inputs for redis IP and Port field.
Sample - yml
version: "3.7" services: qualys-client-service: image: qualys/qualys-client-for-jira-integration:1.1.0 networks: - qualys-jira-connector volumes: - qualys-jira-volume:/opt/qualys/common/jiraconnector/ environment: - SPRING_REDIS_HOST=10.10.10.10 - SPRING_REDIS_PORT=6379 - SPRING_REDIS_USER=default - SPRING_REDIS_PASSWORD=JiraConnectorRedisDB redis-client-service: image: qualys/redis-client:1.1.0 networks: - qualys-jira-connector ports: - 6379:6379 volumes: - qualys-jira-volume:/opt/qualys/common/jiraconnector/ jira-client-service: image: qualys/jira-client-for-jira-integration:1.1.0 networks: - qualys-jira-connector volumes: - qualys-jira-volume:/opt/qualys/common/jiraconnector/ depends_on: - qualys-client-service networks: qualys-jira-connector: volumes: qualys-jira-volume:
- Save the yml file.
- Spin the Jira connector application again using docker-compose up or docker-compose up -d. This downloads new images in your environment and also bring the new changes into your docker volume.
If you are not using docker compose, then
- Stop both of the running containers using the command
'docker container stop <container name>'
. - Check the new images released for Jira connector application.
- Pull the latest images into your environment.
- Follow the same steps to update the template file as described above for ‘if you are using docker compose’.
- Spin up the containers once again with latest images using the following commands,
Qualys client service container -
docker run -d\
--network=qualys-jira-connector \
--volume qualys-jira-volume:/opt/qualys/common/jiraconnector/ \
--env SPRING_REDIS_HOST=#VM-ip-Address \
--env SPRING_REDIS_PORT=#Port-number \
--env SPRING_REDIS_USER=default \
--env SPRING_REDIS_PASSWORD=JiraConnectorRedisDB \
qualys/qualys-client-for-jira-integration:1.1.0The SPRING_REDIS_HOST should be the host IP on which the Jira connector app is running.
Redis -
docker run -d\
--network=qualys-jira-connector \
--publish port-no-same-as-SPRING_REDIS_PORT:port-no \
--volume qualys-jira-volume:/opt/qualys/common/jiraconnector/ \
qualys/redis-test:1.1.0Jira Client service container -
docker run -d\
--network=qualys-jira-connector \
--volume qualys-jira-volume:/opt/qualys/common/jiraconnector/ \
qualys/jira-client-for-jira-integration:1.1.0The '--network' parameter should contain the original name of the network provided during Jira Connector setup.