Using Develop with AWS
- Steffen Opel [Utoolity]
You build it, you run it – integrate your AWS DevOps toolchain with the Atlassian Open DevOps experience in Jira Software and Compass.
The initial release supports tracking of …
… AWS CodePipeline, AWS CodeBuild action, and AWS CloudFormation action activity on the Jira Software deployments view and as issue development information and release information.
… AWS CodePipeline, AWS CodeBuild, and AWS CloudFormation activity within the Compass activity feed and as component activity and metrics.
What is Develop with AWS
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 services
Develop with AWS aims support many applicable AWS services and resource types – refer to Integrations for details.
Getting started – Jira and Compass
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.
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.
(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.
Install the app – Jira
To install Develop with AWS in Jira Software:
Install the app – Compass
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.
Configure the app – Jira and Compass
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).
Connect AWS environments
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.
Connect single environment
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
Connect multiple environments
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:
Create sample AWS resources
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:
Prepare sample resources stack
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
Explore sample resources
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
How it works – Jira
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.
Track AWS DevOps events within the Jira deployments view
Refer to Understand your deployments view for details.
Analyze AWS DevOps events with Jira deployments insights
Refer to View and understand your deployment insights for details
View AWS DevOps events within the Jira development and release issue panels
Refer to View development information for an issue and View release information for an issue for details.
Automate Jira issues with linked AWS DevOps events
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 mergedBuild failed/Build status changed/Build successfulDeployment failed/Deployment status changed/Deployment succeeded
Search issues with linked AWS DevOps events via Jira Query Language (JQL)
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.
How it works – Compass
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.
Track AWS DevOps events within the Compass component activity feed
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.
Track AWS DevOps metrics within the Compass component overview
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