Info |
---|
Info |
This guide explains how to add a Jira account to Cloudaware and configure actions for Cloudaware to set up auto-discovery of automatically discover Jira issues in the CMDB and/or create issues in Jira based on specific specified criteria met in Cloudaware. |
To see how Cloudaware seamlessly integrates with Jira in action, request a demo.
Table of Contents |
---|
Introduction
Cloudaware offers several key capabilities of for integrating with Atlassian Jira:
Auto-discovery of Jira issues related to specific CMDB objects and importing them from Jira to CloudawareCreating a Jira issue whenever any specific criteria is met in Cloudaware CIs
Creation and updating of Jira issues when specific criteria are met (e.g., new incident, policy violation, vulnerability scan, etc. ) and posting a comment to the existing Jira issue (e.g. new vulnerability has been detected as fixed, etc.)
Configuring Auto-discovery and Import of Jira Issues to CMDB
Adding Jira Integration to Cloudaware
Cloudaware can discover Jira issues and automatically add them to the corresponding CMDB objects.
...
Follow these steps to integrate your Jira account with Cloudaware:
...
is found)
Configure auto-discovery of Jira issues in Cloudaware CMDB
Add Jira account to Cloudaware
Log in to Cloudaware account → Admin.
...
...
Find Jira Accounts & Actions in the list of Cloud Integrations
...
. Click +Add.
...
...
Fill
...
out the form:
WHERE
Name - a meaningful name for Jira integration, e.g. Prod Jira
URL - Jira URL in the format https://jira.
...
companyname.com
...
Password -
...
Jira password (for cloud version of Jira, use a token)
Ensure that the user whose credentials are used in the form has the appropriate level of access. All Jira projects that are visible for this user will be collected by Cloudaware.
...
by Cloudaware.
Retrieve issues for the last - select a time period from the drop-down list
Trust Certificate - check this check box only if your Jira runs on a private network and TunHub Gatewaygateway has been set up by Cloudaware 4. (in this case, the URL will be in the format https://tunhub.cloudaware.com:12345)
Click Save.
The green light in 'Status' means
...
that Jira account has been successfully added. If there is a red light, please contact support@cloudaware.com.
...
...
Create custom fields in Jira
For Cloudaware to automatically associate a discovered Jira issue issues with a CMDB object, a Jira issue should have two custom fieldsCIs, add the following custom fields* in Jira:
Object Type
Object Identifier
Tip |
---|
Object identifier is a cloud provider ARN for that object, for example: Object Type: AWS ELB Load Balancer |
...
...
Note |
---|
*The custom Jira field |
...
should be a text/string |
...
. |
Set the values for these custom fields manually or using internal Jira processes.
...
Configure auto-creation of Jira
...
issues from Cloudaware
Cloudaware can send sends an outbound message to Jira whenever a specific criteria is are met, which will automatically create a Jira issue in the appropriate Jira project. Cloudaware can also post a comment to your Jira issue once the conditions that have triggered the ticket creation change. Let's review the following use case. A seсurity team wants
Use case: A security team needs a Jira issue
...
created
...
for a specific project
...
whenever Cloudaware detects a high-risk vulnerability. The team also requires notifications when a
...
vulnerability is
...
marked as fixed to minimize manual work in checking and closing Jira issues
...
. Posting a comment on the issue could serve as an effective trigger for bulk-closing tickets.
Manage
...
permissions and
...
create fields in Jira
...
Grant Cloudaware
...
the
user/project: ADD_COMMENTS
permission
...
.
...
Log
...
to the Cloudaware account
...
and navigate to Setup → Objects.
...
Select
...
the object
...
for which Jira issues
...
should be created for (
...
for example, CloudAware Vulnerability Scan).
...
Review the section 'Custom Fields & Relationships' to define fields that should be displayed in an issue's description.
...
For our use case
...
, the following fields are used: Priority, Risk, Severity, CVSS Number, Host, Port, Protocol, Description, Disappearance Time.
Note |
---|
Use Cloudaware Field Label names when When creating fields in your Jira Jira, use Field Label names from Cloudaware, as fields names MUST must match. |
...
Set up Jira Actions integration in Cloudaware
Anchor | ||||
---|---|---|---|---|
|
Note that you should add your Jira Account to Cloudaware before setting up Jira Actions.
...
Log in to Cloudaware account → Admin.
...
Find Jira Accounts & Actions in the list of Cloud Integrations, click N
...
CONFIGURED*.
...
*Note that Jira account must be added to Cloudaware before setting up Jira actions.
Select the tab 'Jira Actions'. Click +
...
ADD JIRA ACTION.
...
...
Fill
...
out the
...
form:
WHERE
Name - a meaningful name for
...
Jira action, e.g. New Vulnerability Detected
Jira
...
Account - select the pre-configured Jira
...
account
Project - select
...
the Jira project where issues will be created in
Issue Type - select the issue type (issue types are managed in
...
Jira)
Summary -
...
a summary
...
of Jira issues
...
(in this example, we use sObject.Name to display the full name of CloudAware Vulnerability Scan
...
)
Description -
...
a description
...
to be added
...
to the Jira issue body
Comment -
...
text
...
to be displayed as a Cloudaware comment
...
For our use case, we
...
use
sObject.CA10disappearanceTime__c
, whereCA10disappearanceTime__c
is the API Name of the field showing the date and time when the vulnerability was deleted from the scanner.
Tip |
---|
Pay attention to using expression fields. The data type of the value returned depends on the elements used in the expression. Here below are sample outputs: |
Expression | Output |
---|---|
test | test |
sObject.Name | 'the name of this field in your org' |
'sObject.Name' | sObject.Name |
'Hey, ' + sObject.Name | Hey, 'the name of this field in your org' |
Field List - determine list the fields you'd like to be displayed in a Jira issue and Cloudaware comment.
Note |
---|
Use API names for fields. The integration must include all the fields you plan to use in notifications. The order you choose for the fields will be reflected in a Jira issue. |
...
5. Click Save.6.
Copy and save the URL as it is required for further configuration in Cloudaware.
...
...
Set up Cloudaware
...
workflows to
...
create issues and post comments in Jira
Anchor | ||||
---|---|---|---|---|
|
Once you have configured Jira Action, set up two different workflow rules - for creating a Jira issue (1) and adding a comment (2).
1. Workflow Rule for Jira issue creation:
...
Click Save&Next.
Add Workflow Action → New Outbound Message:
Object: CloudAware Vulnerability Scan
Name: Jira Notification: New Vulnerability Detected
Endpoint URL: paste the URL copied from the integration's details
Select the fields to be displayed as set up in the Integration details:
...
Note that Name is a mandatory field.
Click Done. Click Activate to activate your workflow.
2. Workflow Rule for posting a comment in Jira issue:
...
Object: CloudAware Vulnerability Scan
Name: Jira Notification: Vulnerability Fixed
Endpoint URL: paste the URL copied from the integration's details
Select the fields to be displayed as set up in the Integration details:
...
Click Done. Click Activate to activate your workflow.
Jira issue sampleexample | Cloudaware comment sampleexample |
---|---|
Jira issue sample in Cloudaware CMDB |
---|
Bulk
...
close Jira issues with Cloudaware
...
comments
Based on our use case, we can consider all issues with a comment as not requiring further actions since a vulnerability the Jira issue informs of has been fixed.
Follow these steps to configure automatic change of issue status to 'Resolved':
In your Service Desk project select Project settings → Automation.
Select Add rule.
Select Custom rule from the list, then select Next.
Give your custom rule a name and a description.
Configure your rule by defining the WHEN, IF, and THEN fields:
5.1. When comment added
5.2. If comment contains This vulnerability is fixed and deleted on
5.3. Then transition issue to status "Resolved"
...
...
Populate custom fields in Jira
Anchor | ||||
---|---|---|---|---|
|
This option requires having custom fields Object Type, Object Identifier and fields that were created for the Jira Notification integrationactions.
Based on our use case, we can consider having all custom field values populated automatically. This will also provide a great visibility in Cloudaware CMDB as each Jira issue will be linked to a CMDB record.
...