Skip to content

Latest commit

 

History

History
1006 lines (746 loc) · 58.7 KB

dc-apps-performance-toolkit-user-guide-jira.md

File metadata and controls

1006 lines (746 loc) · 58.7 KB
Raw
title platform product category subcategory date
Data Center App Performance Toolkit User Guide For Jira
platform
marketplace
devguide
build
2022-12-21

Data Center App Performance Toolkit User Guide For Jira

This document walks you through the process of testing your app on Jira using the Data Center App Performance Toolkit. These instructions focus on producing the required performance and scale benchmarks for your Data Center app.

{{% note %}} Data Center App Performance Toolkit is focused on applications performance testing for Marketplace approval process. For Jira DataCenter functional testing consider JPT. {{% /note %}}

In this document, we cover the use of the Data Center App Performance Toolkit on two types of environments:

Development environment: Jira Data Center environment for a test run of Data Center App Performance Toolkit and development of app-specific actions. We recommend you use the AWS Quick Start for Jira Data Center with the parameters prescribed here.

  1. Set up a development environment Jira Data Center on AWS.
  2. Create a dataset for the development environment.
  3. Run toolkit on the development environment locally.
  4. Develop and test app-specific actions locally.

Enterprise-scale environment: Jira Data Center environment used to generate Data Center App Performance Toolkit test results for the Marketplace approval process. Preferably, use the AWS Quick Start for Jira Data Center with the parameters prescribed below. These parameters provision larger, more powerful infrastructure for your Jira Data Center.

  1. Set up an enterprise-scale environment Jira Data Center on AWS.
  2. Load an enterprise-scale dataset on your Jira Data Center deployment.
  3. Set up an execution environment for the toolkit.
  4. Running the test scenarios from execution environment against enterprise-scale Jira Data Center.

Development environment

Running the tests in a development environment helps familiarize you with the toolkit. It'll also provide you with a lightweight and less expensive environment for developing. Once you're ready to generate test results for the Marketplace Data Center Apps Approval process, run the toolkit in an enterprise-scale environment.

1. Setting up Jira Data Center development environment

We recommend that you set up development environment using the AWS Quick Start for Jira Data Center (How to deploy tab). All the instructions on this page are optimized for AWS. If you already have an existing Jira Data Center environment, you can also use that too (if so, skip to Create a dataset for the development environment).

Using the AWS Quick Start for Jira

If you are a new user, perform an end-to-end deployment. This involves deploying Jira into a new ASI:

Navigate to AWS Quick Start for Jira Data Center > How to deploy tab > Deploy into a new ASI link.

If you have already deployed the ASI separately by using the ASI Quick StartASI Quick Start or by deploying another Atlassian product (Jira, Bitbucket, or Confluence Data Center development environment) with ASI, deploy Jira into your existing ASI:

Navigate to AWS Quick Start for Jira Data Center > How to deploy tab > Deploy into your existing ASI link.

{{% note %}} You are responsible for the cost of AWS services used while running this Quick Start reference deployment. This Quick Start doesn't have any additional prices. See Amazon EC2 pricing for more detail. {{% /note %}}

To reduce costs, we recommend you to keep your deployment up and running only during the performance runs.

AWS cost estimation for the development environment

AWS Jira Data Center development environment infrastructure costs about 20 - 40$ per working week depending on such factors like region, instance type, deployment type of DB, and other.

Quick Start parameters for development environment

All important parameters are listed and described in this section. For all other remaining parameters, we recommend using the Quick Start defaults.

Jira setup

Parameter Recommended value
Jira Product Software
Version The Data Center App Performance Toolkit officially supports 8.20.15, 9.4.0 (Long Term Support release)

Cluster nodes

Parameter Recommended value
Cluster node instance type t3.medium (we recommend this instance type for its good balance between price and performance in testing environments)
Maximum number of cluster nodes 1
Minimum number of cluster nodes 1
Cluster node instance volume size 50

Database

Parameter Recommended value
The database engine to deploy with PostgresSQL
The database engine version to use 11
Database instance class db.t3.medium
RDS Provisioned IOPS 1000
Master (admin) password Password1!
Enable RDS Multi-AZ deployment false
Application user database password Password1!
Database storage 200

Networking (for new ASI)

Parameter Recommended value
Trusted IP range 0.0.0.0/0 (for public access) or your own trusted IP range
Availability Zones Select two availability zones in your region
Permitted IP range 0.0.0.0/0 (for public access) or your own trusted IP range
Make instance internet facing True
Key Name The EC2 Key Pair to allow SSH access. See Amazon EC2 Key Pairs for more info.

Networking (for existing ASI)

Parameter Recommended value
Make instance internet facing True
Permitted IP range 0.0.0.0/0 (for public access) or your own trusted IP range
Key Name The EC2 Key Pair to allow SSH access. See Amazon EC2 Key Pairs for more info.

Running the setup wizard

After successfully deploying the Jira Data Center on AWS, configure it as follows:

  1. In the AWS console, go to Services > CloudFormation > Stack > Stack details > Select your stack.

  2. On the Outputs tab, copy the value of the LoadBalancerURL key.

  3. Open LoadBalancerURL in your browser. This will take you to the Jira setup wizard.

  4. On the Set up application properties page, fill in the following fields:

    • Application Title: any name for your Jira Data Center deployment
    • Mode: private
    • Base URL: your stack's Elastic LoadBalancer URL

    Then select Next.

  5. On the next page, fill in the Your License Key field in one of the following ways:

    • Using your existing license
    • Generating a Jira trial license
    • Contacting Atlassian to be provided two time-bomb licenses for testing. Ask for the licenses in your ECOHELP ticket.

    Then select Next.

  6. On the Set up administrator account page, fill in the following fields:

    • Full name: a full name of the admin user
    • Email Address: email address of the admin user
    • Username: admin (recommended)
    • Password: admin (recommended)
    • Confirm Password: admin (recommended)

    Then select Next.

  7. On the Set up email notifications page, configure your email notifications, and then select Finish.

  8. On the first page of the welcome setup select English (United States) language. Other languages are not supported by the toolkit.

  9. After going through the welcome setup, select Create new project to create a new project.

