Data Center checklist for Apps
Testing procedure for Data Center Apps:
Step1 : Complete a technical readiness checklist
The Data Center App Readiness Checklist is a comprehensive set of questions related to Data Center App design specifically for a multi-node environment.
Each app should have its own associated checklist. If app works with multiple products (e.g. both Jira and Confluence), there should be a checklist for each compatible product. The checklist covers an extensive range of questions about how your app utilizes certain features within the Data Center products.
The checklist has to be filled before and submitted as part of the approval process for the Add-on.
Technical readiness Checklist
Reference link for the checklist: https://developer.atlassian.com/platform/marketplace/dc-apps-submitting-your-app/
Step 2: Test your app and document the results
Complete the below test on the Data center instance
Using the Data Center App Performance Toolkit
For performance and scale testing we recommend you use the Data Center App Performance Toolkit. Check out the Data Center App Performance Toolkit User Guide For Jira or Data Center App Performance Toolkit User Guide For Confluence for a detailed instructions on how to:
Install the toolkit on a testing host,
Add your app’s customized actions to the toolkit,
Set up an enterprise-scale Data Center deployment on AWS, and
Run the tool to collect performance and scale data.
Using your own testing environment
If you already have a testing environment or prefer to use a different set of testing tools, you can still use that. Test and document how your application performs in a Data Center deployment with one, two, and four application nodes. For full requirements about the performance data you need to provide, see Performance and scale testing your Data Center app.
Lucene index test for JIRA
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.
We strongly recommend using the Data Center App Performance Toolkit to conduct this test, as it ships with an appropriate dataset for testing. Upon completing the index, please take a screenshot of the acknowledgment screen displaying the re-index time and attach it to your DC HELP ticket. This takes ~50minutes without an app installed.
Step 3: Provide support escalation details
To facilitate quick resolution to any issues or impacts on the App, Atlassain recommends below activities (Service desk portal and responsible contact person).
a clear escalation process for your customers available to Data Center licensed apps,
defining a single point of contact (which can be a mailing list) to raise escalations with,
to maintain the owner of the app contact in the DCHELP ticket, and
letting Atlassain know if you have an SLA with customers on Data Center licensed apps
Step 4: Create your Marketplace submission
Once steps 1-3 are completed and the approval on the technical review of your app is received, we can submit the app to Marketplace. Before uploading the Add-on in Marketplace we have the add the Data-Center compatibility descriptor in the Add-on as shown below.
Add Data Center compatibility to your add-on descriptor
<param name="atlassian-data-center-status">compatible</param> <param name="atlassian-data-center-compatible">true</param>
The
atlassian-data-center-status
parameter indicates to Marketplace and UPM that your app has been submitted for technical review according to these Data Center requirements.The
atlassian-data-center-compatible
parameter was previously used to indicate Data Center compatibility and should be included for backward compatibility with older UPM versions
Here’s an example of a generic plugin-info
block with these parameters:
<plugin-info>
<description>${project.description}</description>
<version>${project.version}</version>
<vendor name="${project.organization.name}" url="${project.organization.url}" />
<param name="atlassian-data-center-status">compatible</param>
<param name="atlassian-data-center-compatible">true</param>
</plugin-info>
Note:If the app is an OBR artifact with bundled dependencies, the above parameters should be included in both the main app descriptor as well as the descriptors for any dependencies.
Tools used:
J-Meter tool is used in automating the performance and scaling tests. The scripts and the actions included in the tests are listed below.
Test-kit for testing and provisions Jira instance in AWS:
https://developer.atlassian.com/platform/marketplace/dc-apps-performance-toolkit-user-guide-jira/
Checklist for App testing in Data Center
Task no | Task Name | Time estimate | Tools required |
---|---|---|---|
1 | Prepare and submit the Technical readiness checklist to Atlassian | 2-3 hrs |
|
2 | Provision a AWS instance for Jira Data Center | 2-3 hrs |
|
3 | Create Sample data in the Jira Instances as per the requirement | 4-5 hrs |
|
4 | Run performance and scale tests using J-meter scripts with 1, 2 & 4 nodes | 2 hrs |
|
5 | Perform Lucene Index testing with 1M issues | 2 hrs |
|
6 | Collect and Submit the performance test | 1 hrs |
|
Estimated cost for the Data Center testing:
AWS Cost Involved
Total cost is around $151 for 40 hours per week.
Estimate | ||||
Service Type | Components | Region | Component Price for 40 hrs Per week | Service Price |
Amazon EC2 Service (US East (N. Virginia)) |
|
|
| $116.96 |
| Compute: | US East (N. Virginia) | $116.96 |
|
Amazon RDS Service (US East (N. Virginia)) |
|
|
| $36.37 |
| DB instances: | US East (N. Virginia) | $30.62 |
|
| Storage: | US East (N. Virginia) | $5.75 |
|
AWS Support (Basic) |
|
|
| $0 |
| Support for all AWS services: |
| $0 |
|
|
| Free Tier Discount: |
| $-2.3 |
|
| Total Monthly Payment: |
| $151.03 |