Develop with AWS allows you to track your Amazon Web Services (AWS) development toolchain activities right from your DevOps workflows in Jira Software and Compass – currently it allows you to:
Track CodeCommit, CodePipeline, CodeBuild action, CodeDeploy action, and CloudFormation action activity on the Jira deployments view and as issue development information and release information
Track CodePipeline, CodeBuild, and CloudFormation activity in the Compass activity feed and as component activity and metrics
Supported AWS servicesDevelop with AWS aims support many applicable AWS services and resource types – refer to Integrations for details. |
To integrate AWS with Jira or Compass, you must first install the Develop with AWS app. Then, you connect Jira or Compass to one or more AWS environments that contain the resources you want to track.
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.
(Jira Software only) Ensure that you have enabled applicable agile features like deployments, code, and releases and versions
You can connect multiple AWS environments (an account/region combination) to a Jira or Compass instance. |
To install Develop with AWS in Jira Software:
|
To install Develop with AWS in Compass:
|
Now you can connect AWS environments and receive AWS DevOps events from regions within the connected AWS accounts.
Before you can ingest AWS DevOps toolchain events to Jira or Compass, you need to connect at least one AWS environment (an account/region combination).
You can connect an AWS environment 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. |
Log into the target account and region in the AWS console
Click 'Prepare stack' to open the preconfigured 'Quick create stack' form
(Optional) Adjust the stack parameters to suit your requirements
Working with CloudFormation StackSets builds upon several more advanced concepts – ensure that your account has all prerequisites for stack set operations before you provision the stack below. |
Log into the target account and region in the AWS console
Click 'Prepare stack' to open the preconfigured 'Quick create stack' form
(Optional) Adjust the stack parameters to suit your requirements
Once you have connected at least one AWS environment, you are ready to ingest events from supported AWS services and resource types – you can also provision a sample stack:
To test the ingestion of AWS DevOps toolchain events to Jira or Compass, you can Create sample resources via the button on the right in the ‘Actions’ column:
Log into the environment’s target account and region in the AWS console
Click 'Prepare stack' to open the preconfigured 'Quick create stack' form
(Optional) Adjust the stack parameters to suit your requirements
Navigate to the AWS Developer Tools home in the AWS console
Check that the created CodePipeline pipeline has been executed once
Check that the created CodeBuild project has succeeded
Check that the deployed CloudFormation stack has been created
Make edits to the source code in the created CodeCommit repository to trigger a new pipeline execution
You need to reference issue keys in your commit messages to make the pipeline execution visible in Jira (Compass does not require this) – refer to the ‘How it works’ sections below for details
To surface AWS DevOps tool events in Jira, include issue keys in your branch names, commit messages, and pull requests – refer to reference issues in your development work for details.
Use tags to adjust the event ingestion You can use tags to some various aspects of the event ingestion: |
Refer to Understand your deployments view for details.
Refer to View and understand your deployment insights for details
Refer to View development information for an issue and View release information for an issue for details.
Progressive Delivery via the Jira Software Releases Hub The new Releases Hub in Jira Software “enables organizations [to] bring new efficiencies into your DevOps program” – learn more about the new https://community.atlassian.com/t5/DevOps-articles/Progressive-Delivery-capabilities-in-Jira-Software/ba-p/2255118. |
You can use the following triggers triggers to kick off the execution of your Jira automation rules – refer to Jira automation DevOps triggers for details:
Branch created
/ Pull request created
/ Pull request declined
/ Pull request merged
Build failed
/ Build status changed
/ Build successful
Deployment failed
/ Deployment status changed
/ Deployment succeeded
You can find issues depending on the state of your AWS based Deployments and Builds that have been triggert by a commit that references a Jira issue in its commit message – refer to Advanced search reference - JQL developer status for details.
To surface AWS DevOps tool events in Compass, link applicable resource types in the component’s Dashboards or Other links sections – learn more about linking AWS DevOps tools.
URL vs. ARN
Compass requires unique URLs to link an event source. Unfortunately not all AWS resource console URLs uniquely identify the resource across accounts, so as a workaround you can use the Amazon Resource Name (ARN) to create a unique link via the AWS DevOps toolchain component page accessible from the left sidebar:
URL vs. ARN
Compass requires unique URLs to link an event source. Unfortunately not all AWS resource console URLs uniquely identify the resource across accounts, so as a workaround you can use the Amazon Resource Name (ARN) to create a unique link via the AWS DevOps toolchain component page accessible from the left sidebar:
Use tags to adjust the event ingestion You can use tags to adjust various aspects of the event ingestion: |
You can track AWS CodePipeline Deployment events, AWS CodeBuild Build or Deployment events, and CloudFormation events on your component’s Activity page in the left sidebar – refer to View a component's activity feed for details.
You can track AWS CodePipeline and AWS CloudFormation Deployment frequency, and AWS CodeBuild Build time and Build success rate metrics in the Metrics section of your component’s Overview page – refer to View a component’s metrics for details