2. Generate dataset for development environment

After creating the development environment Jira Data Center, generate test dataset to run Data Center App Performance Toolkit:

  • 1 Scrum software development project with 1-5 issues
  • 1 Kanban software development project with 1-5 issues

3. Run toolkit on the development environment locally

{{% warning %}} Make sure English (United States) language is selected as a default language on the cog icon > System > General configuration page. Other languages are not supported by the toolkit. {{% /warning %}}

  1. Clone Data Center App Performance Toolkit locally.

  2. Follow the README.md instructions to set up toolkit locally.

  3. Navigate to dc-app-performance-toolkit/app folder.

  4. Open the jira.yml file and fill in the following variables:

    • application_hostname: your_dc_jira_instance_hostname without protocol.
    • application_protocol: http or https.
    • application_port: for HTTP - 80, for HTTPS - 443, 8080, 2990 or your instance-specific port.
    • secure: True or False. Default value is True. Set False to allow insecure connections, e.g. when using self-signed SSL certificate.
    • application_postfix: it is empty by default; e.g., /jira for url like this http://localhost:2990/jira.
    • admin_login: admin user username.
    • admin_password: admin user password.
    • load_executor: executor for load tests. Valid options are jmeter (default) or locust.
    • concurrency: 2 - number of concurrent JMeter/Locust users.
    • test_duration: 5m - duration of the performance run.
    • ramp-up: 3s - amount of time it will take JMeter or Locust to add all test users to test execution.
    • total_actions_per_hour: 5450 - number of total JMeter/Locust actions per hour.
    • WEBDRIVER_VISIBLE: visibility of Chrome browser during selenium execution (False is by default).

  5. Run bzt.

    bzt jira.yml

  6. Review the resulting table in the console log. All JMeter/Locust and Selenium actions should have 95+% success rate.
    In case some actions does not have 95+% success rate refer to the following logs in dc-app-performance-toolkit/app/results/jira/YY-MM-DD-hh-mm-ss folder:

    • results_summary.log: detailed run summary
    • results.csv: aggregated .csv file with all actions and timings
    • bzt.log: logs of the Taurus tool execution
    • jmeter.*: logs of the JMeter tool execution
    • locust.*: logs of the Locust tool execution (in case you use Locust as load_executor in jira.yml)
    • pytest.*: logs of Pytest-Selenium execution

{{% warning %}} Do not proceed with the next step until you have all actions 95+% success rate. Ask support if above logs analysis did not help. {{% /warning %}}

4. Develop and test app-specific action locally

Data Center App Performance Toolkit has its own set of default test actions for Jira Data Center: JMeter/Locust and Selenium for load and UI tests respectively.

App-specific action - action (performance test) you have to develop to cover main use cases of your application. Performance test should focus on the common usage of your application and not to cover all possible functionality of your app. For example, application setup screen or other one-time use cases are out of scope of performance testing.

  1. Define main use case of your app. Usually it is one or two main app use cases.
  2. Your app adds new UI elements in Jira Data Center - Selenium app-specific action has to be developed.
  3. Your app introduces new endpoint or extensively calls existing Jira Data Center API - JMeter/Locust app-specific actions has to be developed.
    JMeter and Locust actions are interchangeable, so you could select the tool you prefer:

{{% note %}} We strongly recommend developing your app-specific actions on the development environment to reduce AWS infrastructure costs. {{% /note %}}

Custom dataset

You can filter your own app-specific issues for your app-specific actions.

  1. Create app-specific issues that have specific anchor in summary, e.g. AppIssue anchor and issues summaries like AppIssue1, AppIssue2, AppIssue3.
  2. Go to the search page of your Jira Data Center - JIRA_URL/issues/?jql= and select Advanced.
  3. Write JQL that filter just your issues from step 1, e.g. summary ~ 'AppIssue*'.
  4. Edit Jira configuration file dc-app-performance-toolkit/app/jira.yml:
    • custom_dataset_query: JQL from step 3.

Next time when you run toolkit, custom dataset issues will be stored to the dc-app-performance-toolkit/app/datasets/jira/custom-issues.csv with columns: issue_key, issue_id, project_key.

Example of app-specific Selenium action development with custom dataset

You develop an app that adds some additional fields to specific types of Jira issues. In this case, you should develop Selenium app-specific action:

  1. Create app-specific Jira issues with AppIssue anchor in summary: AppIssue1, AppIssue2, etc.
  2. Go to the search page of your Jira Data Center - JIRA_URL/issues/?jql= and check if JQL is correct: summary ~ 'AppIssue*'.
  3. Edit dc-app-performance-toolkit/app/jira.yml configuration file and set custom_dataset_query: summary ~ 'AppIssue*'.
  4. Extend example of app-specific action in dc-app-performance-toolkit/app/extension/jira/extension_ui.py.
    Code example. So, our test has to open app-specific issues and measure time to load of this app-specific issues.
  5. If you need to run app_speicifc_action as specific user uncomment app_specific_user_login function in code example. Note, that in this case test_1_selenium_custom_action should follow just before test_2_selenium_z_log_out action.
  6. In dc-app-performance-toolkit/app/selenium_ui/jira_ui.py, review and uncomment the following block of code to make newly created app-specific actions executed:
