Skip to main content
Version: Deploy 24.1

Atlassian Bamboo plugin

This topic describes using a CI tool plugin to interact with Deploy.

As a preferred alternative starting with version 9.0, you can utilize a wrapper script to bootstrap XL CLI commands on your Unix or Windows-based Continuous Integration (CI) servers without having to install the XL CLI executable itself. The script is stored with your project YAML files and you can execute XL CLI commands from within your CI tool scripts.

For details, see the following topics:

About the plugin​

The Deploy plugin for Atlassian Bamboo enables two tasks:

  • Publish to Deploy
  • Deploy with Deploy

These tasks can be executed separately or combined sequentially.

For information about Bamboo requirements and the configuration items (CIs) that the plugin supports, see the Bamboo Plugin Reference.

To download the plugin, go to the Atlassian Marketplace.

tip

To ensure that the Bamboo server is in sync with the Deploy server, restart the Bamboo server after each upgrade of the Deploy server.

note

The Bamboo Deploy plugin cannot set values for hidden CI properties.

Features​

  • Publish DAR package to Deploy
  • Trigger deployment in Deploy
    • Update mappings on upgrade
  • Execution on Windows/UNIX Slave nodes

Publish to Deploy​

You can use the publish task to publish a deployment package (DAR file) to Deploy. The following properties can be configured:

  • Server URL (required): Address of the Deploy server.
  • Deploy Username (required): User ID to use when logging in to the Deploy server.
  • Deploy Password (required): Password for the Deploy user.
  • DAR file pattern (required): File pattern where the DAR file can be found. The result should be exactly one file. Example: **/*.dar searches for any file in any subfolder that has the .dar extension.
  • Work directory (optional): Changes the work directory location. The default is the work directory of the task used.

Deploy with Deploy​

You can use the deploy task to deploy an application with Deploy. The application must already be published to Deploy (you can do this with the Publish to Deploy task).

The following properties can be configured:

  • Server URL (required): Address of the Deploy server.
  • Deploy Username (required): User ID to use when logging in to the Deploy server.
  • Deploy Password (required): Password for the Deploy user.
  • Environment (required): The environment to which the application will be deployed.
  • Application (required): The deployment package (DAR file).
  • Version (required): The version of the deployment package.
  • Orchestrators (optional): Orchestrator to use. The default is Deploy's default used orchestrator. Use a comma (,) as a separator when specifying multiple orchestrators.
  • Update deployeds (optional): Update the deployeds and mappings on an update. This keeps any previous deployeds present in the deployment object, unless they cannot be deployed due to their tags. It will add all deployeds that are still missing.
  • Action on failure (optional): The action to perform on failure. You can choose to cancel the task (this is the default), to rollback the task, or to do nothing. If you do nothing, the task will stay in Deploy, and you can manually review, cancel, or roll back the task from Deploy.