Last updatedDec 5, 2019

Submitting your Data Center app to Atlassian Marketplace

Atlassian is introducing a new program of requirements for vendors who want to publish Data Center approved apps in Atlassian Marketplace. In order to participate, here's what you need to do:

  1. Complete a technical readiness checklist
  2. Test your app and document the results
  3. Provide support escalation details
  4. Create your Marketplace submission

Note: Data Center App development has a number of considerations over standard Atlassian Server App development. Thus, before submitting your app, you will need to ensure that your team has read and considered the Guidelines for Data Center app development.

Step 1. Complete a technical readiness checklist for your app

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 that you submit should have its own associated checklist. If your 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.

View the Data Center app readiness checklist (PDF download)

When you submit your checklist to Atlassian, we will create a technical review ticket on your behalf. We'll use this ticket to capture the other requirements and ask you any questions about your submission.

You can follow this ticket to track the progress of your submission.

Step 2. Test your app's performance at scale

Once we've created your technical review ticket, you'll add info to it about how your app performs at scale. We want to see how well your app handles the types of user load our biggest customers typically see.

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

Data Center customers operate our products in mission critical environments and want to feel confident that if issues arise they can be addressed quickly. Likewise if you or Atlassian find any significant issues that may impact customers, or if Atlassian detects a breaking change that impacts your app, we want to be able to quickly work to a resolution with you.

To aid in this process, we are asking to verify on your Data Center app ticket:

  • 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 us know if you have an SLA with customers on Data Center licensed apps

Step 4. Create your Marketplace submission

Once you've completed steps 1-3 above, and we've given you approval on the technical review of your app, it's time to submit your app to Marketplace. Atlassian will begin accepting Data Center submissions in August 2018. In the meantime, you can make preparation for completing these steps.

Add Data Center compatibility to your app descriptor

Before submitting your app to Marketplace, update your app descriptor (atlassian-plugin.xml) to contain the following parameters in the plugin-info section:

1
2
<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 you have submitted an app 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:

1
2
3
4
5
6
7
<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>

If your app is an OBR artifact with bundled dependencies, you should include the above parameters in both the main app descriptor as well as the descriptors for any dependencies.

Define your artifact type

Single Artifact

No Action Required

Optionally, we would like you to update your app descriptor (atlassian-plugin.xml) to contain the following parameters in the plugin-info section for your artifact:

1
<param name="plugin-type">both</param>

Separate Artifacts

You will be required to update your app descriptor (atlassian-plugin.xml) to contain the following parameters in the plugin-info section for your server and DC artifact:

Server Artifact:

1
<param name="plugin-type">server</param>

Data Center Artifact:

1
<param name="plugin-type">data-center</param>

Upload your app to Marketplace

Now you're ready to add a new version of your app to the Marketplace. A few things to keep in mind before you list your new version:

  • These instructions assume that you already have a published Server app in Marketplace.
  • Server- and Data Center-compatible versions of your app share a single Marketplace listing. This means if you already have a Server app, the Data Center-compatible version will be on the same app details page.
  • You can use a single artifact for both Server and Data Center. When you upload it to Marketplace, you can choose whether the version should be compatible with both Data Center and Server, or just Data Center.
  • If you use a single, shared artifact for Server and Data Center, both versions need to have the same payment model. Data Center apps can be either free or Paid via Atlassian.

Here's how to add a new Data Center version of your app:

  1. Log in to https://marketplace.atlassian.com/ with your vendor account.
  2. Click Manage vendor account from the profile menu in the upper right.
  3. Click the name of the app you're adding a Data Center-compatible version for.
  4. Click Create version.
  5. Upload the artifact to which you've added the Data Center parameters above.
  6. You'll be prompted to decide whether your new version should be compatible with both Data Center and Server, or Data Center only.
  7. Follow the steps to submit your app for publication. You'll be prompted to provide a link to the technical review ticket we created for you.

The first Data Center version of your app will require approval by the Marketplace team. Your technical review ticket will need to be in the "approved" state before your app can be published in Marketplace.

Updates to program requirements

During 2018 we will continue to develop and release Performance Testing tools, benchmarks on performance and guidelines on monitoring and improving the performance of Atlassian Data Center products. As we do so, we'll update the Data Center App Readiness Checklist, documentation and guidelines for Vendors.

From time to time, Atlassian will be reviewing the requirements for publishing apps to the marketplace for Data Center. As we do so, we will provide these alterations ahead of time and release clear guides on how they should be adopted. In 2018, we'll be introducing performance testing tools across the Data Center suite with benchmarks around standard performance and response times of key activities users undertake. As these technologies and benchmarks are published, we'll be reviewing the requirements in line with this.

Performance tools will help you benchmark the performance of our Data Center products, with or without your app installed. Sample data sets that demonstrate the complexity of customer data will assist you in your application testing, and will be provided by Atlassian.