Jira Backup Module

From SEPsesam
Jump to: navigation, search

Copyright © SEP AG 1999-2017. All rights reserved.

Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP AG. When compiling and designing user documentation SEP AG uses great diligence and attempts to deliver accurate and correct information. However, SEP AG cannot issue a guarantee for the contents of this manual.

Overview

In cooperation with catWorkX, SEP sesam has developed a reliable backup and restore solution for JIRA, the issue tracking and project management system by Atlassian. catWorkX SEP sesam integration JIRA backup add-on in combination with SEP sesam software provide a simple way for backing up JIRA database configuration.

Generally, there are two main approaches for backing up JIRA. The first one is to back up your database configuration in which JIRA information is stored (file dbconfig.xml). Note that database configuration does not include attachments and plugins. The second one is to prepare for a disaster recovery of your JIRA instance. This consists of backing up your JIRA installation and data directory, which contains application data for your JIRA instance, including attachments. The second approach is more complex, since it includes more backup modules and requires configuration of more backup tasks for complete backup of JIRA instance. For details, see SEPsesam Extension for Jira.

To back up JIRA database configuration, you have to install and configure a CatworkX Atlassian JIRA backup module and SEP sesam software, and then create a backup task. Restoring JIRA database configuration is simple and straightforward, following standard restore procedure.

Requirements

  • SEP Sesam Client version 4.4.3 or higher
  • SEP Sesam Server version 4.4.3 or higher
  • catWorkX Atlassian JIRA backup module
  • JIRA admin username and password

Hardware requirements for SEP sesam Server or RDS.

Requirements SEP sesam Server Standard edition SEP sesam Advanced Server edition SEP sesam Premium Server edition SEP sesam Enterprise Server
Memory (without Si3 deduplication) 8 GB RAM Minimum 16 GB RAM 32 GB RAM Minimum 64 GB RAM
Memory (with Si3 deduplication) Minimum 16 GB RAM Minimum 32 GB RAM 64 GB RAM Minimum 128 GB RAM
Core (without Si3 deduplication) 1x CPU with 4 cores 1x CPU with 8 cores Minimum 1x CPU with 8 cores Minimum 2x CPUs with 4 cores
Core (with Si3 deduplication) 1x CPU with 6 cores 2x CPUs with 8 cores 2x CPUs with minimum 8 cores Minimum 2x CPUs with 8 cores
Minimum hard disk space for SEP sesam metadata 100 GB 300 GB 500 GB 500 GB
No. of backup clients Up to 15 Recommended up to 50 Recommended up to 150 Recommended for more than 150

Supported distributions

For the list of supported distributions, see SEP REAR Support Matrix.

Configuring JIRA database configuration backup

To prepare JIRA for backup, you first need to install and configure a CatworkX Atlassian JIRA backup module, and then configure a backup task in SEP sesam. During the backup, a dump file of the project definition is created and backed up using the SEP Sesam Client.

Installing JIRA backup module add-on

1. In your JIRA instance, login as Jira-Admin and switch to the system configuration menu.

Jira addon.jpg

2. Select Plugins -> Manage Add-ons from menu or search the Atlassian marketplace for the catWorkX SEP sesam integration JIRA backup add-on, and install it.

3. Enter your license key. The plugin is ready to use.

4. Set up an administrative user in the add-on options. Note that the same username and password must also be configured in SEP sesam.

Jira addon options.jpg

Configuring backup with SEP sesam

To back up your data, you have to create a backup task (select the data to be backed up), then set up a backup schedule (specify when you want to back up your data), and link a backup event to it (select where to back your data to and how). For general details on how to configure a backup and its prerequisites, see Standard Backup Procedure. However, creating a backup task differs from a standard procedure and requires some JIRA-specific steps, which are described below.

JIRA-specific backup task

1. Configure a backup task from the Main Selection -> Tasks -> By clients -> select your client -> New backup task. The New backup task window appears.

2. Enter the Task name. Give your task a meaningful descriptive name (max. 15 letters), e.g., jira_backup.

3. From the Backup type drop-down list, select JIRA.

4. Specify the Source, which is in JIRA's case the URL to the JIRA instance (in our case localhost).

Jira task.jpg

5. Click the tab Options to open JIRA additional backup options. Optionally, enter one of the following options in the Save options field under the Additional call arguments. See the screenshot below for an example.

The following special options are available:

   Common backup and restore options:
     -a jira_user=username          - specify JIRA login username
     -a jira_password=password      - specify JIRA login password
     -a jira_path=/path/            - specify path to jira data directory
    
   Backup options:
     -a nodelete                    - skip removing created dump file after backup
     -a nocheck                     - skip checking created dump file for contents
    
   Restore options:
     -a noimport                    - skip import after restore
   Browse options:
    -D                             - check for JIRA installation (processlist)

Jira backup task additional options

Jira task options.jpg

6. Save your task and proceed as described in Step 2 and 3 in the Standard Backup Procedure.

What is next?

JIRA Database Configuration Restore

See also

SEPsesam Extension for Jira

Standard Backup Procedure