Cloning a Bamboo instance

You can clone an existing Bamboo instance by getting a new Bamboo instance in the same version and using the setup of the existing one.

You may want to transfer a snapshot of your current production Bamboo instance to a test server as permitted in the license agreement.

Cloning Bamboo can be a step in preparation for migrating to another database or for upgrading.

  • If you are using Jira or Crowd for user management, the URL of the Bamboo server may change when you clone the Bamboo instance, in which case you will need to edit that setting for the Bamboo application in Jira/CROWD to match the new URL.
  • When cloning your Bamboo instance using the export/import process, you must re-install all of your apps manually.

License

Development licenses are available for any Commercial or Academic license. Create one or contact us for help.



On this page:

Cloning a Bamboo instance to a new server

To clone a Bamboo instance to a new server:

  1. Export/Backup your original Bamboo instance.
  2. Install the same version of Bamboo on the new server.

    If you are cloning a Bamboo instance to the same server, make sure that the original Bamboo instance doesn't have the same installation path as the new Bamboo instance.
  3. On the new server, go to <bamboo-install-dir>/WEB-INF/classes, where <bamboo-install-dir> is the directory where you've extracted the downloaded package.

  4. Open the bamboo-init.properties file in a text editor and set the bamboo.home variable to the new path of the Bamboo home directory.

    If you are cloning a Bamboo instance on the same server, make sure that the new Bamboo instance doesn't have the same home directory path as the original Bamboo instance.

  5. Start the new Bamboo instance and import the existing export/backup data prepared in Step 1.

Alternative cloning scenario

If your current instance has grown too large and export/import does not work, you can still clone your instance by using an alternative backup and restore strategy.

The approach is to clone the content of the Bamboo home directory and make it available to the new Bamboo instance:

  1. Stop the original Bamboo instance.
  2. Create a backup:

    embedded DB

    external DB

    Compress the original Bamboo home directory into a .zip file. The embedded database is included in the directory.


    • Compress the original Bamboo home directory into a .zip file.
    • Create a database backup with the native tools.
    tip/resting Created with Sketch.

    You can reduce the size of a compressed <bamboo-production-home> file by deleting the <bamboo-home-dir>/local-working-dir directory that contains working copies of the checked-out sources.

    For more information about migrating databases, see Move data to a different database.

  3. Restart the original Bamboo instance.
  4. Install the same version of Bamboo on the new server.

    If you are cloning a Bamboo instance to the same server, make sure that the original Bamboo instance doesn't have the same installation path as the new Bamboo instance.

  5. Transfer the compressed original Bamboo home directory to the new server where you installed the new Bamboo instance.
  6. Replace the content of the new Bamboo home directory with the content of the unzipped home directory.
  7. On the new server, go to <bamboo-install-dir>/WEB-INF/classes, where <bamboo-install-dir> is the directory where you've extracted the downloaded package.
  8. Open the bamboo-init.properties file in a text editor and set the bamboo.home variable to the new path of the Bamboo home directory.

    If you are cloning a Bamboo instance on the same server, make sure that the new Bamboo instance doesn't have the same home directory path as the original Bamboo instance.

  9. (External DB only) Create a new database for the cloned instance and import the external database backup.

  10. In the new Bamboo home directory, open bamboo.cfg.xml and <bamboo-shared-home-dir>/configuration/administration.xml in a text editor. Then, change the server names/IP addresses according to the new location.

  11. (External DB only) Edit bamboo.cfg.xml in the new Bamboo home directory, and enter the new database connection details and credentials.

    Before starting Bamboo, depending on your motivation for cloning, you may also want to ensure any customizations that were made in the previous Bamboo instance's installation directory are also copied to the clone. Examples of customizations include proxy settings, additional JVM arguments and JVM memory allocation tweaks. These customizations most commonly exist in:

    • <bamboo-install-dir>/bin/setenv.sh
    • <bamboo-install-dir>/conf/server.xml
  12. Start the new Bamboo instance.

Next steps

  • (Optional) You can upgrade the new Bamboo instance.
  • If the new server has different locations for:
    • JDKs
    • Ant
    • Maven
    • Perforce
    • Msbuild tools
    adjust the settings in the server capabilities settings to match the locations on the new server.
Last modified on Feb 20, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.