# def test_1_selenium_custom_action(webdriver, datasets, screen_shots):
#     app_specific_action(webdriver, datasets)
  1. Run toolkit with bzt jira.yml command to ensure that all Selenium actions including app_specific_action are successful.

Example of app-specific Locust/JMeter action development

You develop an app that introduces new GET and POST endpoints in Jira Data Center. In this case, you should develop Locust or JMeter app-specific action.

Locust app-specific action development example

  1. Extend example of app-specific action in dc-app-performance-toolkit/app/extension/jira/extension_locust.py, so that test will call the endpoint with GET request, parse response use these data to call another endpoint with POST request and measure response time.
    Code example.
  2. In dc-app-performance-toolkit/app/jira.yml set load_executor: locust to make locust as load executor.
  3. Set desired execution percentage for standalone_extension. Default value is 0, which means that standalone_extension action will not be executed. Locust uses actions percentage as relative weights, so if some_action: 10 and standalone_extension: 20 that means that standalone_extension will be called twice more.
    Set standalone_extension weight in accordance with the expected frequency of your app use case compared with other base actions.
  4. App-specific tests could be run (if needed) as a specific user. Use @run_as_specific_user(username='specific_user_username', password='specific_user_password') decorator for that.
  5. Run toolkit with bzt jira.yml command to ensure that all Locust actions including app_specific_action are successful.

JMeter app-specific action development example

  1. Check that jira.yml file has correct settings of application_hostname, application_protocol, application_port, application_postfix, etc.

  2. Set desired execution percentage for standalone_extension. Default value is 0, which means that standalone_extension action will not be executed. For example, for app-specific action development you could set percentage of standalone_extension to 100 and for all other actions to 0 - this way only login_and_view_dashboard and standalone_extension actions would be executed.

  3. Navigate to dc-app-performance-toolkit/app folder and run from virtualenv(as described in dc-app-performance-toolkit/README.md):

    python util/jmeter/start_jmeter_ui.py --app jira

  4. Open Jira thread group > actions per login and navigate to standalone_extension Jira JMeter standalone extension

  5. Add GET HTTP Request: right-click to standalone_extension > Add > Sampler HTTP Request, chose method GET and set endpoint in Path. Jira JMeter standalone GET

  6. Add Regular Expression Extractor: right-click to to newly created HTTP Request > Add > Post processor > Regular Expression Extractor Jira JMeter standalone regexp

  7. Add Response Assertion: right-click to newly created HTTP Request > Add > Assertions > Response Assertion and add assertion with Contains, Matches, Equals, etc types. Jira JMeter standalone assertions

  8. Add POST HTTP Request: right-click to standalone_extension > Add > Sampler HTTP Request, chose method POST, set endpoint in Path and add Parameters or Body Data if needed.

  9. Right-click on View Results Tree and enable this controller.

  10. Click Start button and make sure that login_and_view_dashboard and standalone_extension are successful.

  11. Right-click on View Results Tree and disable this controller. It is important to disable View Results Tree controller before full-scale results generation.

  12. Click Save button.

  13. To make standalone_extension executable during toolkit run edit dc-app-performance-toolkit/app/jira.yml and set execution percentage of standalone_extension accordingly to your use case frequency.

  14. App-specific tests could be run (if needed) as a specific user. In the standalone_extension uncomment login_as_specific_user controller. Navigate to the username:password config element and update values for app_specific_username and app_specific_password names with your specific user credentials. Also make sure that you located your app-specific tests between login_as_specific_user and login_as_default_user_if_specific_user_was_loggedin controllers.

  15. Run toolkit to ensure that all JMeter actions including standalone_extension are successful.

Using JMeter variables from the base script

Use or access the following variables in your standalone_extension script if needed.

  • ${issue_key} - issue key being viewed or modified (e.g. ABC-123)
  • ${issue_id} - issue id being viewed or modified (e.g. 693484)
  • ${project_key} - project key being viewed or modified (e.g. ABC)
  • ${project_id} - project id being viewed or modified (e.g. 3423)
  • ${scrum_board_id} - scrum board id being viewed (e.g. 328)
  • ${kanban_board_id} - kanban board id being viewed (e.g. 100)
  • ${jql} - jql query being used (e.g. text ~ "qrk*" order by key)
  • ${username} - the logged in username (e.g. admin)

{{% warning %}} App-specific actions are required. Do not proceed with the next step until you have completed app-specific actions development and got successful results from toolkit run. {{% /warning %}}

Enterprise-scale environment

After adding your custom app-specific actions, you should now be ready to run the required tests for the Marketplace Data Center Apps Approval process. To do this, you'll need an enterprise-scale environment.

5. Set up an enterprise-scale environment Jira Data Center on AWS

We recommend that you use the AWS Quick Start for Jira Data Center (How to deploy tab) to deploy a Jira Data Center enterprise-scale environment. This Quick Start will allow you to deploy Jira Data Center with a new Atlassian Standard Infrastructure (ASI) or into an existing one.

The ASI is a Virtual Private Cloud (VPC) consisting of subnets, NAT gateways, security groups, bastion hosts, and other infrastructure components required by all Atlassian applications, and then deploys Jira into this new VPC. Deploying Jira with a new ASI takes around 50 minutes. With an existing one, it'll take around 30 minutes.

Using the AWS Quick Start for Jira

If you are a new user, perform an end-to-end deployment. This involves deploying Jira into a new ASI:

Navigate to AWS Quick Start for Jira Data Center > How to deploy tab > Deploy into a new ASI link.

If you have already deployed the ASI separately by using the ASI Quick StartASI Quick Start or by deploying another Atlassian product (Jira, Bitbucket, or Confluence Data Center development environment) with ASI, deploy Jira into your existing ASI:

