Upgrade the App to v1.3.2

Prior to v1.3.2, the Jira Connector On-Cloud ran with Automated flow but with Jira Connector 1.3.2 Jira On-Cloud cannot run with automated flow as admin users are no longer supported. If your Instance does not contain Issue types and Custom Fields then you must create your custom issue types and custom fields to use the Jira Connector application. Refer to Additional requirements for Jira Connector for more.

For v1.3.2, we introduced additional parameters in config.json to configure multithreading and response timeouts for the Jira connector.

The newly introduced parameters are,

To Upgrade to v1.3.2, 

  1. Stop your containers
  2. Update the latest images in docker-compose.yml. You can get the latest YAML file from GitHub.
  3. Update the Ticketing template file with 1.3.2 Ticketing template file. You can get the latest Ticketing files from GitHub.
  4. In config.json set the below parameter

    1. logLevel- In “Profile” section, set the log level according to what information should be logged for each profile.

      1. TRACE -> TRACE, DEBUG, INFO, WARN, ERROR

      2. DEBUG -> DEBUG, INFO, WARN, ERROR

      3. INFO -> INFO, WARN, ERROR

      4. WARN -> WARN, ERROR

      5. ERROR -> ERROR

        The default level is 'INFO'.

    2. responseTimeout- In the “Global” section, replace the “connectionRequestTimeOut” parameter with “responseTimeout”. You can set the value up to 5 min.

    3. numberOfConcurrentTask- In the “moduleConfiguration” section, set a concurrent task for each profile to run the Jira client in multithreading mode. You can set the value up to 5 for each profile.
      For example,

      "HD":{
                  "numberOfConcurrentTask": 5
              },
              "WAS":{
                  "numberOfConcurrentTask": 3
              },
              "CS-Container":{
                  "numberOfConcurrentTask": 2
              },
              "CS-Image":{
                  "numberOfConcurrentTask": 1
            }
         }
                 

    4. createTicketsOnlyForRunningContainer- This parameter is only applicable to the CS-Image profile. In the “CS-Image” profile section, set the value to true to create image tickets only for the containers in 'Running' state.

  5. Restart your containers.

Sample Config.json for v1.3.2Sample Config.json for v1.3.2

{

    "credentials": {

        "qualys": {

            "apiUrl": "<YOUR QUALYS POD API URL HERE>",

            "username": "<YOUR QUALYS POD USERNAME HERE>",

            "password": "<YOUR QUALYS POD PASSWORD HERE>"

        },

        "jira": {

            "instanceType":"<onCloud or onPremise>",

            "instanceUrl": "<YOUR JIRA INSTANCE URL HERE>",

            "username": "<YOUR JIRA INSTANCE ADMIN USERNAME HERE>",

            "apiToken": "<YOUR JIRA API TOKEN HERE>"

        },

        "proxy": {

            "host": "<YOUR PROXY HOST HERE>",

            "port": "<YOUR PROXY PORT HERE>",

            "username": "<YOUR PROXY USERNAME HERE>",

            "password": "<YOUR PROXY PASSWORD HERE>"

        }

    },

      "global": {

        "numberOfRetriesForJiraApiCall" : 3,

        "numberOfRetriesForQualysApiCall": 3,

        "frequencyToProcessOutputFiles": 5,

        "responseTimeout": 5

      },

      "moduleConfiguration":{

        "HD":{

            "numberOfConcurrentTask": 2

        },

        "WAS":{

            "numberOfConcurrentTask": 2

        },

        "CS-Container":{

            "numberOfConcurrentTask": 2

        },

        "CS-Image":{

            "numberOfConcurrentTask": 2

      }

   },

    "profile": [

        {

            "name": "Host Detection",

            "profileId": "HD",

            "active": <true or false>,

            "frequencyInMinutes": <PROFILE FREQUENCY IN MINUTES HERE>,

            "hostAssetApiFilter": "<HOST LIST API FILTER CONDITION IF ANY HERE>",

            "filter": "<HOST DETECTION API FILTER CONDITION IF ANY HERE>",

            "projectKey": "<YOUR JIRA PROJECT KEY HERE>",

            "ticketingScheme": "<1 or 2>",

            "logLevel" : "INFO"

        },

        {

            "name": "Knowledgebase",

            "profileId": "KB",

            "active": <true or false>,

            "frequencyInMinutes": <PROFILE FREQUENCY IN MINUTES HERE>,

            "filter": "<KNOWLEDGEBASE DETECTION API FILTER CONDITION IF     ANY HERE>",

            "projectKey": "<YOUR JIRA PROJECT KEY HERE>",

            "ticketingScheme": "<1 or 2>",

            "batchSize" : "500",

            "logLevel" : "INFO"

        },

        {

            "name": "Web App Scan",

            "profileId": "WAS",

            "active": <true or false>,

            "frequencyInMinutes": <PROFILE FREQUENCY IN MINUTES HERE>,

            "filter": "<WAS API FILTER CONDITION IF ANY HERE>",

            "projectKey": "<YOUR JIRA PROJECT KEY HERE>",

            "ticketingScheme": "<3 or 4>",

            "logLevel" : "INFO"

        },

        {

            "name": "CS Container",

            "profileId": "CS-Container",

            "active": <true or false>,

            "frequencyInMinutes": <PROFILE FREQUENCY IN MINUTES HERE>,

            "filter": "<CS CONTAINER API FILTER CONDITION IF ANY HERE>",

            "projectKey": "<YOUR JIRA PROJECT KEY HERE>",

            "pageSize" : "1000",

            "ticketingScheme": "<5 or 6>",

            "logLevel" : "INFO"

        },

        {

            "name": "CS Image",

            "profileId": "CS-Image",

            "active": <true or false>,

            "frequencyInMinutes": <PROFILE FREQUENCY IN MINUTES HERE>,

            "filter": "<CS IMAGE API FILTER CONDITION IF ANY HERE>",

            "projectKey": "<YOUR JIRA PROJECT KEY HERE>",

            "pageSize" : "1000",

            "jiraTicketAction": "<Create or Update>",

            "ticketingScheme": "<7 or 8>",

            "logLevel" : "INFO",

            "createTicketsOnlyForRunningContainer": "<CREATE TICKETS FOR IMAGES LINKED TO RUNNING CONTAINERS ONLY>"

        }

    ]

}

Configuration of Ticketing Template

In v1.3.2, we have added support to handle mandatory custom fields of type - label & Select List (Single & multi choice), Number, Component System field, Paragraph, Read Only,  Short text (plain text only).

You can set mandatory field in any Ticketing Template. For example,
"component": {
  "value":"test",
   "customFieldId": "customfield_10036"
}

 

Where "component"  is the name of the mandatory field.

"test" is the  value that is applied to all the tickets created by the Jira client.

"customfield_10036" is the ID of the custom field.

To Know More, refer to Customization of Ticketing template.