Using Integrate with AWS

Owned by Steffen Opel [Utoolity]
Last updated: 10.12.2024Version comment
7 min read

Integrate with AWS allows you to link and track your AWS resources – integrate Amazon Web Services with your DevOps workflows in Jira (EAP) and Compass.

The initial Jira (EAP) release supports linking of AWS resources to projects and issues via AWS Resource Explorer views, and provides deep links to resources in the AWS Management Console.

The initial Compass release supports import of AWS resources as components, provides deep links to resources and dashboards in the AWS Management Console, and tracks resource health and compliance.

 

What is Integrate with AWS

Integrate with AWS allows you to link and track your Amazon Web Services (AWS) resources right from your DevOps workflows in Jira (EAP) and Compass – currently it allows you to:

Supported AWS services

Integrate with AWS supports most AWS services at the resource level (e.g. for deep links) – refer to Integrations for details on services with dedicated integrations.

Getting started – Jira and Compass

To integrate AWS with Jira or Compass, you must first install the Integrate with AWS app in Compass. Then, you connect Compass to one or more AWS environments that contain the resources you want to import and track.

Before you begin

  • Ensure that you’re an administrator of the AWS accounts you want to connect to, or work with your account owner to configure this app.

  • Ensure that you’re an administrator on your Jira or Compass instance.

You can connect multiple AWS environments (an account/region combination) to a Compass instance.

Install the app – Jira

To install Integrate with AWS for Jira, join our early access program (EAP) (we aim to publish the app by end of January 2025).

Install the app – Compass

To Install Integrate with AWS for Compass:

  1. Select Apps from the top navigation bar in Compass.

  2. Enter Integrate with AWS into the search field, then click on the Integrate with AWS for Compass card.

  3. Select Get it now on the Integrate with AWS app listing, and once more on the confirmation dialog after you’ve reviewed the required permissions. This installs the Integrate with AWS app in Compass.

  4. Click the Configure link on the success message (alternatively, you can always select Apps from the top navigation bar in Compass, click the Manage your apps menu, find Integrate with AWS for Compass, and then click the Configure button:

Now you can connect AWS environments and import components from regions within the connected AWS accounts.

Configure the app – Jira and Compass

Before you can link and track AWS resources in Jira or Compass, you need to connect at least one AWS environment (an account/region combination).

Connect AWS environments

You can connect an AWS environment (an account/region combination) via a CloudFormation stack, or you can bulk connect one or more environments via a stack set – update or delete a connection via the CloudFormation console.

It can take 1-2 minutes for the environment to show up in the table.

 

Connect single environment

  1. Log into the target account and region in the AWS console

  2. Click 'Prepare stack' to open the preconfigured 'Quick create stack' form

  3. (Optional) Adjust the stack parameters to suit your requirements

 

 

Connect multiple environments

  1. Log into the target account and region in the AWS console

  2. Click 'Prepare stack' to open the preconfigured 'Quick create stack' form

  3. (Optional) Adjust the stack parameters to suit your requirements

 

 

How it works – Jira

To work with AWS resources in Jira, you can link an AWS Resource Explorer view with a Jira project.

Link AWS resources to Jira projects

Configure the view and default query

 

Display and query the view

Link AWS resources to Jira issues

Configure the view and default query

Surface linked AWS resources in an issue panel

TBD

Surface linked AWS resources in an issue dialog

TBD

 

Follow contextual deep links to AWS resources and audit resource health and compliance

Every AWS resource surfaced via the Jira project or issue views features a deep link to the resource dashboard in the AWS console. Depending on the resource type, there will also be supplementary deep links to more advanced contextual dashboards provided by other AWS services like AWS CloudWatch, AWS Config, and AWS Systems Manager Application Manager, for example:

  • AWS Management Console – inspect resource details

  • AWS Config rules compliance – audit resource configuration and compliance changes

How it works – Compass

To work with AWS resources in Compass, you can either import resources as Compass components, or associate a resource with an existing Compass component.

Import AWS resources

You can manually import a single resource via its ARN, or you can bulk import one or more AWS resources via respective 'trigger' tags.

Import a single resource via its ARN

You can manually import a single resource via its ARN.

  1. Paste an AWS resource ARN into the text field

  2. Select the type of the new component

  3. Click ‘Import AWS resource’ to create the component

 

 

 

Import one or more resources via tags

You can bulk import one or more AWS resources via respective 'trigger' tags that you can either apply on the resource itself or via the AWS tag editor.

  • To import as a Service (default), use the following tag key with an empty tag value:
    - utoolity:atlassian:compass:component

  • To import as a specific type, set the tag value to one of the supported Compass component types:

    • Service

    • Library

    • Application

    • Capability

    • Cloud Resource

    • Data Pipeline

    • Machine Learning Model

    • Ui Element

    • Website

    • Template

    • Other

Associate AWS resources

You can associate an AWS resource with an existing Compass component to start tracking resources.

  1. Provide a resource ARN from the AWS Management Console

  2. Click ‘Link resource’ to complete the association

 

 

Unlink AWS resources

You can also unlink an AWS resource from a component and associate a new one.

 

 

 

Search Compass component catalog via AWS metadata labels

Every component associated with an AWS resource gains metadata labels that simplify navigating the component catalog via the Compass advanced search capabilities.

Currently supported AWS metadata labels are:

  • Account ID

  • Region

  • Service

  • Resource type

Follow contextual deep links to AWS resources and dashboards

Every component associated with an AWS resource features a deep link to the resource dashboard in the AWS console. Depending on the resource type, there will also be supplementary deep links to more advanced contextual dashboards provided by other AWS services like AWS CloudWatch, AWS Config, and AWS Systems Manager Application Manager.

The app currently supports deep links to the following contextual dashboards:

 

Inspect AWS resource details and track resource health and compliance

Every component associated with an AWS resource also features an ‘AWS resources’ page via the Compass sidebar that surfaces more details, applicable health and compliance results and provides additional deep links depending on the resource type, for example:

  • AWS Management Console – inspect resource details

  • AWS Config rules compliance – audit resource configuration and compliance changes

  • AWS Tag policy compliance – audit resource tags (via resource details link)

  • Contained resources – navigate to related resources in scope of the current resource