Navigate to AWS Quick Start for Jira Data Center > How to deploy tab > Deploy into your existing ASI link.

{{% note %}} You are responsible for the cost of the AWS services used while running this Quick Start reference deployment. There is no additional price for using this Quick Start. For more information, go to aws.amazon.com/pricing. {{% /note %}}

To reduce costs, we recommend you to keep your deployment up and running only during the performance runs.

AWS cost estimation

AWS Pricing Calculator provides an estimate of usage charges for AWS services based on certain information you provide. Monthly charges will be based on your actual usage of AWS services and may vary from the estimates the Calculator has provided.

*The prices below are approximate and may vary depending on such factors like region, instance type, deployment type of DB, and other.

Stack Estimated hourly cost ($)
One Node Jira DC 0.8 - 1.1
Two Nodes Jira DC 1.2 - 1.7
Four Nodes Jira DC 2.0 - 3.0

Stop cluster nodes

To reduce AWS infrastructure costs you could stop cluster nodes when the cluster is standing idle.
Cluster node might be stopped by using Suspending and Resuming Scaling Processes.

To stop one node within the cluster, follow the instructions below:

  1. In the AWS console, go to Services > EC2 > Auto Scaling Groups and open the necessary group to which belongs the node you want to stop.
  2. Click Edit (in case you have New EC2 experience UI mode enabled, press Edit on Advanced configuration) and add HealthCheck to the Suspended Processes. Amazon EC2 Auto Scaling stops marking instances unhealthy as a result of EC2 and Elastic Load Balancing health checks.
  3. Go to EC2 Instances, select instance, click Instance state > Stop instance.

To return node into a working state follow the instructions:

  1. Go to EC2 Instances, select instance, click Instance state > Start instance, wait a few minutes for node to become available.
  2. Go to EC2 Auto Scaling Groups and open the necessary group to which belongs the node you want to start.
  3. Press Edit (in case you have New EC2 experience UI mode enabled, press Edit on Advanced configuration) and remove HealthCheck from Suspended Processes of Auto Scaling Group.

Stop database

To reduce AWS infrastructure costs database could be stopped when the cluster is standing idle. Keep in mind that database would be automatically started in 7 days.

To stop database:

  1. In the AWS console, go to Services > RDS > Databases.
  2. Select cluster database.
  3. Click on Actions > Stop.

To start database:

  1. In the AWS console, go to Services > RDS > Databases.
  2. Select cluster database.
  3. Click on Actions > Start.

Quick Start parameters

All important parameters are listed and described in this section. For all other remaining parameters, we recommend using the Quick Start defaults.

Jira setup

Parameter Recommended Value
Jira Product Software
Version The Data Center App Performance Toolkit officially supports 8.20.15, 9.4.0 (Long Term Support release)

Cluster nodes

Parameter Recommended Value
Cluster node instance type m5.2xlarge (This differs from our public recommendation on c4.8xlarge for production instances but is representative for a lot of our Jira Data Center customers. The Data Center App Performance Toolkit framework is set up for concurrency we expect on this instance size. As such, underprovisioning will likely show a larger performance impact than expected.)
Maximum number of cluster nodes 1
Minimum number of cluster nodes 1
Cluster node instance volume size 100

Database

Parameter Recommended Value
The database engine to deploy with PostgresSQL
The database engine version to use 11
Database instance class db.m5.xlarge
RDS Provisioned IOPS 1000
Master (admin) password Password1!
Enable RDS Multi-AZ deployment false
Application user database password Password1!
Database storage 200

{{% note %}} The Master (admin) password will be used later when restoring the SQL database dataset. If password value is not set to default, you'll need to change DB_PASS value manually in the restore database dump script (later in Preloading your Jira deployment with an enterprise-scale dataset). {{% /note %}}

Networking (for new ASI)

Parameter Recommended Value
Trusted IP range 0.0.0.0/0 (for public access) or your own trusted IP range
Availability Zones Select two availability zones in your region
Permitted IP range 0.0.0.0/0 (for public access) or your own trusted IP range
Make instance internet facing true
Key Name The EC2 Key Pair to allow SSH access. See Amazon EC2 Key Pairs for more info.

Networking (for existing ASI)

Parameter Recommended Value
Make instance internet facing true
Permitted IP range 0.0.0.0/0 (for public access) or your own trusted IP range
Key Name The EC2 Key Pair to allow SSH access. See Amazon EC2 Key Pairs for more info.

Running the setup wizard

After successfully deploying Jira Data Center in AWS, you'll need to configure it:

  1. In the AWS console, go to Services > CloudFormation > Stack > Stack details > Select your stack.
  2. On the Outputs tab, copy the value of the LoadBalancerURL key.
  3. Open LoadBalancerURL in your browser. This will take you to the Jira setup wizard.
  4. On the Set up application properties page, populate the following fields:
    • Application Title: any name for your Jira Data Center deployment
    • Mode: Private
    • Base URL: your stack's Elastic LoadBalancer URL Click Next.
  5. On the next page, populate the Your License Key field by either:
    • Using your existing license, or
    • Generating a Jira trial license, or
    • Contacting Atlassian to be provided two time-bomb licenses for testing. Ask for it in your ECOHELP ticket. Click Next.
  6. On the Set up administrator account page, populate the following fields:
    • Full name: any full name of the admin user
    • Email Address: email address of the admin user
    • Username: admin (recommended)
    • Password: admin (recommended)
    • Confirm Password: admin (recommended) Click Next.
  7. On the Set up email notifications page, configure your email notifications, and then click Finish.
  8. On the first page of the welcome setup select English (United States) language. Other languages are not supported by the toolkit.
  9. After going through the welcome setup, click Create new project to create a new project.

