Datacenter Add-on testing documentation for Atlassain approval
Objective:
Get approval from Atlassain for submitting the Add-on as Data-center approved in the Atlassain marketplace.
Introduction:
Atlassian has introduced new requirements for vendors who want to publish Data Center approved apps in Atlassian Marketplace. In order to get the Add-on approved on the Atlassain Marketplace, the below tasks has to be completed:
- Complete a technical readiness checklist
- Test your app and document the results
- Provide support escalation details
- Create your Marketplace submission
Test Implementation Steps:
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
Completed the performance and scale testing of your add-on as listed below:
- Detail your application testing for the deployment of your application in multiple Data Center nodes,
- Detail the validation steps you take to ensure data is consistent in your application across multiple Data Center nodes,
- Detail your application testing for the installation and upgrade of your application in a mutli node Data Center deployment, and
- Detail any user testing steps you take to ensure features work in standard Data Center multi node deployment (such as our AWS deployments).
For Enhanced User profile the Testing was done on the AWS. The Jira data-center was deployed and tested with various nodes (1, 2 & 4) for the below actions. The test results are noted for the below scenarios
- Performance and Scale test results without Add-on for 1 node.
- Performance and Scale test results with Add-on for 1 node.
- Performance and Scale test results with Add-on for 2 nodes.
- Performance and Scale test results with Add-on for 4 nodes.
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.
AWS Jira data-center is used as the infrastructure to carryout the testing of the Add-ons. The template used is attached. The template has been modified to work on N-Virginia AWS region.
Test-kit for testing and provisions Jira instance in AWS: https://developer.atlassian.com/platform/marketplace/dc-apps-performance-toolkit-user-guide-jira/
Timing Plan for Enhanced User profile Add-on Testing:
Tasks | Activity | Responsibility | Estimation in hrs | Start date | End Date | Status | Comments |
---|---|---|---|---|---|---|---|
1 | Install Jira Data-center for validating the Add-on. Local Environment | This is required to show to JIRA assessment team | |||||
1.1 | Pre-requisites | Mar-4-2019 | Mar-6-2019 | ||||
1.1.1 | Node-1,2 and3 with Jira installation | YUVARAJ KUNDASI (Unlicensed) | 3 | COMPLETED | |||
1.1.2 | Load Balancer | YUVARAJ KUNDASI (Unlicensed) | 3 | COMPLETED | |||
1.1.3 | Jira DB | YUVARAJ KUNDASI (Unlicensed) | 3 | COMPLETED | |||
1.1.4 | JIRA Instance(Application and Application media storage) | YUVARAJ KUNDASI (Unlicensed) | 3 | COMPLETED | |||
1.2 | Test app and document the results as defined in the readiness document. | Mar-8-2019 | Mar-15-2019 | Attachment link : https://developer.atlassian.com/platform/marketplace/dc-apps-submitting-your-app/ | |||
1.2.1 | Complete Performance and Scale testing | Ref link: https://developer.atlassian.com/platform/marketplace/dc-apps-performance-and-scale-testing/ | |||||
1.2.1.1 | Create User Actions list for the performance testing. Automate the tests using Jmeter | Dipesh Chouksey (Unlicensed) | 4 | IN PROGRESS | |||
1.2.1.2 | Deploy 1 nodes data center with data in AWS. | YUVARAJ KUNDASI (Unlicensed) | 2 | COMPLETED | To be deployed just before testing to save costs. | ||
1.2.1.3 | Perform and Capture results for the performance actions with and without Add-on scenarios | Deepthi Reddy N B (Unlicensed) | 12 | COMPLETED | |||
1.2.2 | Scale testing steps & Method | YUVARAJ KUNDASI (Unlicensed) | 2 | COMPLETED | Performance testing steps for different deployments (1, 2 & 4 ) nodes | ||
1.2.2.1 | Deploy 1 Node data center with data. | 4 | COMPLETED | To be deployed just before testing to save costs. | |||
1.2.2.2 | Test User Actions list for the performance testing for 1 node | 4 | COMPLETED | ||||
1.2.2.3 | Deploy 2 Node data center with data. | 4 | COMPLETED | To be deployed just before testing to save costs. | |||
1.2.2.4 | Test User Actions list for the performance testing for 2 node | 4 | COMPLETED | ||||
1.2.2.5 | Deploy 4 Node data center with data. | 4 | COMPLETED | To be deployed just before testing to save costs. | |||
1.2.2.6 | Test User Actions list for the performance testing for 4 node | 4 | COMPLETED | ||||
2 | Provide support escalation details to Atlassian for Data Center Compatibility | ||||||
2.1 | Create a clear escalation process for your customers available to Data Center licensed apps | 1 | COMPLETED | ||||
2.1 | Define single point of contact (which can be a mailing list) to raise escalations with | 1 | TO DO | ||||
2.1 | Create and maintain the owner of the app contact in the DCHELP ticket | 1 | TO DO | ||||
2.1 | Create and communicate Atlassian about SLA with customers on Data Center licensed apps | 1 | TO DO | ||||
3 | Complete technical review with Atlassian after submitting the readiness document. | Atlassian & Empyra | 40 | TO DO | Dependency with Atlassian | ||
4 | Contingency plan for App changes & review with Atlassain | Atlassian & Empyra | 40 | TO DO | |||
5 | Add Data Center compatibility to your app descriptor | Dipesh Chouksey (Unlicensed) | 2 | TO DO | |||
6 | Upload App to Marketplace | Karthikh Pandian | 2 | TO DO | |||
Total hours | 144 |
Reference links:
- Data-Center Monitoring documentation
- JConsole Monitoring
- Monitoring Application & database connection usage in Jira
- Performance and Scale testing Sample
- Jira Data generator