Managing and Monitoring the Appliance

Managing the Appliance

You can use the oscsa command-line tool to manage Oracle Cloud Infrastructure Storage Software Appliance. Log in to the host on which you installed the appliance and enter:

To start Oracle Cloud Infrastructure Storage Software Appliance:
oscsa up
To stop Oracle Cloud Infrastructure Storage Software Appliance:
oscsa down

Note:
If the server with an Oracle Cloud Infrastructure Storage Software Appliance instance fails, you can reinstall and start another instance. All the configuration and system data is automatically downloaded and applied. The pending upload and download activities are resumed when the Oracle Cloud Infrastructure Storage Software Appliance instance is running again.
If a disk cache is irrecoverable on the server with the Oracle Cloud Infrastructure Storage Software Appliance instance, then data might be lost, as the file might not have been transferred to the container or bucket in your account. To ensure efficient data protection, see Best Practices for Using Storage Software Appliance.
To view details about Oracle Cloud Infrastructure Storage Software Appliance and how to access the management console:
oscsa info
To find out the version of Oracle Cloud Infrastructure Storage Software Appliance:
oscsa version
To configure Oracle Cloud Infrastructure Storage Software Appliance to use a proxy server to connect to the storage service:
oscsa configure proxy [http_proxy_server https_proxy_server]

Note:
After configuring the proxy server, you must stop and restart Oracle Cloud Infrastructure Storage Software Appliance.

By default, no proxy server is specified.
To remove the proxy server details in Oracle Cloud Infrastructure Storage Software Appliance:
oscsa configure proxy [remove]
To configure Oracle Cloud Infrastructure Storage Software Appliance to use SSL to access the management console:
oscsa configure ssl true

SSL is enabled by default.

Note:
After configuring Oracle Cloud Infrastructure Storage Software Appliance to use SSL, you must stop and restart Oracle Cloud Infrastructure Storage Software Appliance.

To disable SSL: oscsa configure ssl false
To specify ports for the Oracle Cloud Infrastructure Storage Software Appliance services:
oscsa configure port service port_number
- service: Specify admin or nfs.
- port_number: Ensure that the port number is not already in use on the appliance host.
By default, the port number is assigned dynamically for the Oracle Cloud Infrastructure Storage Software Appliance services when you start the appliance.

To remove the static port assignment for a service: oscsa configure port service remove

Note:
For the port assignment to take effect, you must stop and start the appliance.
To allocate memory for Oracle Cloud Infrastructure Storage Software Appliance in the appliance host:
oscsa configure memory memory_in_GB

To remove the memory allocation:

oscsa configure memory remove

By default, Oracle Cloud Infrastructure Storage Software Appliance uses 4 GB from the available memory on the appliance host. You can delete the memory information by using the remove parameter.

Note:
After configuring memory for Oracle Cloud Infrastructure Storage Software Appliance, you must stop and restart Oracle Cloud Infrastructure Storage Software Appliance.
To specify the docker network mode:
oscsa configure network mode

The mode can be either host or bridge.

The default mode is bridge. In this mode, you can run multiple instances of the appliance on your host.

In the host mode, you can run only a single instance of the appliance. Network performance is better in this mode.

Note:
After specifying the docker network mode, you must stop and start the appliance.
To view help for the available commands:
oscsa help

Monitoring Upload Activity

The Activity tab shows the ongoing and pending upload activity in a filesystem.

When you upload a file to a filesystem, you can view the status of the upload activity.

Log in to the management console.
Select the filesystem.
Click the Activity tab.
You can see the upload progress of the file in the Uploading pane.

Monitoring System Status Health Check

Health Check

You can monitor the overall system status through the System Status pane in the right side of the management console.

The appliance health check service is an automated process run on the system to monitor the status of the following:

Services – Databases used by the appliance, management console and other auxiliary processes
Disk space – Local storage
For example: If the available local storage is lesser than 10 GB, the health check service reports this as an alert.