6. Preloading your Jira deployment with an enterprise-scale dataset

Data dimensions and values for an enterprise-scale dataset are listed and described in the following table.

Data dimensions Value for an enterprise-scale dataset
Attachments ~2 000 000
Comments ~6 000 000
Components ~2 500
Custom fields ~800
Groups ~1 000
Issue security levels 10
Issue types ~300
Issues ~1 000 000
Priorities 5
Projects 500
Resolutions 34
Screen schemes ~200
Screens ~200
Statuses ~400
Users ~21 000
Versions ~20 000
Workflows 50

{{% note %}} All the datasets use the standard admin/admin credentials. {{% /note %}}

Pre-loading the dataset is a three-step process:

  1. Importing the main dataset. To help you out, we provide an enterprise-scale dataset you can import either via the populate_db.sh script or restore from xml backup file.
  2. Restoring attachments. We also provide attachments, which you can pre-load via an upload_attachments.sh script.
  3. Re-indexing Jira Data Center. For more information, go to Re-indexing Jira.

The following subsections explain each step in greater detail.

Importing the main dataset

You can load this dataset directly into the database (via a populate_db.sh script), or import it via XML.

Option 1 (recommended): Loading the dataset via populate_db.sh script (~1 hour)

To populate the database with SQL:

  1. In the AWS console, go to Services > EC2 > Instances.

  2. On the Description tab, do the following:

    • Copy the Public IP of the Bastion instance.
    • Copy the Private IP of the Jira node instance.

  3. Using SSH, connect to the Jira node via the Bastion instance:

    For Linux or MacOS run following commands in terminal (for Windows use Git Bash terminal):

    ssh-add path_to_your_private_key_pem
export BASTION_IP=bastion_instance_public_ip
export NODE_IP=node_private_ip
export SSH_OPTS1='-o ServerAliveInterval=60'
export SSH_OPTS2='-o ServerAliveCountMax=30'
ssh ${SSH_OPTS1} ${SSH_OPTS2} -o "proxycommand ssh -W %h:%p ${SSH_OPTS1} ${SSH_OPTS2} ec2-user@${BASTION_IP}" ec2-user@${NODE_IP}

    For more information, go to Connecting your nodes over SSH.

  4. Download the populate_db.sh script and make it executable:

    wget https://raw.githubusercontent.com/atlassian/dc-app-performance-toolkit/master/app/util/jira/populate_db.sh && chmod +x populate_db.sh

  5. Review the following Variables section of the script:

    DB_CONFIG="/var/atlassian/application-data/jira/dbconfig.xml"
JIRA_CURRENT_DIR="/opt/atlassian/jira-software/current"
CATALINA_PID_FILE="${JIRA_CURRENT_DIR}/work/catalina.pid"
JIRA_DB_NAME="jira"
JIRA_DB_USER="postgres"
JIRA_DB_PASS="Password1!"
JIRA_SETENV_FILE="${JIRA_CURRENT_DIR}/bin/setenv.sh"
JIRA_VERSION_FILE="/media/atl/jira/shared/jira-software.version"
DATASETS_AWS_BUCKET="https://centaurus-datasets.s3.amazonaws.com/jira"

  6. Run the script:

    ./populate_db.sh 2>&1 | tee -a populate_db.log

{{% note %}} Do not close or interrupt the session. It will take about an hour to restore SQL database. When SQL restoring is finished, an admin user will have admin/admin credentials.

In case of a failure, check the Variables section and run the script one more time. {{% /note %}}

Option 2: Loading the dataset through XML import (~4 hours)

We recommend that you only use this method if you are having problems with the populate_db.sh script.

  1. In the AWS console, go to Services > EC2 > Instances.

  2. On the Description tab, do the following:

    • Copy the Public IP of the Bastion instance.
    • Copy the Private IP of the Jira node instance.

  3. Using SSH, connect to the Jira node via the Bastion instance:

    For Linux or MacOS run following commands in terminal (for Windows use Git Bash terminal):

    ssh-add path_to_your_private_key_pem
export BASTION_IP=bastion_instance_public_ip
export NODE_IP=node_private_ip
export SSH_OPTS1='-o ServerAliveInterval=60'
export SSH_OPTS2='-o ServerAliveCountMax=30'
ssh ${SSH_OPTS1} ${SSH_OPTS2} -o "proxycommand ssh -W %h:%p ${SSH_OPTS1} ${SSH_OPTS2} ec2-user@${BASTION_IP}" ec2-user@${NODE_IP}

    For more information, go to Connecting your nodes over SSH.

  4. Download the xml_backup.zip file corresponding to your Jira version.

    JIRA_VERSION=$(sudo su jira -c "cat /media/atl/jira/shared/jira-software.version")
sudo su jira -c "wget https://centaurus-datasets.s3.amazonaws.com/jira/${JIRA_VERSION}/large/xml_backup.zip -O /media/atl/jira/shared/import/xml_backup.zip"

  5. Log in as a user with the Jira System Administrators global permission.

  6. Go to cog icon > System > Restore System. from the menu.

  7. Populate the File name field with xml_backup.zip.

  8. Click Restore and wait until the import is completed.

Restoring attachments (~2 hours)

After Importing the main dataset, you'll now have to pre-load an enterprise-scale set of attachments.

{{% note %}} Populate DB and restore attachments scripts could be run in parallel in separate terminal sessions to save time. {{% /note %}}

  1. Using SSH, connect to the Jira node via the Bastion instance:

    For Linux or MacOS run following commands in terminal (for Windows use Git Bash terminal):

    ssh-add path_to_your_private_key_pem
