This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

You can configure Bamboo to automatically create a backup each night, rather than doing a manual export every time.

Before you begin:

  • Bamboo will be unavailable while the backup process completes. Depending on the number of builds and tests, the export may take a long time to complete and may require large amounts of disk space. Please make sure you have enough disk space before proceeding.
  • Bamboo will not export if it detects that plans are currently being built. Please ensure that you do not have plans building (see Viewing Bamboo's Current Activity).
  • There is a bug in Bamboo 1.2 which causes the dependency associations to not be exported along with the plans. If you are using Bamboo 1.2, please upgrade to Bamboo 1.2.1 for a fix.

To specify a backup schedule,

  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Scheduled Backups' link in the left navigation column. The 'Scheduled Backup Details' page will be displayed, showing details about the status of scheduled backups or any currently configured backup.
  3. Click the 'Edit' button to edit the current 'Scheduled Backup Details'.
  4. Select the 'Backup Artifacts' check box if you want to include build artifacts in your scheduled backups.
    (info) Ensure that the 'Disable scheduled backups' check box is cleared to ensure that your automatic backups will be performed.
  5. In the 'Backup path' field, specify the directory where you want to store your backups. Each backup will be stored as a single file.

    Please Note:

    1. Backups may require large amounts of disk space. Please make sure you have enough disk space before proceeding.
    2. Due to a tightening of the Bamboo security model, Bamboo may not initially allow you to edit this field. If this is the case, you must first configure Bamboo to permit modification to its file path settings. To do this:
      1. Start Bamboo with the system property bamboo.paths.set.allowed=true, by following the procedure for configuring a Bamboo system property.
      2. Restart this procedure from step 1 (above).
  6. In the 'Backup file prefix' field, specify the first part of the filename for all your backup files.
  7. In the 'Backup file date pattern' field, specify the date/time format for identifying your individual backup files. This will be appended to the 'Backup file prefix' to form the complete filename for your backup files, e.g.:
    • if your 'Backup file prefix' is 'bamboo_backup_' and your 'Backup file date pattern' is 'yyyy_MM_dd', then your backup file on 31st July 2007 would be named 'bamboo_backup_2007_07_31'.
  8. In the 'Schedule' field, choose one of the following frequencies at which backups will be executed:
    • 'Daily' — creates a backup every day. If you choose this option, select the time 'Interval' with which Bamboo will execute backups:
      • 'once per day' — If you choose this option, select the time of day at which the backup will be conducted.
      • Any other 'Interval' option — select the segment of time in a day during which the backups will be conducted.
    • 'Days per Week' — creates a backup on specific days of a week. If you choose this option, select the check boxes next to the days of the week on which you want the backups conducted. Also, specify the time 'Interval' with which Bamboo will execute backups on these days. (Refer to the 'Daily' interval options above for details.)
    • 'Days per Month' — creates a backup on a specific day of a calendar month. If you choose this option, select either:
      • The calendar date of the month on which the backup will run.
      • The day of the week in the calendar month on which the backup will run.
    • 'Advanced' — creates a backup whose schedule is dependent on a Cron expression. For more information on creating Cron expressions, please refer to the documentation on creating Cron expressions in Bamboo.

      Bamboo will be unavailable for the duration of the backup, so choose a time of day or night when usage is low.

  9. Click the 'Save' button.
    (info) Your first backup will run when your server's clock matches the specified time.

If your Bamboo instance is publicly accessible or is accessible to anyone outside your organisation, then to minimise the risk of Bamboo being compromised by security-related attacks, we recommend restarting Bamboo without the system property bamboo.paths.set.allowed=true (or with this system property disabled). Please refer to Configuring System Properties for details on configuring Bamboo's system properties.

To disable a scheduled backup,

  1. Click the 'Administration' link in the top navigation bar.
  2. Click the 'Scheduled Backups' link in the left navigation column. The 'Scheduled Backup Details' page will be displayed, showing details about the status of scheduled backups or any currently configured backup.
  3. Click the 'Edit' button to edit the current 'Scheduled Backup Details'.
  4. Select the 'Disable scheduled backups' check box.
    (info) Your schedule details will be retained, but no automatic backups will be performed.
  5. Click the 'Save' button.

Screenshot: Scheduled Backups

  • No labels



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Tweet, blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.