Installing Storage Software Appliance

Before You Begin

Steps for Installing Oracle Cloud Infrastructure Storage Software Appliance

Note:

If the server is running on Oracle Linux, go to Step 11 to install the appliance.

Docker and NFS protocol are installed automatically on the server.

  1. Log in to the server on which you want to install Oracle Cloud Infrastructure Storage Software Appliance.
  2. Edit /etc/yum.repos.d/public-yum-ol7.repo on the host on which you want to install the appliance.
    • Change the value of enable to 1 in addons.
    • Change the value of enable to 1 in optional_latest.
  3. (Optional) Install docker using yum:

    sudo yum install docker-engine

    Run this command only if you have to install docker manually.

  4. Restart the server:

    sudo shutdown -r now

  5. Enable non-root users to use docker client.
    1. Add a new group (docker) to the host:

      sudo groupadd docker

    2. Modify your user account and add your user name to the docker group:

      sudo usermod -a –G docker username

    3. Log out and log in again.
  6. Run the following commands to set up the appliance host to work around the docker socket:

    NO_PROXY=localhost,127.0.0.1/8,/var/run/docker.sock

    no_proxy=$NO_PROXY

  7. Start docker and ensure that docker is running by entering the following commands:
    • sudo systemctl start docker

    • sudo systemctl enable docker

  8. (Optional) Install nfs-utils using yum:

    sudo yum install nfs-utils

    Run this command only if you have to install nfs-utils manually.

    The nfs-utils package enables NFS protocol on your host.

  9. Start rpcbind and nfs-server and ensure the NFS protocol is running by entering the following commands:
    • sudo systemctl start rpcbind
    • sudo systemctl start nfs-server
    • sudo systemctl enable rpcbind
    • sudo systemctl enable nfs-server
  10. Check if the NFS protocol version is 4:

    sudo rpcinfo -p | grep nfs

  11. Extract the files from the installer to a directory on the appliance host by entering the command:

    tar -xvf installer_tar.gz

  12. Change the permission of the oscsa-install.sh file:

    chmod +x oscsa-install.sh

  13. Check the status of docker:

    sudo systemctl status docker

  14. Verify the information in docker:

    sudo docker info

  15. Run the oscsa-install.sh file:

    sudo ./oscsa-install.sh

    The default installation location on the appliance host is /opt/oscsa_gateway.

    The appliance creates local copies of the files in the local buffer until the files are copied to your account. By default, the location of the buffer is in a subdirectory of /var/lib. However, if there isn’t sufficient storage space in /var/lib, then use this option and specify a location for data storage, metadata, and log storage.

    (Optional) Alternatively, you can run the oscsa-install.sh file with any of the following options:
    • -a: To run the installation in advanced mode.
    • -p: To specify that Oracle Cloud Infrastructure Storage Software Appliance is running with a proxy server.
    • -q: To run the installation in quiet mode. 
    • -d: To install at the specified installation path.
    • -h: To display the help information.

    Sample output

    *************************************
    Imported temporary env vars from opc to this install session
    *************************************
    Checking that docker is installed and using the correct version
    Pass found docker version Docker version 17.06.2-ol, build d02b7ab
    WARNING: devicemapper: usage of loopback devices is strongly discouraged for production use.
             Use '--storage-opt dm.thinpooldev' to specify a custom block storage device.
    WARNING: devicemapper: usage of loopback devices is strongly discouraged for production use.
             Use '--storage-opt dm.thinpooldev' to specify a custom block storage device.
    
    *************************************
    Checking host prerequisites
    *************************************
    
    Detected linux operating system
    Checking kernel version
    Pass kernel version 4.1.12-61.1.18.el7uek.x86_64 found
    Checking NFS version
    Pass found NFS version 4
    
    *************************************
    All prerequisites have been met
    *************************************
    
    
    *************************************
    Begin installation
    *************************************
    
    Enter the install location press enter for default (/opt/oscsa_gateway/) : 
    Installing to destination /opt/oscsa_gateway/
    Copied install scripts
    Copied OCISSA image
    Starting configuration script
    
    Enter the path for OCISSA Cache storage : /oscsa/cache
    
    Enter the path for OCISSA Metadata storage : /oscsa/metadata
    
    Enter the path for OCISSA Log storage : /oscsa/log
    Writing configuration
    Importing image
    d0c367ad7015: Loading layer [==================================================>]  233.7MB/233.7MB
    1bef79313f6a: Loading layer [==================================================>]  395.6MB/395.6MB
    50affcccd4ca: Loading layer [==================================================>]  3.072kB/3.072kB
    02651725b81e: Loading layer [==================================================>]  3.072kB/3.072kB
    9d65e9622255: Loading layer [==================================================>]  62.21MB/62.21MB
    ...
    Loaded image: oscsa_gw:1.4
    Loaded image: oraclelinux:7.3
    Creating OCISSA Volume with args -v /oscsa/cache:/usr/share/oracle/ -v /oscsa/metadata:/usr/share/oracle/system/ -v /oscsa/log:/var/log/gateway 
    Applying configuration file to container
    Starting OCISSA [oscsa_gw:1.4]
    Setting up config file port with nfs
    Setting up config file port with rest
    Management Console: https://prd-linux-srv5:443
    If you have already configured an OCISSA FileSystem via the Management Console,
    you can access the NFS share using the following port.
    
    NFS Port: 32769
    Example: mount -t nfs -o vers=4,port=32769 appliance_host_name:/OCISSA FileSystem name/local_mount_point
    In the advanced setup, you can configure the following additional parameters:
    • DATASTORAGE: Specifies the disk location or mount path where the Oracle Cloud Infrastructure Storage Software Appliance disk cache will be stored.
    • MDSTORAGE: Specifies the disk location or mount path where the Oracle Cloud Infrastructure Storage Software Appliance metadata will be stored.
    • LOGSTORAGE: Specifies the disk location or mount path where the Oracle Cloud Infrastructure Storage Software Appliance logs will be stored.
    • ADMINPORT: Specifies the port on the appliance host to access the management console.
    • NFSPORT: Specifies the port on the appliance host to access NFS.

    Note:

    During the appliance installation, the directories for storing data, metadata and log storage are automatically created if they don’t exist
  16. Check the status of the firewall:

    sudo firewall-cmd --state

  17. Open the firewall ports on the appliance host by entering the following commands:
    • sudo firewall-cmd --zone=public --add-port=nfs_port/tcp --permanent
    • sudo firewall-cmd --zone=public --add-port=management_web_ui_port/tcp --permanent
    • sudo firewall-cmd --reload

    Example:

    sudo firewall-cmd --zone=public --add-port= 32774/tcp --permanent

    sudo firewall-cmd --zone=public --add-port= 32775/tcp --permanent

    sudo firewall-cmd --zone=public --add-port= 32776/tcp --permanent

    sudo firewall-cmd --reload

  18. Start the appliance:

    oscsa up

The installation might take up to 30 minutes to run, download images, and import the images into the docker.

When the installation is complete, you can see the details of Oracle Cloud Infrastructure Storage Software Appliance as shown in the following sample output.

Make a note of the management console URL, which has the following format:

https://appliance_host_name:port_number

Sample output

Starting NFS on docker host
Applying configuration file to container
Starting OSCSA [oscsa_gw:1.4]

Management Console: https://myApplianceHost.example.com:32771


If you have already configured an OCISSA FileSystem via the Management Console,
you can access the NFS share using the following port.

NFS Port: 32770

Example: mount -t nfs -o vers=4,port=32770 myApplianceHost.example.com:/OCISSA_filesystem_name /local_mount_point
In the sample output,
  • myApplianceHost.example.com is the appliance host name
  • 32771 is the management console port number

Tip:

You can use either the appliance host name or the IP address in the management console URL.

  • You can find the name of the appliance host by entering the following command:

    hostname

  • You can find the IP address of the appliance host by entering the following command:

    ip addr

The management console is a web application running within Oracle Cloud Infrastructure Storage Software Appliance. You can open the management console by using a web browser. Then you can create your administrator and log in to the management console to create your first filesystem. For more information, see Creating Your First FileSystem.