Skip to main content

Jira

The Jira Consumer allows you to publish Vulnerability Issues to your organisation's Jira workspace straight from the Smithy pipeline results.

You need to provide both the api token and the email of the user who owns the api token for this component to authenticate.

How to use

Open-Source

  1. Add the Helm package to the pipeline settings:
---
# file: ./my-pipeline/kustomization.yaml
kind: Kustomization
components:
- pkg:helm/smithy-security-oss-components/consumer-jira
  1. Configure the run parameters of the component in the pipeline run file:
# file: ./my-pipeline/pipelinerun.yaml
---
...
spec:
params:
- name: consumer-jira-url
value: <Your Jira URL>
- name: consumer-jira-api-token
value: <Your Jira API token>
- name: consumer-jira-user
value: <Your Jira user>
- name: consumer-jira-project-name
value: <Your Jira project name, needs to match on Jira>
- name: consumer-jira-issue-type
value: <Your Jira issue type, needs to match on Jira>

SaaS

  1. In the Smithy UI, open the page to create a new workflow.
  2. Find the Jira component in the Consumers dropdown.
  3. Click on the Jira flow icon to bring the form to the top
  4. Fill the form on the right

Options

You can configure this component with the following options. The options that have a default value are optional. The options that have a default value are optional:

Option NameDescriptionDefaultType
[Required] consumer-jira-urlDomain where your Jira workspace is hostedString
[Required] consumer-jira-api-tokenJira API token. See how to get one hereString
[Required] consumer-jira-userThe user who will be named as the ticket creator on Jira. ([email protected])String
consumer-jira-project-nameThe Project Name parameter needs to match the project name on Jira""String
consumer-jira-issue-typeThe Issue Type parameter needs to match the exact issue type of the project on Jira. Jira does not support multiple issue types per board."Task"String