export BASTION_IP=bastion_instance_public_ip
export NODE_IP=node_private_ip
export SSH_OPTS1='-o ServerAliveInterval=60'
export SSH_OPTS2='-o ServerAliveCountMax=30'
ssh ${SSH_OPTS1} ${SSH_OPTS2} -o "proxycommand ssh -W %h:%p ${SSH_OPTS1} ${SSH_OPTS2} ec2-user@${BASTION_IP}" ec2-user@${NODE_IP}

    For more information, go to Connecting your nodes over SSH.

  2. Download the upload_attachments.sh script and make it executable:

    wget https://raw.githubusercontent.com/atlassian/dc-app-performance-toolkit/master/app/util/jira/upload_attachments.sh && chmod +x upload_attachments.sh

  3. Review the following Variables section of the script:

    DATASETS_AWS_BUCKET="https://centaurus-datasets.s3.amazonaws.com/jira"
ATTACHMENTS_TAR="attachments.tar.gz"
ATTACHMENTS_DIR="attachments"
TMP_DIR="/tmp"
EFS_DIR="/media/atl/jira/shared/data"

  4. Run the script:

    ./upload_attachments.sh 2>&1 | tee -a upload_attachments.log

{{% note %}} Do not close or interrupt the session. It will take about two hours to upload attachments to Elastic File Storage (EFS). {{% /note %}}

Re-indexing Jira Data Center (~30 min)

For more information, go to Re-indexing Jira.

  1. Log in as a user with the Jira System Administrators global permission.
  2. Go to cog icon > System > Indexing.
  3. Select the Full re-index option.
  4. Click Re-Index and wait until re-indexing is completed.
  5. Take a screenshot of the acknowledgment screen displaying the re-index time and Lucene index timing.
  6. Attach the screenshot to your ECOHELP ticket.

Jira will be unavailable for some time during the re-indexing process. When finished, the Acknowledge button will be available on the re-indexing page.

Index Recovery (~15 min, only for Jira versions 9.0.x and below. For Jira 9.1.0+ skip this step.)

  1. Log in as a user with the Jira System Administrators global permission.
  2. Go to cog icon > System > Indexing.
  3. In the Index Recovery click Edit Settings.
  4. Set the recovery index schedule to 5min ahead of the current server time.
  5. Wait ~10min until the index snapshot is created.

Jira will be unavailable for some time during the index recovery process.

  1. Using SSH, connect to the Jira node via the Bastion instance:

    For Linux or MacOS run following commands in terminal (for Windows use Git Bash terminal):

    ssh-add path_to_your_private_key_pem
export BASTION_IP=bastion_instance_public_ip
export NODE_IP=node_private_ip
export SSH_OPTS1='-o ServerAliveInterval=60'
export SSH_OPTS2='-o ServerAliveCountMax=30'
ssh ${SSH_OPTS1} ${SSH_OPTS2} -o "proxycommand ssh -W %h:%p ${SSH_OPTS1} ${SSH_OPTS2} ec2-user@${BASTION_IP}" ec2-user@${NODE_IP}

  2. Once you're in the node, run command corresponding to your Jira version:

    Jira 9

     sudo su -c "du -sh  /media/atl/jira/shared/caches/indexesV2/snapshots/IndexSnapshot*" | tail -1

    Jira 8

     sudo su -c "du -sh  /media/atl/jira/shared/export/indexsnapshots/IndexSnapshot*" | tail -1

  3. The snapshot size and name will be shown in the console output.

{{% note %}} Please note that the snapshot size must be around 6GB or larger. {{% /note %}}

{{% note %}} After Preloading your Jira deployment with an enterprise-scale dataset, the admin user will have admin/admin credentials. It's recommended to change default password from UI account page for security reasons. {{% /note %}}

7. Setting up an execution environment

For generating performance results suitable for Marketplace approval process use dedicated execution environment. This is a separate AWS EC2 instance to run the toolkit from. Running the toolkit from a dedicated instance but not from a local machine eliminates network fluctuations and guarantees stable CPU and memory performance.

  1. Go to GitHub and create a fork of dc-app-performance-toolkit.
  2. Clone the fork locally, then edit the jira.yml configuration file. Set enterprise-scale Jira Data Center parameters:

{{% warning %}} Do not push to the fork real application_hostname, admin_login and admin_password values for security reasons. Instead, set those values directly in .yml file on execution environment instance. {{% /warning %}}

    application_hostname: test_jira_instance.atlassian.com   # Jira DC hostname without protocol and port e.g. test-jira.atlassian.com or localhost
    application_protocol: http      # http or https
    application_port: 80            # 80, 443, 8080, 2990, etc
    secure: True                    # Set False to allow insecure connections, e.g. when using self-signed SSL certificate
    application_postfix:            # e.g. /jira in case of url like http://localhost:2990/jira
    admin_login: admin
    admin_password: admin
    load_executor: jmeter           # jmeter and locust are supported. jmeter by default.
    concurrency: 200                # number of concurrent virtual users for jmeter or locust scenario
    test_duration: 45m
    ramp-up: 3m                     # time to spin all concurrent users
    total_actions_per_hour: 54500   # number of total JMeter/Locust actions per hour

  1. Push your changes to the forked repository.

  2. Launch AWS EC2 instance.

    • OS: select from Quick Start Ubuntu Server 20.04 LTS.
    • Instance type: c5.2xlarge
    • Storage size: 30 GiB

  3. Connect to the instance using SSH or the AWS Systems Manager Sessions Manager.

    ssh -i path_to_pem_file ubuntu@INSTANCE_PUBLIC_IP

  4. Install Docker. Setup manage Docker as a non-root user.

  5. Clone forked repository.

