Difference between revisions of "OSNEXUS QuantaStor Documentation"

From OSNEXUS Online Documentation Site
Jump to: navigation, search
m (Guides / Manuals)
 
(40 intermediate revisions by the same user not shown)
Line 1: Line 1:
{| style="width: 100%; background: #1f1f1f; color: #ffffff; margin: 0px;"
 
|style="align: right; padding-top: 10px; padding-right: 20px"| [[File:osnexus_logo_black_clear.png|200px|right|frameless]]
 
|}
 
 
__NOTOC__
 
__NOTOC__
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 [http://www.osnexus.com/quantastor-features features] and product [http://www.osnexus.com/qs-screens screenshots] can be found on the main product site here: [http://www.osnexus.com http://www.osnexus.com].
+
Welcome to the OSNEXUS QuantaStor online documentation site. The following guides and sections cover all aspects of QuantaStor configuration from installation to integration with 3rd party software. General information on key product [http://www.osnexus.com/quantastor-features features] and product [http://www.osnexus.com/qs-screens screenshots] can be found on the main osnexus.com site here: [http://www.osnexus.com http://www.osnexus.com]. Translations: [https://translate.google.com/translate?hl=en&sl=en&tl=ja&u=https%3A%2F%2Fwiki.osnexus.com&sandbox=1 Japanese], [https://translate.google.com/translate?hl=en&sl=en&tl=de&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site German], [https://translate.google.com/translate?hl=en&sl=en&tl=es&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Spanish], [https://translate.google.com/translate?hl=en&sl=en&tl=pt&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Portuguese], [https://translate.google.com/translate?hl=en&sl=en&tl=sv&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Swedish], [https://translate.google.com/translate?hl=en&sl=en&tl=ru&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Russian], [https://translate.google.com/translate?hl=en&sl=en&tl=fr&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site French], [https://translate.google.com/translate?hl=en&sl=en&tl=zh-CN&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Chinese], [https://translate.google.com/translate?hl=en&sl=en&tl=ko&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Korean], [https://translate.google.com/translate?hl=en&sl=en&tl=it&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Italian],
 
+
* Translations: [[https://translate.google.com/translate?hl=en&sl=en&tl=ja&u=https%3A%2F%2Fwiki.osnexus.com&sandbox=1 Japanese]] [[https://translate.google.com/translate?hl=en&sl=en&tl=de&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site German]] [[https://translate.google.com/translate?hl=en&sl=en&tl=es&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Spanish]] [[https://translate.google.com/translate?hl=en&sl=en&tl=pt&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Portuguese]] [[https://translate.google.com/translate?hl=en&sl=en&tl=sv&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Swedish]] [[https://translate.google.com/translate?hl=en&sl=en&tl=ru&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Russian]] [[https://translate.google.com/translate?hl=en&sl=en&tl=fr&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site French]] [[https://translate.google.com/translate?hl=en&sl=en&tl=zh-CN&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Chinese]] [[https://translate.google.com/translate?hl=en&sl=en&tl=ko&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Korean]] [[https://translate.google.com/translate?hl=en&sl=en&tl=it&u=https%3A%2F%2Fwiki.osnexus.com%2Findex.php%3Ftitle%3DOSNEXUS_Online_Documentation_Site Italian]]
+
  
 
== Overview ==
 
== Overview ==
 
==== [[What is QuantaStor?]] ====
 
==== [[What is QuantaStor?]] ====
  
==== Free Trial Edition & Community Edition Download ====
+
==== [https://www.osnexus.com/free-trial Trial & Community Edition Download] ====
  
The QuantaStor 5 ISO image and license keys for Trial Edition (256TB, 30-days) and Community Edition (40TB, 2 years) are available for '''[https://www.osnexus.com/downloads download here.]'''   
+
The QuantaStor 5 ISO image and license keys for Trial Edition (256TB, 30-days) and Community Edition (40TB) are available for '''[https://www.osnexus.com/downloads download here.]'''   
  
 
QuantaStor uses a single common ISO image for all editions so upgrading a system from Trial or Community Edition to Enterprise Edition just requires applying a new license key.
 
QuantaStor uses a single common ISO image for all editions so upgrading a system from Trial or Community Edition to Enterprise Edition just requires applying a new license key.
  
== Solution Design Guide and HCL ==
+
== Guides / Manuals ==
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 Guide|Solution Design & Sizing Guide]] ====
+
* Covers general QuantaStor SDS solution engineering and design guidelines
+
  
==== [[Recommended Hardware|Hardware Compatibility List / Recommended Hardware]] ====
+
==== [[+ Solution Design Overview|Solution Design Guide]] ====
* List of tested and recommended hardware
+
* Covers general QuantaStor solution engineering and design guidelines
  
== Installation, Administration, and Host Configuration ==
+
==== [[+ Installation Guide Overview|Installation Guide]] ====
=== [[QuantaStor Installation Guide|Installation Guide]] ===
+
* Covers the process of installing QuantaStor onto bare-metal hardware or as guest VM to make a Virtual Storage System.
* 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.
+
** [[QuantaStor Installation via USB Thumb Drive|Preparing USB/ISO Installation Media]]
+
*** Documentation on creating a bootable QuantaStor Installer on a USB thumb-drive for bare-metal install
+
** [[QuantaStor Upgrade Guide|Upgrade Guide]]
+
*** The Upgrade Guide outlines how to upgrade your QuantaStor system or virtual appliance to the latest version.
+
  
=== [[QuantaStor Getting Started Guide|Getting Started Guide]] ===
+
==== [[Overview_(Getting_Started)|Getting Started Overview]] ====
* The Getting Started Guide focuses on the initial configuration of your storage system after you have installed QuantaStor.
+
* Covers the initial system configuration steps including logging in, applying a license key, and other initial system step procedures.
  
=== [[QuantaStor Administrators Guide|Administrators Guide]] ===
+
==== [[+ Admin Guide Overview|Administrator Guide]] ====
* The [[QuantaStor Administrators Guide| Administrators Guide]] covers all aspects of managing QuantaStor appliances and storage system grids.
+
* Covers the details on each of the features and capabilities of QuantaStor and how to configure them.
  
==== Advanced Administration Guides ====
+
==== [[+ User Guide Overview|User Guide]] ====
: [[Remote-replication / Disaster Recovery Setup|Remote-replication / Disaster Recovery Administrators Guide]]
+
* Covers topics on how to connect to QuantaStor via various file and block protocols from servers and workstations.
: [[Clustered HA SAN/NAS with JBOD back-end|Clustered HA SAN/NAS with JBOD back-end ]]
+
: [[Clustered HA SAN/NAS with iSCSI/FC SAN back-end|Clustered HA SAN/NAS with iSCSI/FC SAN back-end ]]
+
: [[Scale-out NAS (Gluster based) Storage Setup|Scale-out NAS Administrators Guide (GlusterFS-based) ]]
+
: [[Scale-out SAN (Ceph based) Storage Setup|Scale-out SAN Administrators Guide (Ceph-based) ]]
+
: [[Scale-out Object (Ceph based) Storage Setup|Scale-out Object Administrators Guide (Ceph-based) ]]
+
  
=== [[QuantaStor Manager Web Admin Guide|Web Admin Guide]] ===
+
==== [[+ Integration Guide Overview|Integration Guide]] ====
* The Web Admin Guide provides detail for the dialogues available in the WebUI.
+
* Covers topics on how to integrate QuantaStor with other systems and applications.
=== [[QuantaStor Users Guide|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 ==
+
==== [[+ CLI Guide Overview|Command Line Interface (qs CLI) / Scripting Guide]] ====
 +
* Covers the QuantaStor CLI (qs) which enables one to automate configuration steps or configure the system without the use of the Web UI.
  
==== [[SNMP Agent Setup]] ====
+
==== [[+ Developer Guide Overview|Developer (REST API) Guide]] ====
* Detailed instructions on how to setup the SNMP agent to send SNMP traps.
+
* Covers how to use the QuantaStor REST API to integrate via various programming languages and utilities like 'curl'.
  
==== [[QuantaStor CLI Users Guide|Command Line Interface (CLI) Users Guide]] ====
+
==== [[+ Support Guide Overview|Support 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.
+
* Covers product support topics including EULA, version EOL notices, version change log, support agreements and more.
  
==== [[QuantaStor Developers Guide|REST API Developers Guide ]] ====
+
== Advanced Topics ==
* The Developers Guide outlines how one can manage the storage system directly using REST API calls from your own applications.
+
  
==== [[QuantaStor Custom Scripting / Application Extensions|Customizing Appliance Internals]] ====
+
==== [[QuantaStor Custom Scripting / Application Extensions|Customizing System Internals]] ====
 
* Details on how to write custom scripts to augment various operations like system started/shutdown, storage pool start/stop, etc.
 
* Details on how to write custom scripts to augment various operations like system started/shutdown, storage pool start/stop, etc.
 
==== [[IO Performance Tuning|IO Performance Tuning]] ====
 
* Storage Pool I/O Tuning and I/O Performance best practices.
 
  
 
==== [[QuantaStor Troubleshooting Guide|Troubleshooting Guide]] ====
 
==== [[QuantaStor Troubleshooting Guide|Troubleshooting Guide]] ====
 
* Various troubleshooting topics ranging from login issues to driver upgrades.
 
* Various troubleshooting topics ranging from login issues to driver upgrades.
 
==== [[QuantaStor Driver Upgrades|Driver Upgrade Guide]] ====
 
* Instructions on how to build new device drivers for newly released hardware
 
  
 
==== [[Custom Unmanaged NFS/CIFS Shares]] ====
 
==== [[Custom Unmanaged NFS/CIFS Shares]] ====
 
* Instructions on how to create custom entries for SMB/NFS access which are ignored by QuantaStor
 
* Instructions on how to create custom entries for SMB/NFS access which are ignored by QuantaStor
 
== Security Configuration ==
 
==== [[Custom SSL_TLS Security|Custom SSL Certificates and TLS Security]] ====
 
* Information on how to Generate and Install Custom SSL Certificates and set Custom TLS security settings.
 
==== [[Custom SSH Security|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.
 
==== [[Firewall Configuration|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.
 
==== [[Duo Multi-Factor Authentication|Enabling Duo Multi-Factor Authentication Documentation]] ====
 
* Information on enabling multi-factor authentication using DUO.
 
 
==== [[QuantaStor Security Updates|Security Updates]] ====
 
* How to apply security patches and get detail on what patches apply to QuantaStor
 
 
==== [[IPSec]] ====
 
* 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(tm) Hadoop Integration Guide|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 [https://www.nagios.com/ 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 [http://www.gladinet.com/ 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 [http://www.zabbix.com/ 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_EULA|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 [[QuantaStor EULA|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 [http://www.osnexus.com/contact-support/ Contact Support page] on the OSNEXUS website.
 
 
[http://downloads.osnexus.com/osn_support_guidelines_latest.pdf 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.
 
 
[http://downloads.osnexus.com/osn_support_agreement_latest.pdf 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.
 
 
[https://s3.amazonaws.com/qs-support-uploads/qs_packages.txt Open-Source Package Detail for packages included with QuantaStor]
 
 
[https://s3.amazonaws.com/qs-support-uploads/qs_packages_detail.txt Open-Source Packages included with QuantaStor]
 
 
[https://s3.amazonaws.com/qs-support-uploads/qs_packages_licenselist.txt Open-Source License Summary for included packages]
 
 
=== Product Release Change Log and Security Updates ===
 
 
==== [[QuantaStor Version ChangeLog|Change Log]] ====
 
* Details of what features and fixes are included with each QuantaStor release
 
 
==== [[QuantaStor Security Updates|Security Updates]] ====
 
* Details of what Linux security updates impact QuantaStor and how to update your appliance
 
 
==== [[QuantaStor Version EOL Notification|Product Version End-of-life Notifications]] ====
 
* Details on product version end-of-life dates and notifications
 
<!-- * [http://wiki.osnexus.com/mediawiki/index.php?title=Main_Page&action=pdfbook Generate PDF documentation from OSNEXUS Wiki] -->
 
 
 
[[Category: Landing Page]]
 
  
 
== Appendix ==
 
== Appendix ==
  
 
==== [[QuantaStor Internal Architecture|Internal Architecture]] ====
 
==== [[QuantaStor Internal Architecture|Internal Architecture]] ====
* Covers aspects of the internal architecture of the storage system.
+
* Covers aspects of the internal architecture of the QuantaStor storage system.
 +
 
 
==== [[Terms & Definitions]] ====
 
==== [[Terms & Definitions]] ====
 
* Glossary of terms and concepts used in managing various aspects of a QuantaStor storage system.
 
* Glossary of terms and concepts used in managing various aspects of a QuantaStor storage system.

Latest revision as of 12:03, 12 August 2019

Welcome to the OSNEXUS QuantaStor online documentation site. The following guides and sections cover all aspects of QuantaStor configuration from installation to integration with 3rd party software. General information on key product features and product screenshots can be found on the main osnexus.com site here: http://www.osnexus.com. Translations: Japanese, German, Spanish, Portuguese, Swedish, Russian, French, Chinese, Korean, Italian,

Overview

What is QuantaStor?

Trial & Community Edition Download

The QuantaStor 5 ISO image and license keys for Trial Edition (256TB, 30-days) and Community Edition (40TB) are available for download here.

QuantaStor uses a single common ISO image for all editions so upgrading a system from Trial or Community Edition to Enterprise Edition just requires applying a new license key.

Guides / Manuals

Solution Design Guide

  • Covers general QuantaStor solution engineering and design guidelines

Installation Guide

  • Covers the process of installing QuantaStor onto bare-metal hardware or as guest VM to make a Virtual Storage System.

Getting Started Overview

  • Covers the initial system configuration steps including logging in, applying a license key, and other initial system step procedures.

Administrator Guide

  • Covers the details on each of the features and capabilities of QuantaStor and how to configure them.

User Guide

  • Covers topics on how to connect to QuantaStor via various file and block protocols from servers and workstations.

Integration Guide

  • Covers topics on how to integrate QuantaStor with other systems and applications.

Command Line Interface (qs CLI) / Scripting Guide

  • Covers the QuantaStor CLI (qs) which enables one to automate configuration steps or configure the system without the use of the Web UI.

Developer (REST API) Guide

  • Covers how to use the QuantaStor REST API to integrate via various programming languages and utilities like 'curl'.

Support Guide

  • Covers product support topics including EULA, version EOL notices, version change log, support agreements and more.

Advanced Topics

Customizing System Internals

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

Troubleshooting Guide

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

Custom Unmanaged NFS/CIFS Shares

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

Appendix

Internal Architecture

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

Terms & Definitions

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