OSNEXUS QuantaStor Documentation

From OSNEXUS Online Documentation Site
Revision as of 10:11, 11 December 2018 by Qadmin (Talk | contribs)

Jump to: navigation, search
Osnexus logo black clear.png

Welcome to the OSNEXUS QuantaStor online documentation site. The following guides and sections cover all aspects of QuantaStor SDS configuration from installation to integration with 3rd party software. General information on key product features and product screenshots can be found on the main product site here: http://www.osnexus.com.


What is QuantaStor?

Free Trial Edition & Community Edition Download

The QuantaStor SDS v4 ISO image and license keys for Trial Edition (128TB) and Community Edition (20TB) are available for download here.

QuantaStor SDS uses a single ISO image for all editions. Features are license key controlled so a Community Edition appliance can be upgraded to Enterprise Edition with a license key upgrade.

Solution Design Guide and HCL

Before building a QuantaStor appliance, please review our solution design and hardware compatibility guides to ensure that you're hardware is properly matched to the use case and storage pool type(s) to be deployed.

Solution Design & Sizing Guide

  • Covers general QuantaStor SDS solution engineering and design guidelines

Hardware Compatibility List / Recommended Hardware

  • List of tested and recommended hardware

Installation, Administration, and Host Configuration

Installation Guide

  • The Installation Guide takes you step-by-step through the process of installing the QuantaStor Storage System OS on your server hardware from our ISO media. If you are using a QuantaStor virtual appliance, you can skip the installation guide and proceed to the Getting Started Guide for initial configuration instructions and the Administrators Guide for more advanced configuration.
    • Preparing USB/ISO Installation Media
      • Documentation on creating a bootable QuantaStor Installer on a USB thumb-drive for bare-metal install
    • Upgrade Guide
      • The Upgrade Guide outlines how to upgrade your QuantaStor system or virtual appliance to the latest version.

Getting Started Guide

  • The Getting Started Guide focuses on the initial configuration of your storage system after you have installed QuantaStor.

Administrators Guide

  • The Administrators Guide covers all aspects of managing QuantaStor appliances and storage system grids.

Advanced Administration Guides

Remote-replication / Disaster Recovery Administrators Guide
Clustered HA SAN/NAS with JBOD back-end
Clustered HA SAN/NAS with iSCSI/FC SAN back-end
Scale-out NAS Administrators Guide (GlusterFS-based)
Scale-out SAN Administrators Guide (Ceph-based)
Scale-out Object Administrators Guide (Ceph-based)

Web Admin Guide

  • The Web Admin Guide provides detail for the dialogues available in the WebUI.

Users Guide and Host-side Configuration

  • The User's Guide focuses on host side configuration steps, such as multipath configuration and iSCSI initiator configuration.

Advanced Topics

SNMP Agent Setup

  • Detailed instructions on how to setup the SNMP agent to send SNMP traps.

Command Line Interface (CLI) Users Guide

  • The CLI User's Guide documents in detail all of the storage management commands that can be executed via the 'qs' utility both within the system or remotely via with Windows 'qs' remote management CLI.

REST API Developers Guide

  • The Developers Guide outlines how one can manage the storage system directly using REST API calls from your own applications.

Customizing Appliance Internals

  • Details on how to write custom scripts to augment various operations like system started/shutdown, storage pool start/stop, etc.

IO Performance Tuning

  • Storage Pool I/O Tuning and I/O Performance best practices.

Troubleshooting Guide

  • Various troubleshooting topics ranging from login issues to driver upgrades.

Driver Upgrade Guide

  • Instructions on how to build new device drivers for newly released hardware

Custom Unmanaged NFS/CIFS Shares

  • Instructions on how to create custom entries for SMB/NFS access which are ignored by QuantaStor

Security Configuration

Custom SSL Certificates and TLS Security

  • Information on how to Generate and Install Custom SSL Certificates and set Custom TLS security settings.

Custom SSH Ciphers and Key Exchange Algorithms

  • Information on how to customize the ssh service to enforce strong Cipher and Key Exchange Algorithms for SSH communication.

Customizing Firewall Settings to Block Services

  • Guide outlines how to block NFS, CIFS, iSCSI and other protocol access in order to further lock down an appliance.

Enabling Duo Multi-Factor Authentication Documentation

  • Information on enabling multi-factor authentication using DUO.

Security Updates

  • How to apply security patches and get detail on what patches apply to QuantaStor


  • IPsec can be used to encrypt traffic for NFS and other protocols

Application Integration

CopperEgg Integration

  • Provides cloud monitoring and near real-time system stats

PagerDuty Integration

  • Use PagerDuty to get notified of call-home appliance alerts to your IT team with an advanced ticketing system.

Librato Metrics Integration

  • Use Librato to collect and view a dashboard metrics on utilization and other stats from your QuantaStor appliances.

Cloudera™ Hadoop Integration Guide

  • The Hadoop Integration Guide gives you an overview of the installation steps to get Hadoop running in your QuantaStor grid.

Nagios Integration

  • Monitoring and metrics platform integration, more information available here.

Avid Media Composer™ + MediaHarmony Configuration Guide

  • An overview of QuantaStor configuration steps for use with Avid.

R1Soft Backup Integration

  • Documentation on how to install the R1Soft Backup Agent

Gladinet Integration

  • Documentation on setting up Gladinet enterprise cloud file storage solution on QuantaStor. Solution is similar to Dropbox.

OpenStack Cinder

  • Documentation on setting up OpenStack Cinder to use the QuantaStor Cinder Driver.

Zabbix Integration

  • Monitoring via the Zabbix platform, more information available here.

HTTP File Access via Apache

  • Overview of how to access your files in your network shares directly via HTTP

Microsoft VSS Provider

  • Plug-in module for Microsoft Virtual Shadow Copy Services (VSS) support

SolarWinds MSP Integration

  • Installation of SolarWinds MSP client into QuantaStor SDS

Dropbox Integration

  • Dropbox based Cloud Containers enable NFS/SMB based access to Dropbox folders via any QuantaStor SDS appliance

Product Support

QuantaStor End User License Agreement (EULA)

The QuantaStor End User License Agreement (EULA) is available in the License Manager of every QuantaStor Appliance when you click the 'Add License' button. A Copy of the QuantaStor EULA is also available here.

QuantaStor Support Guidelines

The guidelines for the QuantaStor support levels and how to contact support are detailed in the Support Guidelines document at the below link. This document is also available on the Contact Support page on the OSNEXUS website.

QuantaStor Support Guidelines

QuantaStor Terms of Support and Maintenance Agreement

The QuantaStor Terms of Support and Maintenance Agreement (Support Agreement) is available on the OSNEXUS Website at the below link.

QuantaStor Terms of Support and Maintenance Agreement

Open Source / 3rd Party Software Licenses

QuantaStor SDS is Linux based and ISO media includes numerous open source packages. These three links provide detail into the open-source copyright notices for all 3rd Party software packages that are included with the QuantaStor SDS v4 ISO.

Open-Source Package Detail for packages included with QuantaStor

Open-Source Packages included with QuantaStor

Open-Source License Summary for included packages

Product Release Change Log and Security Updates

Change Log

  • Details of what features and fixes are included with each QuantaStor release

Security Updates

  • Details of what Linux security updates impact QuantaStor and how to update your appliance

Product Version End-of-life Notifications

  • Details on product version end-of-life dates and notifications


Internal Architecture

  • Covers aspects of the internal architecture of the storage system.

Terms & Definitions

  • Glossary of terms and concepts used in managing various aspects of a QuantaStor storage system.