Allow argus-server to create tickets in Jira
Project description
argus_ticket_jira
This is a plugin to create tickets in Jira from Argus
Settings
-
TICKET_PLUGIN
:"argus_ticket_jira.JiraPlugin"
-
TICKET_ENDPOINT
:"https://jira.atlassian.net"
or link to self-hosted instance, absolute URL -
TICKET_AUTHENTICATION_SECRET
: Create an API token{ "token": token, }
If you're using a cloud-hosted instance, also add your email address:
{ "token": token, "email": email address, }
-
TICKET_INFORMATION
: Projekt key or id (obligatory)To know which project to create the ticket in the Jira API needs to know the project key or id of it. To figure out the project key visit the section
Project Key
of the Jira ticket documentation.To figure out the project id visit this guide on how to get the project id
{ "project_key_or_id": project_key_or_id, }
Task type (optional)
If the tickets should have a different type than
Task
this need to be declared.{ "type": "Epic"|"Story"|"Task"|"Bug"|"Subtask"|any other ticket type, }
Custom fields (optional)
There are two ways of automatically filling custom fields:
-
Custom fields that are always the same, independent of the incident. These will be set in
custom_fields_set
with the name of the custom field as key and the fixed value as value.{ "custom_fields_set" : { "name_of_custom_field": set_value, } }
-
Custom fields that are filled by attributes of the Argus incident. These are set in
custom_fields_mapping
with the name of the custom field as key and the name of the attribute as it is returned by the API as value (e.g.start_time
). If the information can be found in the tags the value consists of a dictionary withtag
as the key and the name of the tag as the value (e.g. {"tag": "host"}).{ "custom_fields_mapping" : { "name_of_custom_field": attribute_of_incident, "name_of_custom_field": {"tag": name_of_tag}, } }
A completely filled
TICKET_INFORMATION
could look like this:``` { "project_key_or_id": "AT", "type": "Bug", "custom_fields_set" : { "source": "Argus", }, { "custom_fields_mapping" : { "start": "start_time", "host": {"tag": "host"}, } } } ```
-
Code style
argus_ticket_jira uses black as a source code formatter. Black can be installed by running
$ pip install black
A pre-commit hook will format new code automatically before committing. To enable this pre-commit hook, run
$ pre-commit install
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for argus_ticket_jira-1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83fa78e7daaa202013b658086dfb3578741d60235c436cb500410970099340e9 |
|
MD5 | 53b6efa2b4bd9ebcf35013b95891939c |
|
BLAKE2b-256 | 880e8306ec5c2d5c002012ec102e6e40f817d682c6243828b51c41b74cf3ca7e |