Skip to content

Latest commit

 

History

History
75 lines (60 loc) · 3.42 KB

using-jira-with-quads.md

File metadata and controls

75 lines (60 loc) · 3.42 KB
Raw

Using Optional JIRA Library and Tools

Internally we use the JIRA as is common with a lot of development/devops organizations. To this end we are providing some tools and libraries within QUADS with the hope it's useful to others.

jira

Requirements for JIRA QUADS Automation

The default quads.yml configuration file will have generic values for all JIRA settings, please adapt this to your environment.

  • JIRA API user with admin capability for your JIRA project.
  • Placing JIRA credentials or alternatively token auth string in /opt/quads/conf/quads.yml
ticket_url: https://projects.engineering.example.com/browse
# (optional ticket queue name) this is typically the ticket queue
# name or abbreviation in the case of JIRA
ticket_queue: SCALELAB
# Jira Specific Variables
jira_url: https://projects.engineering.example.com/rest/api/2

JIRA Basic Authentication

By default we support BasicAuth for JIRA (username/password), you just need to enter in the credentials like below in /opt/quads/conf/quads.yml.

jira_auth: basic
jira_username: admin
jira_password: password

JIRA Token Authentication

We also support token/bearer auth for API token access as well, to utilize this you'll need to change the jira_auth value to token. These authentication methods are mutually exclusive.

jira_auth: token
jira_token: 7h1515@v3ryl0n6@ndcr1p71c70k3n

API activities with jira.py

  • Library: /opt/quads/quads/tools/jira.py
  • The jira.py library in QUADS helps with auto-updating JIRA tickets using the API user.
  • If you are using --host-list for en-masse scheduling this will be called to update the ticket template found in /opt/quads/quads/templates/jira_ticket_assignment

Applying labels and adding watchers

  • Tool: /opt/quads/quads/tools/jira_watchers.py
  • The jira_watchers.py tool will assist you with ad-hoc (perhaps run out of cron or systemd timer) batch processing to do the following:
    • Ensure the person submitting the request is added as a watcher in JIRA
    • Checking the viability of extension request with appropriate labels, e.g. CAN_EXTEND or CANNOT_EXTEND
  • Below is a reference of how we use labels in JIRA.

Common JIRA Labels

  • Below is a chart of common labels we use in JIRA with jira.py managing/automating this aspect of our request workflow.
Label Name Category Purpose of Label
EXTENSION Assignment Label for existing assignment extension
EXPANSION Assignment Request for expansion of existing assignment
CAN_EXTEND Viability Label indicating assignment could be extended with no conflicts
CANNOT_EXTEND Viability Label indicating a conflict in at least one system for extension