How to automate installing add-ons for Atlassian applications

Owned by Former user (Deleted)
Last updated: Nov 04, 2019 by Smita Nair
6 min read

On this page

Description

Never has it been easier to automate the setup of new Atlassian applications for testing or production. This shows how a single command installs and licenses all the add-ons you require for your standard Atlassian application setup. We use this type of automation for setting up test instances on a regular basis. 

To optimize this solution, we recommend you create a licenses directory with all your add-on licenses as discussed in How to install and license many apps. Do this once and keep it updated as necessary.

The following requires a CLI 8.3 or higher client.

Jira

atlassian jira -a run --file install-jira-addons.txt


install-jira-addons.txt
# Install standard add-ons with licenses for Jira
#
# atlassian jira -a run --file install-jira-addons.txt

upm -a runFromList --continue \
               --common "-a installApp --wait --app @entry@" \
               --list " \
                   org.swift.jira.cli, \
                   org.swift.jira.acli, \
                   org.swift.jira.cot, \
                   org.swift.jira.cw, \
                   org.swift.jira.clone-plus, \
                   \
                   is.origo.jira.tempo-plugin, \
                   com.almworks.jira.structure, \
                   \
                   com.googlecode.jira-suite-utilities, \
               "

upm -a addLicenses --file licenses

Confluence

atlassian confluence -a run --file install-confluence-addons.txt
install-confluence-addons.txt
# Install standard add-ons with licenses for Confluence
#
# atlassian confluence -a run --file install-confluence-addons.txt

upm -a runFromList --continue \
               --common "-a installApp --wait --app @entry@" \
               --list " \
                   org.swift.confluence.cli, \
                   org.swift.confluence.acli, \
                   org.swift.confluence.cache, \
                   org.swift.confluence.excel, \
                   org.swift.confluence.flash, \
                   org.swift.confluence.html, \
                   org.swift.confluence.macrosecurity, \
                   org.swift.confluence.markdown, \
                   org.swift.confluence.run, \
                   org.swift.confluence.sql, \
                   org.swift.confluence.script, \
                   org.swift.confluence.table, \
                   org.swift.confluence.visio, \
                   org.swift.confluence.wiki, \
                   com.appfire.confluence.codepro, \
                   com.atlassian.confluence.extra.graphviz, \
                   \
                   com.adaptavist.confluence.contentFormattingMacros, \
                   net.customware.confluence.plugin.linking, \
                   net.customware.confluence.plugin.reporting, \
                   net.customware.confluence.plugin.composition, \
                   net.customware.confluence.plugin.visibility, \
                   net.customware.confluence.plugin.scaffolding, \
                   com.atlassian.confluence.plugins.editor.confluence-source-editor, \
               "

upm -a addLicenses --file licenses

Bitbucket

atlassian bitbucket -a run --file install-bitbucket-addons.txt
install-bitbucket-addons.txt
# Install standard add-ons with licenses for Bitbucket
#
# atlassian bitbucket -a run --file install-bitbucket-addons.txt

upm -a runFromList --continue \
               --common "-a installApp --wait --app @entry@" \
               --list " \
                   org.swift.stash.cli, \
                   org.swift.stash.acli, \
               "

upm -a addLicenses --file licenses

Bamboo

atlassian bamboo -a run --file install-bamboo-addons.txt
install-bamboo-addons.txt
# Install standard add-ons with licenses for Bamboo
#
# atlassian bamboo -a run --file install-bamboo-addons.txt

upm -a runFromList --continue \
               --common "-a installApp --wait --app @entry@" \
               --list " \
                   org.swift.bamboo.cli, \
                   org.swift.bamboo.acli, \
                   org.swift.bamboo.groovy, \
                   com.appfire.bamboo.sql, \
                   com.davidehringer.atlassian.bamboo.maven.maven-pom-parser-plugin, \
                   org.gaptap.bamboo.maven.maven-artifact-download-plugin, \
               "

upm -a addLicenses --file licenses

Example Output

This is an example run of the Bamboo setup script from above.

Example
atlassian bamboo -a run --file install-bamboo-addons.txt 

# Install standard add-ons with licenses for Bamboo
#
# atlassian bamboo --action run --file install-bamboo-addons.txt


Run: upm -a runFromList --common "-a installApp --wait --app @entry@" --list " org.swift.bamboo.cli, org.swift.bamboo.acli, org.swift.bamboo.groovy, com.appfire.bamboo.sql, com.davidehringer.atlassian.bamboo.maven.maven-pom-parser-plugin, org.gaptap.bamboo.maven.maven-artifact-download-plugin, "

Run: -a installApp --wait --app org.swift.bamboo.cli
Waiting for install to complete ..
App 'Bob Swift Atlassian Add-ons - Bamboo CLI Connector' installed with version 7.7.0. Version number was 770. App key is org.swift.bamboo.cli.

Run: -a installApp --wait --app org.swift.bamboo.acli
Waiting for install to complete ..
App 'Bob Swift Atlassian Add-ons - Run CLI Actions in Bamboo' installed with version 7.7.0. Version number was 770. App key is org.swift.bamboo.acli.

Run: -a installApp --wait --app org.swift.bamboo.groovy
Waiting for install to complete .
App 'Bob Swift Atlassian Add-ons - Groovy Tasks' installed with version 2.8.0. Version number was 280. App key is org.swift.bamboo.groovy.

Run: -a installApp --wait --app com.appfire.bamboo.sql
Waiting for install to complete .
App 'Bob Swift Atlassian Add-ons - SQL Tasks' installed with version 1.2.0. Version number was 120. App key is com.appfire.bamboo.sql.

Run: -a installApp --wait --app com.davidehringer.atlassian.bamboo.maven.maven-pom-parser-plugin
Waiting for install to complete .
App 'Maven POM Value Extractor' installed with version 1.7.0. Version number was 72. App key is com.davidehringer.atlassian.bamboo.maven.maven-pom-parser-plugin.

Run: -a installApp --wait --app org.gaptap.bamboo.maven.maven-artifact-download-plugin
Waiting for install to complete .
App 'Maven Artifact Download Plugin' installed with version 1.1. Version number was 15. App key is org.gaptap.bamboo.maven.maven-artifact-download-plugin.

Run completed successfully. 6 actions were successful 


Run: upm -a addLicenses --file licenses
License is the same as existing license for add-on org.swift.bamboo.groovy. Ignore request.
License added to app org.swift.bamboo.acli.
License added to app com.appfire.bamboo.sql.
4 apps found that use licensing. 3 licenses added or matched existing license. 

Run completed successfully. 2 actions were successful from file '.../install-bamboo-addons.txt'.