Depending on the appliance health check analysis, the following status is displayed in the System Status pane:

Healthy
Unhealthy

The appliance health check service also displays the following details in the System Status pane and highlights potential issues:

Throughput
Available local cache
Pending uploads

Local Cache Modes

The Local I/O mode might display any one of the following values based on the local disk usage:

Normal
The free space is higher than 10 GB in the appliance. You can upload files in the appliance and store them in your account.
Rejecting I/O
The free space is lower than 10 GB in the appliance. The appliance is running on protection mode and will not allow any writes to its local disk. All read operations will work as normal. All metadata operations will fail in the appliance except for deletion and truncation.

To return to Normal mode, you must wait until all the ongoing upload activities are complete and the files are removed from the local cache.

Note:

For optimum local storage configuration, see Best Practices – Configuring Cache Storage.

You can also view the system status details and track any issues using the support bundle. See Viewing System Notifications.

Monitoring Appliance Storage Usage

The System Stats tab enables you to track the storage usage and availability.

Log in to the management console.
Select the System tab on the upper-right side of the management console.
Click the System Stats tab in the System pane.
The system data is displayed in the following three panes:
- Local Storage
- Local I/O
- Local Resources

Local Storage

In this pane, you can view a graphical representation of the amount of storage being used and available free storage on the appliance host, with the following details:

Available local storage
Storage used for pending uploads and preserved cache files
Storage used for metadata
Storage used for logging
Storage used for other applications

Local I/O

This pane displays the local I/O mode of the appliance based on the local disk space usage in the appliance host.

Local Resources

In this pane, you can view the overall memory usage and memory availability for the appliance from the following fields:

Available Cores -The number of CPUs being used by the appliance
Maximum Memory Available to the Appliance - The total RAM available for the appliance
Memory Used by the Appliance - The amount of memory being used by the filesystems in the appliance
Free Memory - The amount of free RAM available in the appliance host

Viewing System Notifications

The System Notifications tab allows you to view the system notifications and track the overall system performance.

Log in to the management console.
Select the System tab on the upper-right side of the management console.
Click the System Notifications tab in the System pane.
You can view the list of warnings or critical system notifications.

Configuring Email Notification

Alternatively, you can provide the required configuration details and get notified about the system health checks through email.

Log in to the management console.
Select the System tab on the upper-right side of the management console.
Click the System Notifications tab in the System pane.
A message is displayed:

Email notifications are not configured. Click here to configure.
Click on the Click here to configure link.
Enter the required information for the following fields:
- SMTP server
- Email addresses to receive notifications
Click Show Advanced, and enter the required information in the advanced configuration fields:
- SMTP port
- SMTP User name
- SMTP Password
- Sender’s Email Address
  Default value: noreply@oracle.com
Click Save.
Click Test Email Notification to verify if a system notification email has been sent successfully to the email id you’ve provided in the management console.

Downloading Support Bundle

If you contact Oracle Support Services about any issue with the appliance, then you may need to provide the support bundle to help the Oracle Support Services technician diagnose the issue.

Log in to the management console.
Select the System tab on the upper-right side of the management console.
Select the Help tab.
Click Download Support Bundle in the System Logs pane.
You can download and save the support bundle.

Support Bundle

The support bundle contains the following information:

All necessary logs for diagnostics
Local storage usage information
Basic system information such as memory size, Docker version, appliance version etc.
List of filesystems

Upgrading the Appliance

Appliance Upgrade Matrix

This table provides the available release versions to upgrade the appliance, depending on the current version.

Current Appliance Release Version	Available Appliance Release Versions for Upgrade
16.3.1.0.9 or earlier	16.3.1.4 Note: To upgrade to 16.3.1.4, you must first upgrade to 16.3.1.0.13, and then upgrade to 16.3.1.4.
16.3.1.0.10 16.3.1.0.12 16.3.1.0.13	16.3.1.4
16.3.1.2, 16.3.1.3	16.3.1.4

