Last updated Feb 2, 2022

Rate this page:

Submitting your Data Center app to Atlassian Marketplace

Atlassian is introducing a new program of requirements for partners 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 the results of your security check and generate your dependency tree
  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.

The Annual Review Process

Applications taking part in the DC Approved program need to be re-approved annually.

The system will automatically notify you one month before the Annual Review date is due, this will initiate the re-approval process. In order to remain in the DC Approved program, you will need to complete the annual review survey and provide the results of the security check with the dependency tree. Please use the latest version of your app for all tests.

If the Annual Review process is not completed by the set renewal date a reminder e-mail will be sent out 2 weeks after the due date. If Atlassian does not hear from the partner after the warning notification, nor does the partner start the Annual Review process, Atlassian will initiate the removal process for the app on the partner's behalf.

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 submitted app 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.

The process of submission for non-installable apps is the same as for installable ones. However, the technical checklist differs from the checklist for installable apps.

The necessity of Performance and Scale testing is discussed on a case-by-case basis depending on the application.

To kick off the review process create a “Data Center Approval“ request type for the supported Data Center product at this location: Service desk.

We'll use this ticket to capture the other requirements and ask you any questions about your submission.

More details on the process can be found here.

Testing against major databases:

The technical readiness checklist contains the section related to testing against the major databases (PostgreSQL, MySQL, Microsoft SQL Server, Oracle). Despite accessing DB directly or through AO, it is required to proceed with the explicit testing against a list of the supported databases, specifically, functionality that involves any operation with the Database.

In case your app does not access DB directly or through AO, it is necessary to check the successful installation of the application. This point doesn’t require running Performance and Scale tests against all databases. This requirement is related to confirmation that your plugin is able to work independently against the database type.

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:

  • Install the toolkit on a testing host,
  • Add your app-specific actions to the toolkit,
  • Set up an enterprise-scale Data Center deployment on AWS, and
  • Run the tool to collect performance and scale data.

Check out the for a detailed instructions:

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 or Jira Service Management 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 the results of your security check and generate your dependency tree

All initial and annual DC apps reviews have to provide results of security scanning for third party dependencies vulnerabilities with any tool of your choice.

Security scanning report should be free of critical- and high-severity security vulnerabilities in third party dependencies bundled with the app.

Dependency tree of an app needs to be generated and attached to DCHELP ticket during the review process. Based on dependency tree and app package file we do sanity check for third party dependencies vulnerabilities with DC Apps Security Scanner.

If any additional critical- and/or high-severity security vulnerabilities are found by DC Apps Security Scanner sanity check we would apply Security Bug Fix Policy for Marketplace Apps. For more details see Regular security scanning.

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.

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
<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
2
<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
2
<param name="plugin-type">server</param>

Data Center Artifact:

1
2
<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 partner 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

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 partners.

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.

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.

Rate this page: