Oracle Cloud Infrastructure Documentation

Installing Storage Gateway

This topic provides instructions for installing the Storage Gateway software.

Prerequisites

These instructions assume that you are familiar with the administration and configuration commands of the operating system on your host machine. To install Storage Gateway, your host system must meet certain hardware and software requirements.

Hardware Recommendations and Requirements

To run Storage Gateway, the host machine must meet the following requirements:

  • Two dual-core CPUs or better. Oracle recommends 4-core CPUs.
  • Minimum memory requirements:

    • 16 GB for required for any Storage Gateway file system.
    • 32 GB for file systems up to 50 million files.
    • 64 GB for file systems up to 100 million files.
  • The recommended local storage disk size is 600 GB, which includes 500 GB for the file system cache, 80 GB for metadata storage, and 20 GB for log storage.

    Important

    Provision local storage before installing Storage Gateway. For best performance, allocate dedicated local storage file systems for the Storage Gateway cache, the metadata, and the logs. The installation script prompts you for the paths to your Storage Gateway file system cache, metadata storage, and log storage locations. Follow the disk size recommendations provided by the installer.

    Oracle recommends that you use the XFS file system for the file system cache, metadata, and logs. XFS is a 64-bit file system designed for parallel I/O. Parallel I/O allows a system to scale based on the number of I/O threads and file system bandwidth.

Software Requirements

  • Oracle Linux 7 with UEK Release 4 or later.

    Note

    If you create an Oracle Cloud Infrastructure Compute instance to host Storage Gateway, the instance creation wizard provides an option to choose the operating system image.

  • Docker 1.12.6 or newer. Docker is an open platform for building, shipping and running distributed applications. For more information, see https://www.docker.com/.

  • NFSv4.

Note

The Storage Gateway installation software automatically installs Docker and the NFS protocol.

Hosting Storage Gateway on an Oracle Cloud Infrastructure Compute Instance

To host Storage Gateway on an Oracle Cloud Infrastructure Compute instance, you need:

  • An SSH key pair in PEM format.

    • To create a key pair, see Creating a Key Pair.
    • If your public key is not in PEM format, use the following command to convert it:

      ssh-keygen -f <key_name>.pub -e -m pem
  • An Oracle Cloud Infrastructure user account with an API signing key (the public key from your SSH key pair).

  • A VCN and related resources. For help creating a VCN, see VCNs and Subnets.

    The following configuration points apply to your VCN:

    • Do not select the Use DNS Hostnames in this VCN check box unless you plan to use DNS hostnames for your Storage Gateway Compute instance.
    • The security list must include a rule to allow SSL (443) ingress.

    • After you install the Storage Gateway software your host machine, you must add a security list rule to allow communication with the management console port. More information appears on this page after the Storage Gateway installation instructions.
  • A Compute instance. See Creating an Instance.

    The VM.Standard2.4 Compute shape meets the minimum required specifications for Storage Gateway. Large file systems might require an image with more resources.

  • A Block Volume. See Creating a Volume.

Installing Storage Gateway

You can install Storage Gateway on an Oracle Cloud Infrastructure Compute instance or an on-premises host that meets the hardware and software requirements.

To install the Storage Gateway software

Security List Requirements for Compute Instance Installations

If you installed Storage Gateway on an Oracle Cloud Infrastructure Compute instance, that instance must be able to receive HTTPS connections from other hosts and allow communication with the Storage Gateway management console. To open the necessary port, add an ingress rule to the security list governing the instance's host subnet. To learn about VCN security control, see Security Lists.

Important

This installation task assumes that your existing security list already allows traffic to port 443, as described in the Hosting Storage Gateway on an Oracle Cloud Infrastructure Compute Instance section of this page. If port 443 is not open, you must add a security list rule to open it.

To add a security list rule

Verifying and Updating the Storage Driver in Docker

To verify the storage driver in Docker:

  1. Start docker:

    sudo systemctl start docker
  2. Verify the information in docker:

    sudo docker info
  3. Look for Storage Driver in the output. For example:

    Containers: 0
     Running: 0
     Paused: 0
     Stopped: 0
    Images: 0
    Server Version: 18.03.1-ol
    Storage Driver: overlay2
     Backing Filesystem: xfs
     Supports d_type: true
     Native Overlay Diff: false
    Logging Driver: json-file
    Cgroup Driver: cgroupfs
    Plugins:
     Volume: local
     Network: bridge host macvlan null overlay
     Log: awslogs fluentd gcplogs gelf journald json-file logentries splunk syslog
    Swarm: inactive
    Runtimes: runc
    Default Runtime: runc
    Init Binary: docker-init
    containerd version: 773c489c9c1b21a6d78b5c538cd395416ec50f88
    runc version: 4fc53a81fb7c994640722ac585fa9ca548971871
    init version: 949e6fa
    Security Options:
     seccomp
      Profile: default
     selinux
    Kernel Version: 4.1.12-124.15.4.el7uek.x86_64
    Operating System: Oracle Linux Server 7.5
    OSType: linux
    Architecture: x86_64
    CPUs: 4
    Total Memory: 13.45GiB
    Name: ocisg-mahesh
    ID: OJ2H:QUSK:BWQZ:25L6:VI5V:CXGX:WFXT:NNNP:RK6O:OS4P:4ABE:JWMV
    Docker Root Dir: /var/lib/docker
    Debug Mode (client): false
    Debug Mode (server): false
    Registry: https://index.docker.io/v1/
    Labels:
    Experimental: false
    Insecure Registries:
     127.0.0.0/8
    Live Restore Enabled: false
    
    Registries: docker.io (secure)
    

    Note

    You can ignore the devicemapper warning message, if it appears.

    If Storage Driver is notdevicemapper, do the following:

    1. Stop docker:

      sudo systemctl stop docker
    2. Look for /etc/docker/daemon.json in the host.

      If the file daemon.json does not exist, create it.

    3. In the daemon.json file, set the storage-driver variable to devicemapper:

      {
      "storage-driver": "devicemapper" 
      }
    4. Restart docker:

      sudo systemctl start docker
    5. Verify the information in docker:

      sudo docker info

      Look for Storage Driver in the output and verify that the storage driver is devicemapper.

Next Step

Logging In to the Storage Gateway Management Console