{{% note %}} At this stage app-specific actions are not needed yet. Use code from master branch with your jira.yml changes. {{% /note %}}

You'll need to run the toolkit for each test scenario in the next section.

8. Running the test scenarios from execution environment against enterprise-scale Jira Data Center

Using the Data Center App Performance Toolkit for Performance and scale testing your Data Center app involves two test scenarios:

Each scenario will involve multiple test runs. The following subsections explain both in greater detail.

Scenario 1: Performance regression

This scenario helps to identify basic performance issues without a need to spin up a multi-node Jira DC. Make sure the app does not have any performance impact when it is not exercised.

Run 1 (~50 min)

To receive performance baseline results without an app installed:

  1. Use SSH to connect to execution environment.

  2. Run toolkit with docker from the execution environment instance:

    cd dc-app-performance-toolkit
docker pull atlassian/dcapt
docker run --shm-size=4g -v "$PWD:/dc-app-performance-toolkit" atlassian/dcapt jira.yml

  3. View the following main results of the run in the dc-app-performance-toolkit/app/results/jira/YY-MM-DD-hh-mm-ss folder:

    • results_summary.log: detailed run summary
    • results.csv: aggregated .csv file with all actions and timings
    • bzt.log: logs of the Taurus tool execution
    • jmeter.*: logs of the JMeter tool execution
    • pytest.*: logs of Pytest-Selenium execution

{{% note %}} Review results_summary.log file under artifacts dir location. Make sure that overall status is OK before moving to the next steps. For an enterprise-scale environment run, the acceptable success rate for actions is 95% and above. {{% /note %}}

Run 2 (~50 min + Lucene Index timing test)

If you are submitting a Jira app, you are required to conduct a Lucene Index timing test. This involves conducting a foreground re-index on a single-node Data Center deployment (with your app installed) and a dataset that has 1M issues.

{{% note %}} Jira 8 index time is about ~30 min. {{% /note %}}

{{% note %}} If your Amazon RDS DB instance class is lower than db.m5.xlarge it is required to wait ~2 hours after previous reindex finish before starting a new one. {{% /note %}}

Benchmark your re-index time with your app installed:

  1. Install the app you want to test.
  2. Setup app license.
  3. Go to cog icon > System > Indexing.
  4. Select the Full re-index option.
  5. Click Re-Index and wait until re-indexing is completed.
  6. Take a screenshot of the acknowledgment screen displaying the re-index time and Lucene index timing.
  7. Attach the screenshot to your ECOHELP ticket.

Performance results generation with the app installed:

  1. Run toolkit with docker from the execution environment instance:

    cd dc-app-performance-toolkit
docker pull atlassian/dcapt
docker run --shm-size=4g -v "$PWD:/dc-app-performance-toolkit" atlassian/dcapt jira.yml

{{% note %}} Review results_summary.log file under artifacts dir location. Make sure that overall status is OK before moving to the next steps. For an enterprise-scale environment run, the acceptable success rate for actions is 95% and above. {{% /note %}}

Generating a performance regression report

To generate a performance regression report:

  1. Use SSH to connect to execution environment.
  2. Install and activate the virtualenv as described in dc-app-performance-toolkit/README.md
  3. Allow current user (for execution environment default user is ubuntu) to access Docker generated reports: 
    sudo chown -R ubuntu:ubuntu /home/ubuntu/dc-app-performance-toolkit/app/results
  4. Navigate to the dc-app-performance-toolkit/app/reports_generation folder.
  5. Edit the performance_profile.yml file:
    • Under runName: "without app", in the fullPath key, insert the full path to results directory of Run 1.
    • Under runName: "with app", in the fullPath key, insert the full path to results directory of Run 2.
  6. Run the following command: 
    python csv_chart_generator.py performance_profile.yml
  7. In the dc-app-performance-toolkit/app/results/reports/YY-MM-DD-hh-mm-ss folder, view the .csv file (with consolidated scenario results), the .png chart file and performance scenario summary report.

Analyzing report

Use scp command to copy report artifacts from execution env to local drive:

  1. From local machine terminal (Git bash terminal for Windows) run command: 
    export EXEC_ENV_PUBLIC_IP=execution_environment_ec2_instance_public_ip
scp -r -i path_to_exec_env_pem ubuntu@$EXEC_ENV_PUBLIC_IP:/home/ubuntu/dc-app-performance-toolkit/app/results/reports ./reports
  2. Once completed, in the ./reports folder you will be able to review the action timings with and without your app to see its impact on the performance of the instance. If you see an impact (>20%) on any action timing, we recommend taking a look into the app implementation to understand the root cause of this delta.

Scenario 2: Scalability testing

The purpose of scalability testing is to reflect the impact on the customer experience when operating across multiple nodes. For this, you have to run scale testing on your app.

For many apps and extensions to Atlassian products, there should not be a significant performance difference between operating on a single node or across many nodes in Jira DC deployment. To demonstrate performance impacts of operating your app at scale, we recommend testing your Jira DC app in a cluster.

Run 3 (~50 min)

To receive scalability benchmark results for one-node Jira DC with app-specific actions:

  1. Apply app-specific code changes to a new branch of forked repo.

  2. Use SSH to connect to execution environment.

  3. Pull cloned fork repo branch with app-specific actions.

  4. Run toolkit with docker from the execution environment instance:

    cd dc-app-performance-toolkit
docker pull atlassian/dcapt
docker run --shm-size=4g -v "$PWD:/dc-app-performance-toolkit" atlassian/dcapt jira.yml

{{% note %}} Review results_summary.log file under artifacts dir location. Make sure that overall status is OK before moving to the next steps. For an enterprise-scale environment run, the acceptable success rate for actions is 95% and above. {{% /note %}}

