Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The 'Project with Issues' snapshot type includes all issues and related data - comments, work log entries, issue links, issue history, and of course, attachments.

The attachment metadata (filename, creator, create date, etc.) is small enough to always be included in the snapshot. However, including the attachment files can make the snapshot grow very large, which is why Configuration Manager allows two ways of handling attachments.

  1. Include attachment files in the snapshot. This is the preferred option for moving projects with fewer attachments (roughly less than 100 MB). A local copy of each file will be made during export regardless of their storage location (local or in Amazon S3). Therefore, you need to have sufficient space available during the export. Once the snapshot is created, these local copies will be deleted.

  2. Do not include attachment files in the snapshot. With this option, the This option makes the snapshot size considerably smaller and makes deployment faster. Depending on what type of storage system you’re using, this option’s prerequisites may differ.

    • If you’re using the local file storage system…
      The attachment files for the exported projects will need to be manually copied and moved to a temporary folder

    on your local system or in your Amazon S3 storage
    • . During

    the snapshot
    • deployment, Configuration Manager

    will ask for the path to the files' directory. It
    • will copy

    the files
    • and transfer them from the temporary folder to their correct place in Jira’s attachments directory using the metadata in the snapshot

    . With this option, the snapshot size will be considerably smaller and will be deployed faster
    • .

    • If you’re using an Amazon S3 storage system…
      You won’t need to copy anything. You’ll just have to provide the attachments directory during deployment. The attachments will be linked up with the help of the metadata in the snapshot.

Tip

Jira stores the attachment files in separate directories by project key.

  • An example of a local directory file storage - $Jira_Home/data/attachments/

  • An example of an Amazon S3 directory storage - $AWS_bucket/attachments/

Create a Project Snapshot with Issues

...

When deploying a snapshot with issues, if the attachment files are not included in the snapshot, you can provide a path where the files reside. Configuration Manager will pick the files from there and attach them to their relevant issues. After the deployment is complete, Configuration Manager will store the files in the Jira attachment directory.

Info

Note that the option to import attachment files from either the file system or S3 will appear in the deployment wizard only when:

  • At least one issue in the snapshot has an attachment, and

  • The attachment files are not included in the snapshot.

...

Note

Store the attachment files in a temporary folder on your local system or in your use a cloud-based storage like Amazon S3 storage. Avoid using Jira’s attachment directory.

...

When prompted by Configuration Manager, provide the path to the temporary directory. After the deployment, the temporary directory is not needed anymore and can be deleted.

...

If the temporary directory does not contain sub-directories for some of the projects in the snapshot, Configuration Manager will show the following warning:

...

To fix this, you’ll need to either change the path you provided or check the directory’s access rights.

There was an unexpected error related to Amazon S3.

If Configuration Manager fails to authenticate your Amazon S3 storage account, the following error will appear:

...

To fix this, you'll need to check the Jira log, which will contain more detailed information about the error you encountered.