Before You Begin

Check the Table 3-* for the available appliance release versions to upgrade the appliance, depending on the current version.
Ensure that the filesystems are mounted.
Check if the file uploads that are in progress in the filesystems have been completed. Ensure that there is no ongoing activity in the Activity tab for a filesystem in the management console. See Viewing the Details of a FileSystem.
Ensure that you plan the downtime appropriately, as the upgrade may take some time. The downtime varies, depending on the system resources and if there are any filesystems to be restored from the cloud. If there are no filesystems to be restored, approximately 1 million records per minute may be transferred during migration, depending on the available system resources. If the filesystem needs to be restored from the cloud, then additional time would be required to download the metadata information and prepare the metadata database for migration

To minimize downtime, configure and connect the filesystems on the current appliance version before you upgrade the appliance.

Steps

Log in to the host on which you want to upgrade Oracle Cloud Infrastructure Storage Software Appliance.
Stop the appliance:
oscsa down
Delete the following files in the directory where you downloaded and extracted the previous version of the appliance installer:
- OSCSA_GATEWAY_README.txt
- OSCSA_RELEASE_NOTES.txt
- oscsa
- oscsa-config.sh
- oscsa-control.sh
- oscsa-install.sh
- oscsa-upgrade.sh
- oscsa_gw:1.0.x.tar
Remove the existing docker version:
sudo yum remove docker

Install docker using yum:

sudo yum install docker-engine
Extract the files from the latest version of the installer to a directory on the appliance host by entering the command:
tar -xvf installer_tar.gz
Run installer.sh extracted from the latest version of the installer. For more information, see Installing Storage Software Appliance.

When you upgrade the appliance, the filesystem configuration is retained even after you delete the old installation files on the host. You can view all the filesystems that you created when you access the management console after the upgrade.

Release 16.3.1.2 included filesystem changes which require migration of filesystem internal data (metadata). The migration takes place automatically when your filesystems are reconnected for the first time during or after the upgrade. The duration of the migration process is dependent on the size of the filesystem and can range from a few minutes to an hour or more. During the migration, all filesystems are in read-only state.

Caution:

Do not delete any filesystem or change the properties of a filesystem during the migration.
Do not reboot the appliance host during the migration.

If there is any interruption during the appliance upgrade, the migration will resume when the appliance upgrade is resumed.

After the migration is complete, the following message appears on the dashboard for the respective filesystem: Migration completed. Please reconnect the filesystem.

You can now reconnect the filesystem. See Connecting a FileSystem.

After the filesystems are reconnected, the filesystems that had read / write permissions before the migration will return to the read / write state.

Uninstalling the Appliance

Log in to the host on which you want to uninstall Oracle Cloud Infrastructure Storage Software Appliance.
Stop the appliance:
oscsa down
Delete the oscsa_data file in docker:
sudo docker rm -v oscsa_data
Delete the image in docker:
sudo docker rmi $(docker images| grep oscsa_gw | awk '{print $3}')
Delete all the files preceding with oscsa in /usr/bin/:
sudo rm /usr/bin/oscsa*
View the contents of the file gateway_config:
cat /etc/gateway_config
The following custom host paths are listed in the gateway_config file, if the custom directories were created during the appliance installation:
- DATASTORAGE=/oscsa/data
- MDSTORAGE=/oscsa/md
- LOGSTORAGE=/oscsa/logs
1. Delete the directory data:
  sudo rm -rf /oscsa/data
2. Delete the directory md:
  sudo rm -rf /oscsa/md
3. Delete the directory logs:
  sudo rm -rf /oscsa/logs
If there are no custom host paths in the gateway_config file, then proceed to the next step.
Delete the file gateway_config:
sudo rm /etc/gateway_config
Delete the appliance installation directory oscsa_gateway:
sudo rm -rf /opt/oscsa_gateway