Run 4 (~50 min)

{{% note %}} Before scaling your DC make sure that AWS vCPU limit is not lower than needed number. Use vCPU limits calculator to see current limit. The same article has instructions on how to increase limit if needed. {{% /note %}}

To receive scalability benchmark results for two-node Jira DC with app-specific actions:

  1. In the AWS console, go to CloudFormation > Stack details > Select your stack.
  2. On the Update tab, select Use current template, and then click Next.
  3. Enter 2 in the Maximum number of cluster nodes and the Minimum number of cluster nodes fields.
  4. Click Next > Next > Update stack and wait until stack is updated.

{{% warning %}} In case if you got error during update - BastionPrivIp cannot be updated. Please use those steps for a workaround:

  1. In the AWS console, go to EC2 > Auto Scailng > Auto Scaling Groups.

  2. On the Auto Scaling Groups page, select your stack ASG and click Edit

  3. Enter 2 in the Desired capacity, Minimum capacity and Maximum capacity fields.

  4. Scroll down, click Update button and wait until stack is updated. {{% /warning %}}

  5. Log in as a user with the Jira System Administrators global permission.

  6. Go to cog icon > System > Clustering and check there is expected number of nodes with node status ACTIVE and application status RUNNING. To make sure that Jira index successfully synchronized to the second node.

{{% warning %}} In case if index synchronization is failed by some reason (e.g. application status is MAINTENANCE) follow those steps:

  1. Get back and go through Index Recovery steps.

  2. Proceed to AWS console, go to EC2 > Instances > Select problematic node > Instances state >Terminate instance.

  3. Wait until the new node will be recreated by ASG, the index should be picked up by a new node automatically. {{% /warning %}}

  4. Run toolkit with docker from the execution environment instance:

    cd dc-app-performance-toolkit
docker pull atlassian/dcapt
docker run --shm-size=4g -v "$PWD:/dc-app-performance-toolkit" atlassian/dcapt jira.yml

{{% note %}} Review results_summary.log file under artifacts dir location. Make sure that overall status is OK before moving to the next steps. For an enterprise-scale environment run, the acceptable success rate for actions is 95% and above. {{% /note %}}

Run 5 (~50 min)

{{% note %}} Before scaling your DC make sure that AWS vCPU limit is not lower than needed number. Use vCPU limits calculator to see current limit. The same article has instructions on how to increase limit if needed. {{% /note %}}

To receive scalability benchmark results for four-node Jira DC with app-specific actions:

  1. Scale your Jira Data Center deployment to 3 nodes as described in Run 4.

  2. Check Index is synchronized to the new node #3 the same way as in Run 4.

  3. Scale your Jira Data Center deployment to 4 nodes as described in Run 4.

  4. Check Index is synchronized to the new node #4 the same way as in Run 4.

  5. Run toolkit with docker from the execution environment instance:

    cd dc-app-performance-toolkit
docker pull atlassian/dcapt
docker run --shm-size=4g -v "$PWD:/dc-app-performance-toolkit" atlassian/dcapt jira.yml

{{% note %}} Review results_summary.log file under artifacts dir location. Make sure that overall status is OK before moving to the next steps. For an enterprise-scale environment run, the acceptable success rate for actions is 95% and above. {{% /note %}}

Generating a report for scalability scenario

To generate a scalability report:

  1. Use SSH to connect to execution environment.
  2. Allow current user (for execution environment default user is ubuntu) to access Docker generated reports: 
    sudo chown -R ubuntu:ubuntu /home/ubuntu/dc-app-performance-toolkit/app/results
  3. Navigate to the dc-app-performance-toolkit/app/reports_generation folder.
  4. Edit the scale_profile.yml file:
    • For runName: "1 Node", in the fullPath key, insert the full path to results directory of Run 3.
    • For runName: "2 Nodes", in the fullPath key, insert the full path to results directory of Run 4.
    • For runName: "4 Nodes", in the fullPath key, insert the full path to results directory of Run 5.
  5. Run the following command from the activated virtualenv (as described in dc-app-performance-toolkit/README.md): 
    python csv_chart_generator.py scale_profile.yml
  6. In the dc-app-performance-toolkit/app/results/reports/YY-MM-DD-hh-mm-ss folder, view the .csv file (with consolidated scenario results), the .png chart file and summary report.

Analyzing report

Use scp command to copy report artifacts from execution env to local drive:

  1. From local terminal (Git bash terminal for Windows) run command: 
    export EXEC_ENV_PUBLIC_IP=execution_environment_ec2_instance_public_ip
scp -r -i path_to_exec_env_pem ubuntu@$EXEC_ENV_PUBLIC_IP:/home/ubuntu/dc-app-performance-toolkit/app/results/reports ./reports
  2. Once completed, in the ./reports folder you will be able to review action timings on Jira Data Center with different numbers of nodes. If you see a significant variation in any action timings between configurations, we recommend taking a look into the app implementation to understand the root cause of this delta.

{{% warning %}} After completing all your tests, delete your Jira Data Center stacks. {{% /warning %}}

Attaching testing results to ECOHELP ticket

{{% warning %}} Do not forget to attach performance testing results to your ECOHELP ticket. {{% /warning %}}

  1. Make sure you have two reports folders: one with performance profile and second with scale profile results. Each folder should have profile.csv, profile.png, profile_summary.log and profile run result archives. Archives should contain all raw data created during the run: bzt.log, selenium/jmeter/locust logs, .csv and .yml files, etc.
  2. Attach two reports folders to your ECOHELP ticket.

Support

In case of technical questions, issues or problems with DC Apps Performance Toolkit, contact us for support in the community Slack #data-center-app-performance-toolkit channel.