Difference between revisions of "OSNEXUS QuantaStor Documentation"

From OSNEXUS Online Documentation Site
Jump to: navigation, search
m (Product Support)
m (Guides / Manuals)
 
(30 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.
  
== QuantaStor Documentation Overview ==
+
== Guides / Manuals ==
  
 
==== [[+ Solution Design Overview|Solution Design Guide]] ====
 
==== [[+ Solution Design Overview|Solution Design Guide]] ====
* Covers general QuantaStor SDS solution engineering and design guidelines
+
* Covers general QuantaStor solution engineering and design guidelines
  
 
==== [[+ Installation Guide Overview|Installation Guide]] ====
 
==== [[+ Installation Guide Overview|Installation Guide]] ====
* Covers the process of installing QuantaStor onto bare-metal hardware or as guest VM to make a Virtual Storage Appliance.
+
* Covers the process of installing QuantaStor onto bare-metal hardware or as guest VM to make a Virtual Storage System.
  
==== [[+ Getting Started Overview|Getting Started]] ====
+
==== [[Overview_(Getting_Started)|Getting Started Overview]] ====
 
* Covers the initial system configuration steps including logging in, applying a license key, and other initial system step procedures.
 
* Covers the initial system configuration steps including logging in, applying a license key, and other initial system step procedures.
  
 
==== [[+ Admin Guide Overview|Administrator Guide]] ====
 
==== [[+ Admin Guide Overview|Administrator Guide]] ====
* This guide goes into detail on each of the features and capabilities of QuantaStor and how to configure them.
+
* Covers the details on each of the features and capabilities of QuantaStor and how to configure them.
  
 
==== [[+ User Guide Overview|User Guide]] ====
 
==== [[+ User Guide Overview|User Guide]] ====
 
* Covers topics on how to connect to QuantaStor via various file and block protocols from servers and workstations.
 
* Covers topics on how to connect to QuantaStor via various file and block protocols from servers and workstations.
 +
 +
==== [[+ Integration Guide Overview|Integration Guide]] ====
 +
* Covers topics on how to integrate QuantaStor with other systems and applications.
 +
 +
==== [[+ 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.
 +
 +
==== [[+ Developer Guide Overview|Developer (REST API) Guide]] ====
 +
* Covers how to use the QuantaStor REST API to integrate via various programming languages and utilities like 'curl'.
 +
 +
==== [[+ Support Guide Overview|Support Guide]] ====
 +
* Covers product support topics including EULA, version EOL notices, version change log, support agreements and more.
  
 
== Advanced Topics ==
 
== Advanced Topics ==
  
==== [[SNMP Agent Setup]] ====
+
==== [[QuantaStor Custom Scripting / Application Extensions|Customizing System Internals]] ====
* Detailed instructions on how to setup the SNMP agent to send SNMP traps.
+
 
+
==== [[QuantaStor Custom Scripting / Application Extensions|Customizing Appliance 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.
  
Line 46: Line 50:
 
==== [[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
 
== 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
 
  
 
== 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.