Upgrading Storage Gateway

Storage Gateway notifies you when there is a new version available for you to download and install:

  • A pop-up notification appears in the management console after you log in.
  • A small banner notification appears at the top of the Dashboard.
  • If you have configured email notifications, the system sends an email notification. See Configuring Email Notification for details.
Important

If you are upgrading from Storage Gateway 1.0, underlying database and schema changes require you to recreate your Storage Gateway file systems. See Recreating Your File Systems for details.

Before You Begin

  • Plan for downtime appropriately since the upgrade takes some time to complete. The downtime varies depending on the system resources, the number of file systems, and the number of files.
  • Wait for any pending or ongoing write operations from the NFS client instances to complete, then unmount all file systems.
  • Wait for pending uploads to Oracle Cloud Infrastructure Object Storage to complete. On the Dashboard under System Status, ensure that the Pending Uploads field shows 0.
  • Disconnect all of the file systems.
  • Ensure that there is no ongoing activity in the Activity tab for each file system in the management console.

    Important

    To enable partial update capabilities in Storage Gateway, there must be no pending uploads for any associated file systems before the upgrade. The upgrade process purges the existing local cache across all Storage Gateway file systems.

Upgrading Storage Gateway

To upgrade to Storage Gateway 1.3
  1. Log in to your Storage Gateway host.
  2. Download the Storage Gateway 1.3 tar archive.
  3. Extract the files from the downloaded ocisg-1.3.tar.gz file:

    tar xvzf ocisg-1.3.tar.gz

    This command extracts the file's contents to a subdirectory named ocisg-1.3.

  4. Change directory to ocisg-1.3:

    cd ocisg-1.3
  5. Run the installation script as sudo or root user:

    sudo ./ocisg-install.sh

If you encounter any interruption during the upgrade, such as lost connectivity, rerun the installation script to resume the upgrade.

If you are upgrading from Storage Gateway 1.0, you must recreate the file systems that were created in the 1.0 version of the Storage Gateway software. Connect the file systems in the management console and claim ownership if there's a bucket ownership prompt. Storage Gateway version 1.3 rebuilds the local metadata for existing buckets in Object Storage. The more objects there are in the buckets, the more time it takes to rebuild the metadata.

Recreating Your File Systems

When you created file systems in Storage Gateway 1.0, corresponding Oracle Cloud Infrastructure Object Storage buckets were created. Recreate those file systems in Storage Gateway so that you can connect to the same buckets and automatically see the files that have already been uploaded to Object Storage.

When you recreate Storage Gateway file systems, data that you already uploaded to Oracle Cloud Infrastructure Object Storage is automatically included in the newly created file system.

To recreate your file systems
  1. Log in to the management console.
  2. Click File Systems on the upper-right area of the management console.
  3. Click Create File System.
  4. Enter the required information in Create a File System:

    • File System Name: A unique, friendly name for the file system. Avoid entering confidential information. Use the following guidelines when naming a file system:

      • Use from 1 to 256 characters.
      • Valid characters are letters (upper or lower case), numbers, hyphens, underscores, and periods.

      Important

      The name cannot contain the following:

      • A slash (/) character because this character delimits bucket and object names in Oracle Cloud Infrastructure Object Storage
      • The strings "pub" or "priv"

      If an Object Storage bucket by this file system name doesn’t exist in your tenancy, the bucket is created.

      If a corresponding Object Storage bucket by this file system name exists in your tenancy and there is data in the bucket, Storage Gateway works asynchronously to sync the bucket and file system contents.

    • Select the Object Storage tier in which you want to store your data
      Important

      Once set, you cannot change the storage tier in which a bucket resides.

      You can use the Oracle Cloud Infrastructure Object Storage object lifecycle policies feature to manage the archiving and deletion of objects in a bucket according to a predefined schedule. See Using Object Lifecycle Management for details.

      • Standard: The Standard tier is the primary default Object Storage tier for storing data that requires frequent and fast access. See Overview of Object Storage for more information.
      • Archive: The Archive tier is a special tier for storing data that is accessed infrequently and requires long retention periods. See Overview of Archive Storage for more information. Access to data in the Archive tier is not immediate since you must restore archived data before it’s accessible (see Restoring Files and Objects from Archive Storage).
    • Object Storage endpoint: Required. The Object Storage API endpoint for your service instance. To find the object storage API endpoint for your Oracle Cloud Infrastructure Object Storage tenancy, see the API documentation for Oracle Cloud Infrastructure Object Storage.

      Important

      The following information is required to connect your Storage Gateway file systems to Oracle Cloud Infrastructure. See Required Keys and OCIDs for detailed information on how to generate the required keys and where to obtain these OCIDs.
    • Compartment OCID: Required. Unique identifier of your Oracle Cloud Infrastructure Object Storage compartment.
    • Tenant OCID: Required. Unique identifier of your Oracle Cloud Infrastructure Object Storage tenancy.
    • User OCID: Required. Unique identifier of your Oracle Cloud Infrastructure Object Storage user.
    • Public Key's Finger Print: Required. Your Oracle Cloud Infrastructure Object Storage public key fingerprint.
    • Private Key: Required. Your Oracle Cloud Infrastructure Object Storage private key.
    • Private Key Passphrase: Required if a passphrase was specified during key creation. Your Oracle Cloud Infrastructure Object Storage private key passphrase.

      Note

      Your private key and passphrase are securely stored in the Storage Gateway docker. The Storage Gateway installation generates a pair of public and private keys. The system uses the public key to encrypt sensitive data.
  5. Click Save.

    The values you entered must match your Oracle Cloud Infrastructure credentials. If you get an error message, verify your entries, update any incorrect values, and click Save again.

  6. Click Show Advanced File System Configuration.

    Enter the required configuration information or click Use Default to accept the default values:

    • NFS Allowed Hosts: A comma-separated list of hosts allowed to connect to the NFS export. You can also specify * to allow all hosts to connect.

      For example: 2001:db8:9:e54::/64, 192.0.2.0/24

    • NFS Export Options: The NFS export options.

      Example: rw, sync, insecure, no_subtree_check, no_root_squash

      Important

      Do not specify the fsid option.
    • Concurrent Uploads: The number of concurrent uploads to Oracle Cloud Infrastructure.

      This field indicates the maximum number of files that can be concurrently uploaded in Storage Gateway. If the value is 15, the concurrent file uploads can be between 1-15.

      The allowed range is from 1 to 30.

    • Sync Policy: The metadata operations are flushed to the disk based on the sync policy, but do not affect on-disk consistency. Currently, only Posix Standard is supported. Only the synchronous transactions (like fsync, ODSYNC, and OSYNC) are committed to the disk. All other transactions are handled asynchronously.
    • Cloud Read-ahead: The number of blocks to be downloaded and used to read ahead when reading files for improved performance.

      Default value: 50

    • Maximum Read Cache Size in GiB: The maximum read cache.

      When the read cache is full or reaches the configured limit, Storage Gateway removes files from the cache based on a least recently used (LRU) algorithm. Files pending upload to your tenancy are not removed from cache. You can also preserve files that you do not want removed from cache.

      Note

      The number of files in cache is limited to 20,000, regardless of the specified cache size in bytes.

      See Configuring the Cache for File Systems for details.

      The default value depends on how you provisioned local storage before installing Storage Gateway. The recommended local storage disk size is 600 GB (500 GB for file system cache, 80 GB for metadata, 20 GB for log). If you followed the documented recommendations, the default value for the read cache is approximately 300 GB.

  7. Click Save.

    The file system is created and appears in the File Systems listing.