External Storage

Owned by Manisha Khilaare (Deactivated)
Last updated: Oct 18, 2023
5 min read

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.

The steps to configure the external storage are:

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

  2. Click the + icon to display the Add External Storage pop-up window.
    Select the storage type from the Storage Type dropdown list. You can select any one of the storage types from the list.

     

  3. Click Next to display the External Storage Details popup window.

     

  4. Add relevant information in the fields.
    Name - Name of the external storage.
    Region - Specify the region where the external storage is located.
    Access Key- Enter the access key ID.
    Secure Key - Enter the secret access key.

Refer to the list of Region for AWS S3 and IBM COS

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

The External Storage Integration page displays the name of the external storage with the following fields:
Name- displays the name of the external storage that you have set.
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 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.

 

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 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.

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.

     

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

     

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

  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.

    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,

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

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


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