Versions Compared

Old Version 3

changes.mady.by.user Manisha Khilaare (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Dominik Trygar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFBDAD

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-administration-guides/system-setup/external-storage.html

The External Storage feature allows efficient management of disk space ensuring that projects with varying attachment sizes can be handled effectively to optimize storage resources. You can connect the new projects to the external storage. You can also migrate the attachments of the existing projects from internal storage to external storage.

Configure External Storage

An Administrator has to configure the external storage for projects.

Provider - displays the provider name of the external storage.

Region - specifies the region where the external storage is located.

Status - displays the status of the external storage; ACTIVE or INACTIVE

Project Count - displays the number of projects saved in the particular storage.

Actions - displays the actions you can perform.

Edit Icon- allows editing of the storage information. Clicking this icon takes you to the External Storage Details page, where you can edit only the Access Key and the Secret Key.

Handshake Icon - checks the status of the external storage.

The steps to configure the external storage are:

  1. Go to Administrator > External Storage. The External Storage Integration page opens.

    Image RemovedImage Added

  2. Click the + icon to display the Add External Storage pop-up window.

  3. Select the storage type from the Storage Type dropdown list. You can select any one of the storage types from the list. View filenameInvalid file id - 534e1822-6f60-4c34-a80e-a49e97ace3e4

uuid-a8d53ba2-65ca-2895-659f-9d337bd59628.pngImage Added

  • AWS S3

  • IBM COS

  1. Click Next to

...

  1. view the External Storage Details

...

  1. dialog box. The external storage options appear based on the Storage Type selected (AWS S3 or IBM COS).

    Image Modified

...

  1. Enter the required details:
    For AWS S3

uuid-e1a8acd6-a4aa-d5f3-fdd4-b877d062e08f.pngImage Added

  • Name - Name of the external storage.

  • Bucket Name - Specify a bucket name. For more information on Bucket naming rules, refer to AWS S3.

  • Region - Specify the region where the external storage is located. Refer to the list of Region for AWS S3

  • Access Key- Enter the access key ID.

  • Secure Key - Enter the secret access key.

...

For IBM COS

...

5. Click Submit. On successful configuration of the external storage the following message displays.

...

uuid-db9e81e5-5d2f-74a2-9a31-34cc87f75f25.pngImage Added

  • Custom Option - Select any one of the following options from the list:

    • Custom - Custom storage options allow you to configure storage solutions that cater to specific requirements.

    • Default – The storage options are default provided by IBM COS to meet the storage needs without customization

  •      Name - Name of the external storage.

  • Bucket Name - Specify a bucket name. For more information on Bucket naming rules, refer to IBM COS.

  • Region - Specify the region where the external storage is located. Refer to the list of regions for IBM COS.

...

  • URL -

...

  • Enter the storage URL if you have selected the Custom Option as Custom. This allows seamless integration with your existing infrastructure.

  • Access Key - Enter the access key ID.

  • Secure Key - Enter the secret access key.

  1. Click Submit. Upon successful configuration of the external storage, the following message appears:

...

  1. The External Storage Integration page displays the name of the external storage with the following fields:

...

Work with the External Storage

In the external storage. , each project is mapped to a single bucket. The bucket is created when you map the external storage with project. The buckets are named with the naming convention ‘file name-unique instance identifier'. The attachments of a project are saved in the designated storage that you mention during project set up. The files are stored in project buckets with a naming convention as ‘entity type/unique attachment id’.

Setup an External Storage for a new Project

While creating a new project from the Project Setup, you can add set up an external storage to save the attachments of the project.
You can select the storage from the drop-down list that shows active storage.

Once you set the external storage for a project, you cannot change it to a different storage.

  • You can connect external storage to new projects only. You cannot change the storage type for the existing projects.

    • ...

    ...

    Migrate Attachments from Internal Storage to External Storage

    You can migrate the attachments of existing projects from internal storage to external storage.

    • Setting the external storage for a project is recommended for On-Premise users only. For SaaS users, SmartBear hosts the Zephyr Data (file attachments) with unlimited storage.

    • If the external storage for a project is enabled the On-Premise users will never be able to migrate to Zephyr Enterprise SaaS.

    • Once you set the external storage for a project, you cannot change it to a different storage.

    The steps to migrate attachments to the external storage are:

    1. Go to Administrator > Project Setup. The Project Setup and Management page opens.

      Image Added

    2. Click on the project whose attachment you want to migrate to external storage. The project details display in the Edit Project section.

      Image Added

    3. Click the Migrate button to move the attachments from internal storage. The Migrate to external storage window pops up.

      Image Added
    Info

    Before you choose to migrate the attachments to the external storage, you must know that:

    • Once you change the storage for internal attachments to external storage, it cannot be changed.

    • The migration of files locks the project for all users until the migration is complete.

    • Once the migration process begins, all users with access to the project will need to re-login.

    1. Select the external storage from the Select external Storage drop-down list and click Proceed. The file migration starts. The system locks the project until the files get migrated.

    2. Log in to the system again.

    3. Open the Project Setup> Project Setup and Management. Click the project you chose to migrate from the list of projects.
      In the Edit Project section, you can see that the Attachment Storage has changed.

      Image Added

      Note: You can migrate multiple project attachments from internal storage to external storage at the same time.

    4. Click the Migration Status button to check the status of the migration.

      1. If the migration is successful, you get the following popup window,

        Image Added

        Click the Mark Migration as Finished button to finish the migration.

      2. If the migration is not successful, you get the following popup window,

        Image Added


        Click the Retry button to migrate the failed files again. If facing issue, you can contact the Zephyr Support.