+ Getting Started Overview: Difference between revisions

From OSNEXUS Online Documentation Site
Jump to navigation Jump to search
mNo edit summary
m Drop the admin_guide category - Getting Started is its own top-level guide and should not be duplicated in the Administrator Guide side menu (QSTOR-12352)
 
(276 intermediate revisions by the same user not shown)
Line 1: Line 1:
This guide assumes that you have already installed QuantaStor and have successfully logged into QuantaStor Manager.  If you have not yet installed the QuantaStor SSP software on your server, please see the [[QuantaStor Installation Guide|Installation Guide]] for more details.  It is best to follow along with the Getting Started Guide as you configure the system using the [http://www.osnexus.com/qs-screens/single-gallery/5686717 Getting Started] checklist which will appear when you first login to the QuantaStor Manager web interface. The checklist can be access again at any time by pressing the 'System Checklist' button in the toolbar.
[[Category:start_guide]]
QuantaStor ships with a built-in setup launcher, the '''Getting Started / Configuration Guide''', that presents twelve configuration workflows and, within each one, the ordered steps that build a working configuration. This page explains what each workflow achieves and in what order, and links every step to the Administrator Guide page that documents the dialog behind it. It does not repeat those procedures.


The default administrator user name for your storage system is simply 'admin' and this user name will automatically appear in the username field of the login screen.  The password for the 'admin' account is initially just 'password' without the quotes.  You will want to change this after you first login and it is one of the steps in the checklist.
{| class="wikitable"
! Section !! Covers
|-
| [[#First-time login|First-time login]] || The default account and password, and what to change first
|-
| [[#Opening the guide|Opening the guide]] || The three ways to reach the dialog, and when it opens on its own
|-
| [[#How the guide works|How the guide works]] || The layout, the Previous/Next buttons, what it does and does not track
|-
| [[#Which workflows appear|Which workflows appear]] || Why a workflow you expect may not be listed
|-
| [[#Initial Setup|Initial Setup]] || System Setup, Storage Grid Setup, Security Setup
|-
| [[#Pool Setup|Pool Setup]] || Scale-up pools, and scale-out object, file and block pools
|-
| [[#Provisioning Setup|Provisioning Setup]] || Provisioning file, block and object storage from a pool
|-
| [[#Misc Setup|Misc Setup]] || Remote-replication and cloud integration
|}


== License Key Management ==
== First-time login ==


Once you have the software installed, the first thing you must do is enter your license key block. Your license key block can be added using the License Manager dialog which can be accessed by pressing the License Manager button in the toolbar.  It's also presented as the first step in the 'Getting Started' checklist. The key block you received via email is contained within markers like so:
Browse to <code>https://&lt;system-ip-or-name&gt;/</code>. The built-in management account is '''admin''' and it is pre-filled in the '''Username''' field; on a newly installed system its password is '''password'''.


<pre>
'''Change it immediately.''' Step 3 of the '''System Setup''' workflow opens the '''Set Password''' dialog for exactly this reason. The '''Old Password''' field is disabled while the session is logged in as <code>admin</code>, so only the new password and its confirmation are required; for every other account the current password must be supplied as well. The new password has to satisfy the grid password policy, which also sets the permitted length range -- see [[Security Configuration#Change Management Administrator Account 'admin' Password|Security Configuration]].
--------START KEY BLOCK--------


---------END KEY BLOCK---------
The console account is separate. '''qadmin''' is the SSH and console login, it defaults to a password of <code>qadmin</code>, and it is local to each system rather than grid-wide, so it has to be changed on every appliance. See [[Security Configuration#Change SSH Console Administrator Account 'qadmin' Password|Security Configuration]].
</pre>


Note that when you add the key using the 'Add License' dialog you can include or not include the START/END KEY BLOCK markers, it makes no difference.  Once your key block has been entered you'll want to activate your key which can be done in just a few seconds using the online Activation dialog.  If your storage system is not connected to the internet select the 'Activate via Email' dialog and send the information contained within to support@osnexus.com.  You have a 7 day grace period for license activation so you can begin configuring and utilizing the system even though the system is not yet activated.  That said, if you do not activate within the 7 days the storage system will no longer allow any additional configuration changes until an activation key is supplied.
For the login panel itself and the rest of the interface, see [[Using the Web Interface]].


== Creating Storage Pools ==
== Opening the guide ==


Storage pools combine or aggregate one or more physical disks (SATA, SAS, or SSD) into a single pool of storage from which storage volumes (iSCSI targets) can be created. Storage pools can be created using any of the following RAID types including RAID0, RAID1, RAID5, RAID6, or RAID10. Choosing the optimal RAID type depends on your the I/O access patters of your target application, number of disks you have, and the amount of fault-tolerance you require.  (Note: Fault tolerance is just a way of saying how many disks can fail within a storage pool or (aka RAID group before you lose data.)  RAID1 & RAID5 allow you have one disk fail without it interrupting disk IO.  When a disk fails you can remove it and you should add a spare disk with the 'degraded' storage pool as soon as possible to in order to restore it to a fault-tolerant status.  RAID6 allows for up to two disk failures and will keep running, while RAID10 can allow for one disk failure per mirror pair.  Finally, RAID0 is not fault tolerant at all but it is your only choice if you have only one disk and it can be useful in some scenarios where fault-tolerance is not required.  Here's a breakdown of the various RAID types and their pros & cons.
[[File:Webui getting started.png|thumb|right|800px|The Getting Started / Configuration Guide. The left column lists the twelve workflows in four groups; the right pane holds the selected workflow's description and its ordered steps.]]


* '''RAID0''' layout is also called 'striping' and it writes data across all the disk drives in the storage pool in a round robin fashion.  This has the effect of greatly boosting performance.  The drawback of RAID0 is that it is not fault tolerant, meaning that if a single disk in the storage pool fails then all of your data in the storage pool is lost.  As such RAID0 is not recommended except in special cases where the potential for data loss is non-issue.
There are three ways to open it, and all three open the same dialog:
* '''RAID1''' is also called 'mirroring' because it achieves fault tolerance by writing the same data to two disk drives so that you always have two copies of the data.  If one drive fails, the other has a complete copy and the storage pool continues to run.  RAID1 and it's variant RAID10 are ideal for databases and other applications which do a lot of small write I/O operations.
* '''RAID5''' achieves fault tolerance via what's called a parity calculation where one of the drives contains an XOR calculation of the bits on the other drives.  For example, if you have 4 disk drives and you create a RAID5 storage pool, 3 of the disks will store data, and the last disk will contain parity information.  This parity information on the 4th drive can be used to recover from any data disk failure.  In the event that the parity drive fails, it can be replaced and reconstructed using the data disks.  RAID5 (and RAID6) are especially well suited for audio/video streaming, archival, and other applications which do a heavy sequential write I/O operations (such as reading/writing large files) and are not as well suited for database applications which do heavy amounts of small random write I/O operations or with large file-systems containing lots of small files with a heavy write load.
* '''RAID6''' improves upon RAID5 in that it can handle two drive failures but it requires that you have two disk drives dedicated to parity information.  For example, if you have a RAID6 storage pool comprised of 5 disks then 3 disks will contain data, and 2 disks will contain parity information.  In this example, if the disks are all 1TB disks then you will have 3TB of usable disk space for the creation of volumes.  So there's some sacrifice of usable storage space to gain the additional fault tolerance.  If you have the disks, we always recommend using RAID6 over RAID5.  This is because all hard drives eventually fail and when one fails in a RAID5 storage pool your data is left vulnerable until a spare disk is utilized to recover your storage pool back to a fault tolerant status.  With RAID6 your storage pool is still fault tolerant after the first drive failure. (Note: Fault-tolerant storage pools (RAID1,5,6,10) that have suffered a single disk drive failure are called '''degraded''' because they're still operational but they require a spare disk to recover back to a fully fault-tolerant status.)
* '''RAID10''' is similar to RAID1 in that it utilizes mirroring, but RAID10 also does striping over the mirrors.  This gives you the fault tolerance of RAID1 combined with the performance of RAID10.  The drawback is that half the disks are used for fault-tolerance so if you have 8 1TB disks utilized to make a RAID10 storage pool, you will have 4TB of usable space for creation of volumes.  RAID10 will perform very well with both small random IO operations as well as sequential operations and it is highly fault tolerant as multiple disks can fail as long as they're not from the same mirror-pairing.  If you have the disks and you have a mission critical application we '''highly''' recommend that you choose the RAID10 layout for your storage pool.


In many cases it is useful to create more than one storage pool so that you have both basic low cost fault-tolerant storage available from perhaps a RAID5 storage pool, as well as a highly fault-tolerant RAID10 or RAID6 storage pool available for mission critical applications.
{{Navigation|Storage Management &rarr; Storage Systems &rarr; Storage System ''(toolbar group)'' &rarr; Getting Started}}


Once you have created a storage pool it will take some time to 'rebuild'.  Once the 'rebuild' process has reached 1% you will see the storage pool appear in QuantaStor Manager and you can begin to create new storage volumes.
{{Navigation|Storage Management &rarr; Storage Systems &rarr; Storage System ''(select + right-click)'' &rarr; Getting Started / Configuration Guide...}}
    WARNING:  Although you can begin using the pool at 1% rebuild completion,
    your storage pool is not fault-tolerant until the rebuild process has completed.


=== Disk Drive Selection ===
The third is the '''checklist''' button at the right-hand end of the banner, which is on every main tab. The banner and toolbar buttons always open on '''System Setup'''; the right-click item opens on the workflow that matches the object you right-clicked, so right-clicking a Storage Pool or a Storage Volume opens '''Provision Block Storage''', a Network Share opens '''Provision File Storage''', and a scale-out cluster object opens '''Setup Scale-out Object Pool'''.


Storage pools are created using entire disk drives. That is, no two storage pools can can share a physical disk between them.  Also, storage pools that use striping such as RAID5, RAID6, and RAID0 must use disks of equal size or the lowest common denominator of disk sizes will be utilized. For example, if you have 4 disks of different sizes, 1 x 500GB, 2 x 640GB, and 1 x 1TB and you create a RAID5 storage pool out of them then the storage pool will effectively comprised of 4 x 500GB disks because the extra space in the 640GB and 1TB drives will not be utilized.  With RAID5 one of those disks would contain the parity data leaving you with 1.5TB of usable space in the pool.
'''The dialog also opens by itself at login while no license key has been applied''' anywhere in the grid. That is its only automatic trigger: once a key exists it stops appearing on its own and stays available from the three controls above. Licensing is therefore the first thing it puts in front of a new appliance -- see [[License Management]].


In short, plan ahead and purchase harddrives of the same size from the same manufacturer.  You can use SAS, SATA and/or SSD drives in your QuantaStor storage system, but it is not a good idea to mix them within a single storage pool as they all have different IO characteristics.
The '''?''' button in the dialog header opens this page on the OSNEXUS wiki.


=== Data Compression ===
== How the guide works ==


Storage pools support data compression and this not only saves you disk space it improves performance. It may seem surprising that read and write performance would improve with compression but the fact is that today's processors can compress/decompress data in much much less time than it takes for a hard disk head to seek to the correct location on the disk. What this means is that when it does get to the right location to read a given block of data, it will need to read fewer blocks to get a large amount of data thereby making much less work for the hard drive to serve up data for a given request.  This is especially effective with read operations but also improves write performance.  To use data compression with your storage pool, just leave the box checked when you bring up the 'Create Storage Pool' dialog as it is the default to have it enabled.
The left column, headed '''Configuration Workflows''', lists the workflows as toggle buttons in four groups: '''Initial Setup''', '''Pool Setup''', '''Provisioning Setup''' and '''Misc Setup'''. Selecting one fills the right pane with that workflow's description and its numbered steps. Each step is a button that opens the dialog which performs it, with a paragraph beside it explaining why the step exists.


=== SSD Optimizations ===
Three behaviours are worth knowing before you use it:


SSD drives to not have rotational latency issues that you find with traditional hard disk drives. As such the intelligent queuing operations that happen at various IO layers to improve read/write performance based on the location of the head and proximity of data blocks does no good.  In fact they hurt performance as in many cases the disk drivers will wait for additional requests or blocks to arrive in an attempt to queue and optimize the IO operations. The SSD drives also use a technology called [http://en.wikipedia.org/wiki/TRIM TRIM] to free up blocks that are no longer used.  Without TRIM SSD drives have their write performance progressively degrade as the layout of the blocks become progressively more and more fragemented. Because SSD drives and hard drives in general are oblivious to the file-system type and layout of the data stored within them, they do not know when a given block has been deleted and can be freed up for reuse hence the need for something at the Operating System level to communicate this information. This is called "garbage collection" and modern operating systems & file systems like the one used with QuantaStor use the TRIM technology to communicate to SSD devices information about which blocks can be garbage collected thereby improving the performance of the device and your iSCSI storage volumes residing within.
* '''Selecting a workflow navigates the interface behind the dialog.''' Picking '''Setup Scale-up Storage Pool''' moves the main window to the Storage Pools section, '''Provision File Storage''' moves it to Network Shares, and so on, so the objects you are about to create are already in view when you close the guide. Selecting '''System Setup''' additionally brings up the '''Licenses''' tab.
* '''A step's dialog opens on top, and the guide stays open behind it.''' Complete the dialog, and you are back on the same workflow card ready for the next step. There is no need to reopen the guide between steps.
* '''Previous''' and '''Next''' walk the whole workflow list in order rather than only within a group, so '''Next''' from '''Security Setup''' lands on '''Setup Scale-up Storage Pool'''. '''Previous''' is disabled on the first workflow and '''Next''' on the last. '''OK''' and '''Cancel''' both close the guide.


== Creating Storage Volumes ==
'''The guide does not track completion.''' Nothing is ticked off, no step is greyed out once it has been done, and the step numbering is the recommended order rather than a record of where you are. The cards do refresh when a license, target port, Storage Pool, Host, Storage Volume or volume assignment changes, but that is a redraw, not progress. Treat the numbering as a checklist you keep yourself.


After you have created one or more storage pools you can begin creating storage volumes in them.  Storage volumes are the iSCSI disks that you present to your hosts.  Sometimes they're called LUNs or virtual disks, but storage volume is the generally accepted term used by the broader storage industry. 
== Which workflows appear ==
Storage volume creation is very straight forward, just click the 'Create Storage Volume' button in the tool bar and when the dialog appears give your new volume a name, select the size of the volume you want to create using the slider bar, and press OK. 
There are some custom options such as thin-provisioning, and CHAP authentication that you can configure when creating a volume, for now just use the defaults but we do recommend reading more about these features in the Administrator's Guide.


== Adding Hosts ==
The list is not fixed. Two things remove entries from it:


The host object represents a server, desktop, virtual machine or any other entity that you want to present storage to.  QuantStor makes sure that each host is only allowed to see the storage volumes that you have assigned to them by filtering what the host sees when it does an iSCSI login to the storage system. The industry term for this is called "LUN Masking" but in QuantaStor we refer to it more simply as just storage assignment.  To add a host to the system just click the 'Add Host' button and you will be presented with a dialog where you can enter a name for your host, and an IP address and/or IQN. We highly recommend that you always identify your hosts by IQN as it is easier to manage your hosts that way. Once you've entered a host name and it's IQN press OK to have the host created.  Now you're ready to assign the volume you created in the previous step to your host.
* '''The license edition.''' The '''Express''' edition hides cluster management and scale-out object management, which removes the three scale-out pool workflows and '''Provision Object Storage''', and reduces '''Setup Scale-up Storage Pool''' to a single '''Create Storage Pool''' step. The '''Object''' edition hides remote-replication together with the volumes, shares and hosts sections, which leaves '''System Setup''', '''Storage Grid Setup''', '''Security Setup''', '''Setup Scale-out Object Pool''', '''Provision Object Storage''' and '''Setup Cloud Integration'''.
* '''Per-account interface visibility.''' A management user can have main tabs and tree sections hidden on the '''Web Interface Customization''' settings of their account, and the guide honours those settings too -- a user who cannot see the Storage Volumes section does not get the '''Provision Block Storage''' workflow. See [[Security Configuration#Web Interface Customization|Security Configuration]].


== Assigning Storage Volumes to Hosts ==
So a workflow that is missing is a licensing or account-visibility result, not a fault. The tables below describe the full set.


There are two ways you can approach assigning storage to a host. If you select the host in the tree and choose 'Assign Storage' from the pop-up menu you'll be presented with a list of all the volumes. From this list simply select those volumes that you want assigned to the selected host. The second way is by selecting the volume in the Storage Volume tree on the left, and then choose 'Assign Storage' from the pop-up menu. This allows you to assign storage from the volume perspective and here you can select multiple hosts that should all have access to the selected storage volume.
== Initial Setup ==
<pre>
 
Note: A given volume can be assigned to more than one host at the same time, but keep in mind that you need to have software or a file-system than can handle the concurrent access such as a cluster file system or similar cluster aware application if you're going to use the device from two or more hosts simultaneously.
Everything a new appliance or a new grid needs before storage is provisioned on it.
</pre>
 
Once you've made your host selections and volume selections press OK and you will see the volume appear in the Host tree in the left-hand side of the screen under the host(s) which now have access to the volume.
=== System Setup ===
 
''Setting up a new Storage System should always start with adding a license key in order to unlock all the core management features.'' Licensing is first because the rest of the management operations are gated on it; the password change is next because the appliance is reachable on the network with a known default until it is done.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Add License''' || [[License Management#Adding a license key|License Management]] -- also covers distributing a key file across a whole grid in one operation
|-
| 2 || '''Activate License''' || [[License Management#Activating a license key|License Management]] -- online activation, and the offline path for systems with no Internet access
|-
| 3 || '''Set Password''' || [[Security Configuration#Change Management Administrator Account 'admin' Password|Security Configuration]]
|-
| 4 ''(optional)'' || '''Certificate Template Manager''' || [[Security Configuration#Certificate Templates|Security Configuration]]
|}
 
The workflow description also asks you to give every network port a static address. That is not one of its steps; do it from [[Network Ports]], which explains why a fresh appliance must be moved off DHCP before anything else is configured.
 
=== Storage Grid Setup ===
 
''Storage Grid technology makes it easy to manage large numbers of Storage Systems as one distributed system.'' A grid has to exist before remote-replication, site clusters or scale-out clusters can be built, which is why this comes before either pool group.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Storage Grid''' || [[Grid Configuration#Creating a Grid|Grid Configuration]]
|-
| 2 || '''Add System to Grid''' || [[Grid Configuration#Adding a System|Grid Configuration]] -- including what merges when a system joins
|-
| 3 || '''Update DNS &amp; NTP''' || Opens '''Modify Grid Network Settings''', which applies one DNS search suffix, DNS server list and NTP server list to every system you tick. The per-system equivalents are the [[Storage System#DNS Servers|DNS Servers]] and [[Storage System#NTP Servers|NTP Servers]] tabs of Storage System Modify.
|-
| 4 || '''Update Time Zone''' || Opens '''Modify Grid Time Zone Settings''', which sets the time zone on every system you tick.
|-
| 5 || '''Configure Alerting''' || [[Call-home / Alerting]] -- email, SNMP and the ITSM integrations
|}
 
Both grid-wide dialogs overwrite the selected systems' current settings with what you enter, so tick only the systems you intend to change. Working DNS and accurate time are prerequisites rather than conveniences: Active Directory, LDAP, certificate validation and license activation all depend on them, and a scale-out cluster reports clock skew as a health warning.
 
=== Security Setup ===
 
''Security settings are applied storage grid wide including to any new systems added to the storage grid in the future.'' That is the reason this workflow sits in Initial Setup rather than being deferred -- a policy set now also governs systems that join later.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Configure Security Policy''' || [[Security Configuration#Security Settings Management|Security Configuration]] -- password policy, lockout and session settings
|-
| 2 || '''Join AD Domain...''' || [[Active Directory Configuration]], and [[Network Shares#SMB/CIFS access|Network Shares]] for the SMB side
|-
| 3 || '''Configure System Firewall''' || [[Security Configuration#Firewall Configuration|Security Configuration]]
|}
 
Step 3 opens the Storage System Modify dialog already advanced to its '''Firewall''' tab rather than a dialog of its own.
 
== Pool Setup ==
 
Four workflows, one per pool architecture. Pick the one that matches the storage you intend to serve; they are alternatives, not a sequence. Scale-up pools are ZFS on media attached to one or two systems; the three scale-out workflows all build on a Ceph cluster of three or more systems.
 
=== Setup Scale-up Storage Pool ===
 
[[File:getstart_scaleup_pool.png|thumb|right|800px|The Setup Scale-up Storage Pool workflow. The clustered HA sequence builds the heartbeat layer first, then the pool, then the failover group and its virtual interface.]]
 
''Scale-up Storage Pools may be setup in single-node mode or clustered HA mode.'' The card shows the clustered sequence, which has a strict order: the site cluster and its heartbeat rings have to exist before an HA group can be attached to a pool, and the HA group has to exist before a virtual interface can move with it.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Site Cluster''' || [[Site Cluster Setup#Creating a site cluster|Site Cluster Setup]]
|-
| 2 || '''Add Cluster Ring''' || [[Site Cluster Setup#Heartbeat rings|Site Cluster Setup]] -- two rings per site cluster is the recommendation
|-
| 3 || '''Create Storage Pool''' || [[Storage Pools#Creating a Storage Pool|Storage Pools]]
|-
| 4 || '''Create HA Group''' || [[HA Cluster Setup (JBODs)#Creating the Storage Pool HA Group|HA Cluster Setup (JBODs)]]
|-
| 5 || '''Add Pool HA VIF''' || [[Cluster VIFs#Storage Pool (Scale-up HA)|Cluster VIFs]], with the failover mechanics in [[High-availability VIF Management]]
|}
 
For a single-node pool only step 3 applies. Under the Express edition, or where cluster management is hidden for the account, the card collapses to that one step.
 
HA pools have a hardware precondition the guide states in its description: the media must support I/O fencing, which means dual-ported SAS, dual-ported NVMe, Fibre Channel or iSCSI devices. [[HA Cluster Setup (JBODs)]] covers the cabling; [[HA Cluster Setup (external SAN)]] covers the same configuration on SAN-provided media.
 
=== Setup Scale-out Object Pool ===
 
''A scale-out storage cluster using three (3) or more Storage Systems must be setup first.'' The order builds the cluster, gives it capacity, then layers object storage on top.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Cluster''' || [[Scale-out Object Setup (ceph)#Create the Ceph Cluster|Scale-out Object Setup (ceph)]]
|-
| 2 || '''Create OSDs &amp; Journals''' || [[Scale-out Object Setup (ceph)#Create the OSDs and Journal Devices|Scale-out Object Setup (ceph)]], with the dialog itself covered in detail in [[Scale-out Block Setup (ceph)#Creating OSDs and journal groups|Scale-out Block Setup (ceph)]]
|-
| 3 || '''Create Object Pool Group''' || [[Scale-out Object Setup (ceph)#Creating an Object Storage Zone (Object Storage Pool Group)|Scale-out Object Setup (ceph)]]
|-
| 4 || '''Add Object Gateway''' || [[Scale-out Object Setup (ceph)#Object Gateway (RGW / S3-compatible)|Scale-out Object Setup (ceph)]]
|-
| 5 || '''Create Object User''' || [[Scale-out Object Setup (ceph)#Creating Object Storage Group Users|Scale-out Object Setup (ceph)]]
|-
| 6 || '''Create Object Bucket''' || [[Scale-out Object Setup (ceph)#Object Buckets|Scale-out Object Setup (ceph)]]
|}
 
Steps 5 and 6 are the same two steps as the '''Provision Object Storage''' workflow, repeated here so that this one workflow takes a set of bare systems all the way to a writable bucket.
 
=== Setup Scale-out File Pool ===
 
''Scale-out file Storage Pools are POSIX-compliant and deliver high performance NFS, SMB, and native CephFS client access.'' The metadata servers come before the pool because a CephFS file system cannot be created without them.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Cluster''' || [[Scale-out Block Setup (ceph)#Creating the Ceph cluster|Scale-out Block Setup (ceph)]]
|-
| 2 || '''Create OSDs &amp; Journals''' || [[Scale-out Block Setup (ceph)#Creating OSDs and journal groups|Scale-out Block Setup (ceph)]]
|-
| 3 || '''Add MDS''' || [[Scale-out File Setup (ceph)#Deploying metadata servers|Scale-out File Setup (ceph)]]
|-
| 4 || '''Create File Storage Pool''' || [[Scale-out File Setup (ceph)#Creating the file Storage Pool|Scale-out File Setup (ceph)]]
|-
| 5 || '''Create Share''' || [[Scale-out File Setup (ceph)#Creating a Network Share on a scale-out pool|Scale-out File Setup (ceph)]]
|}
 
=== Setup Scale-out Block Pool ===
 
''Scale-out block Storage Pools provide highly-available block storage via the iSCSI, Fibre-Channel, and NVMeoF protocols as well as via the native Ceph RBD protocol.''
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Cluster''' || [[Scale-out Block Setup (ceph)#Creating the Ceph cluster|Scale-out Block Setup (ceph)]]
|-
| 2 || '''Create OSDs &amp; Journals''' || [[Scale-out Block Setup (ceph)#Creating OSDs and journal groups|Scale-out Block Setup (ceph)]]
|-
| 3 || '''Create Pool''' || [[Scale-out Block Setup (ceph)#Creating the block Storage Pool|Scale-out Block Setup (ceph)]]
|-
| 4 || '''Create Storage Volume''' || [[Scale-out Block Setup (ceph)#Provisioning Storage Volumes|Scale-out Block Setup (ceph)]]
|}
 
A volume created here still has to be assigned to a Host before any initiator can reach it, which is what the '''Provision Block Storage''' workflow does.
 
== Provisioning Setup ==
 
Three workflows that turn an existing pool into storage a client can mount. Each of them assumes a pool from the '''Pool Setup''' group already exists.
 
=== Provision File Storage ===
 
''A Storage Pool (scale-up or scale-out) must be created before Network Shares may be provisioned.''
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Share''' || [[Network Shares#Creating a Network Share|Network Shares]]
|-
| 2 || '''Add NFS Access''' || [[Network Shares#Adding a client rule|Network Shares]]
|-
| 3 || '''Modify Network Share''' || [[Network Shares#Modifying a Network Share|Network Shares]] -- user access, record size and compression
|}
 
A new share is created with a default <code>[public]</code> NFS client entry that permits every address, so step 2 is where NFS access is narrowed to the subnets that should have it. SMB access is governed separately, by users and groups rather than by client rules.
 
=== Provision Block Storage ===
 
''Storage Volume(s) must be assigned to one or more Hosts before they may be accessed.'' That is the whole reason this workflow has three steps rather than one: QuantaStor has no open-access mode, so a volume nobody is assigned to is reachable by nobody.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Storage Volume''' || [[Storage Volumes#Creating a Storage Volume|Storage Volumes]]
|-
| 2 || '''Add Host''' || Creates the Host entry that represents a server, VM or cluster node, identified by its iSCSI IQN, NVMe NQN or Fibre Channel WWPNs
|-
| 3 || '''Assign Volumes''' || [[Storage Volumes#Assigning volumes to hosts|Storage Volumes]]
|}
 
Where several hosts form a cluster, put them in a Host Group and assign to the group instead -- hosts added later then pick up every volume already assigned to it. See [[Storage Volumes#Host Groups|Storage Volumes]].
 
=== Provision Object Storage ===
 
''Use the 'Setup Scale-out Object Pool' workflow to first setup an object storage cluster before provisioning Object Users and Buckets.'' This workflow is the short form for a cluster that already exists.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Object User''' || [[Scale-out Object Setup (ceph)#Creating Object Storage Group Users|Scale-out Object Setup (ceph)]] -- each user carries an access key and a secret key
|-
| 2 || '''Create Object Bucket''' || [[Scale-out Object Setup (ceph)#Object Buckets|Scale-out Object Setup (ceph)]]
|}
 
== Misc Setup ==
 
=== Setup Remote-Replication ===
 
''Replication is automated via a Replication Schedules so that it can be used as part of a business continuity and DR site fail-over plan.'' The link comes first because it establishes the security relationship a schedule needs; a schedule cannot be created between two systems that have no link.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Create Replication Link''' || [[Remote-replication (DR)#Creating a link|Remote-replication (DR)]] -- links are bidirectional
|-
| 2 || '''Create Schedule''' || [[Remote-replication (DR)#Replication schedules|Remote-replication (DR)]]
|-
| 3 || '''Trigger Replication Schedule''' || [[Remote-replication (DR)#Running a schedule now|Remote-replication (DR)]]
|}
 
Both endpoints must be members of the same Storage Grid, so [[#Storage Grid Setup|Storage Grid Setup]] is a prerequisite for this workflow.
 
=== Setup Cloud Integration ===
 
''Storage Systems can be connected to one or more major public cloud providers to provide local NAS gateway access to object storage and a means of automated backup and tiering via Backup Policies.'' Only the first step is required; the rest are marked optional because which of them you need depends on whether the cloud bucket already exists.
 
{| class="wikitable"
! Step !! Opens !! Documented in
|-
| 1 || '''Add Cloud Provider Credential''' || [[Cloud Containers / NAS Gateway#Adding credentials|Cloud Containers / NAS Gateway]]
|-
| 2 ''(optional)'' || '''Add/Import Cloud Storage Container''' || [[Cloud Containers / NAS Gateway#Add/Import Cloud Storage Container|Cloud Containers / NAS Gateway]] -- for a bucket that already exists
|-
| 3 ''(optional)'' || '''Create Cloud Storage Container''' || [[Cloud Containers / NAS Gateway#Create Cloud Storage Container|Cloud Containers / NAS Gateway]] -- creates the bucket as well as the container
|-
| 4 ''(optional)'' || '''Create Backup Policy''' || [[Backup Policies#Creating a Backup Policy|Backup Policies]]
|}
 
A Cloud Storage Container appears as a Network Share on the appliance, so file clients reach cloud object storage over NFS and SMB without changing anything client-side.
 
== Related pages ==
 
* [[Using the Web Interface]] -- logging in, the screen regions and the nine main tabs
* [[+ Admin Guide Overview]] -- the whole Administrator Guide, grouped by topic
* [[License Management]] -- adding, activating and renewing the key every system needs
* [[Grid Configuration]] -- joining systems into one grid managed from any member
* [[Security Configuration]] -- passwords, policy, roles, certificates and the firewall
* [[Storage Pools]] -- creating the scale-up pool that block and file provisioning draw from
* [[Network Shares]] -- NAS access over NFS and SMB
* [[Storage Volumes]] -- block devices over iSCSI, Fibre Channel and NVMe-oF
* [[QuantaStor Installation Guide]] -- installing QuantaStor before any of the above
 
----
<small>''Verified against QuantaStor 6.9.0.''</small>

Latest revision as of 04:29, 4 September 2026

QuantaStor ships with a built-in setup launcher, the Getting Started / Configuration Guide, that presents twelve configuration workflows and, within each one, the ordered steps that build a working configuration. This page explains what each workflow achieves and in what order, and links every step to the Administrator Guide page that documents the dialog behind it. It does not repeat those procedures.

Section Covers
First-time login The default account and password, and what to change first
Opening the guide The three ways to reach the dialog, and when it opens on its own
How the guide works The layout, the Previous/Next buttons, what it does and does not track
Which workflows appear Why a workflow you expect may not be listed
Initial Setup System Setup, Storage Grid Setup, Security Setup
Pool Setup Scale-up pools, and scale-out object, file and block pools
Provisioning Setup Provisioning file, block and object storage from a pool
Misc Setup Remote-replication and cloud integration

First-time login

Browse to https://<system-ip-or-name>/. The built-in management account is admin and it is pre-filled in the Username field; on a newly installed system its password is password.

Change it immediately. Step 3 of the System Setup workflow opens the Set Password dialog for exactly this reason. The Old Password field is disabled while the session is logged in as admin, so only the new password and its confirmation are required; for every other account the current password must be supplied as well. The new password has to satisfy the grid password policy, which also sets the permitted length range -- see Security Configuration.

The console account is separate. qadmin is the SSH and console login, it defaults to a password of qadmin, and it is local to each system rather than grid-wide, so it has to be changed on every appliance. See Security Configuration.

For the login panel itself and the rest of the interface, see Using the Web Interface.

Opening the guide

The Getting Started / Configuration Guide. The left column lists the twelve workflows in four groups; the right pane holds the selected workflow's description and its ordered steps.

There are three ways to open it, and all three open the same dialog:

Navigation: Storage Management → Storage Systems → Storage System (toolbar group) → Getting Started
Navigation: Storage Management → Storage Systems → Storage System (select + right-click) → Getting Started / Configuration Guide...

The third is the checklist button at the right-hand end of the banner, which is on every main tab. The banner and toolbar buttons always open on System Setup; the right-click item opens on the workflow that matches the object you right-clicked, so right-clicking a Storage Pool or a Storage Volume opens Provision Block Storage, a Network Share opens Provision File Storage, and a scale-out cluster object opens Setup Scale-out Object Pool.

The dialog also opens by itself at login while no license key has been applied anywhere in the grid. That is its only automatic trigger: once a key exists it stops appearing on its own and stays available from the three controls above. Licensing is therefore the first thing it puts in front of a new appliance -- see License Management.

The ? button in the dialog header opens this page on the OSNEXUS wiki.

How the guide works

The left column, headed Configuration Workflows, lists the workflows as toggle buttons in four groups: Initial Setup, Pool Setup, Provisioning Setup and Misc Setup. Selecting one fills the right pane with that workflow's description and its numbered steps. Each step is a button that opens the dialog which performs it, with a paragraph beside it explaining why the step exists.

Three behaviours are worth knowing before you use it:

  • Selecting a workflow navigates the interface behind the dialog. Picking Setup Scale-up Storage Pool moves the main window to the Storage Pools section, Provision File Storage moves it to Network Shares, and so on, so the objects you are about to create are already in view when you close the guide. Selecting System Setup additionally brings up the Licenses tab.
  • A step's dialog opens on top, and the guide stays open behind it. Complete the dialog, and you are back on the same workflow card ready for the next step. There is no need to reopen the guide between steps.
  • Previous and Next walk the whole workflow list in order rather than only within a group, so Next from Security Setup lands on Setup Scale-up Storage Pool. Previous is disabled on the first workflow and Next on the last. OK and Cancel both close the guide.

The guide does not track completion. Nothing is ticked off, no step is greyed out once it has been done, and the step numbering is the recommended order rather than a record of where you are. The cards do refresh when a license, target port, Storage Pool, Host, Storage Volume or volume assignment changes, but that is a redraw, not progress. Treat the numbering as a checklist you keep yourself.

Which workflows appear

The list is not fixed. Two things remove entries from it:

  • The license edition. The Express edition hides cluster management and scale-out object management, which removes the three scale-out pool workflows and Provision Object Storage, and reduces Setup Scale-up Storage Pool to a single Create Storage Pool step. The Object edition hides remote-replication together with the volumes, shares and hosts sections, which leaves System Setup, Storage Grid Setup, Security Setup, Setup Scale-out Object Pool, Provision Object Storage and Setup Cloud Integration.
  • Per-account interface visibility. A management user can have main tabs and tree sections hidden on the Web Interface Customization settings of their account, and the guide honours those settings too -- a user who cannot see the Storage Volumes section does not get the Provision Block Storage workflow. See Security Configuration.

So a workflow that is missing is a licensing or account-visibility result, not a fault. The tables below describe the full set.

Initial Setup

Everything a new appliance or a new grid needs before storage is provisioned on it.

System Setup

Setting up a new Storage System should always start with adding a license key in order to unlock all the core management features. Licensing is first because the rest of the management operations are gated on it; the password change is next because the appliance is reachable on the network with a known default until it is done.

Step Opens Documented in
1 Add License License Management -- also covers distributing a key file across a whole grid in one operation
2 Activate License License Management -- online activation, and the offline path for systems with no Internet access
3 Set Password Security Configuration
4 (optional) Certificate Template Manager Security Configuration

The workflow description also asks you to give every network port a static address. That is not one of its steps; do it from Network Ports, which explains why a fresh appliance must be moved off DHCP before anything else is configured.

Storage Grid Setup

Storage Grid technology makes it easy to manage large numbers of Storage Systems as one distributed system. A grid has to exist before remote-replication, site clusters or scale-out clusters can be built, which is why this comes before either pool group.

Step Opens Documented in
1 Create Storage Grid Grid Configuration
2 Add System to Grid Grid Configuration -- including what merges when a system joins
3 Update DNS & NTP Opens Modify Grid Network Settings, which applies one DNS search suffix, DNS server list and NTP server list to every system you tick. The per-system equivalents are the DNS Servers and NTP Servers tabs of Storage System Modify.
4 Update Time Zone Opens Modify Grid Time Zone Settings, which sets the time zone on every system you tick.
5 Configure Alerting Call-home / Alerting -- email, SNMP and the ITSM integrations

Both grid-wide dialogs overwrite the selected systems' current settings with what you enter, so tick only the systems you intend to change. Working DNS and accurate time are prerequisites rather than conveniences: Active Directory, LDAP, certificate validation and license activation all depend on them, and a scale-out cluster reports clock skew as a health warning.

Security Setup

Security settings are applied storage grid wide including to any new systems added to the storage grid in the future. That is the reason this workflow sits in Initial Setup rather than being deferred -- a policy set now also governs systems that join later.

Step Opens Documented in
1 Configure Security Policy Security Configuration -- password policy, lockout and session settings
2 Join AD Domain... Active Directory Configuration, and Network Shares for the SMB side
3 Configure System Firewall Security Configuration

Step 3 opens the Storage System Modify dialog already advanced to its Firewall tab rather than a dialog of its own.

Pool Setup

Four workflows, one per pool architecture. Pick the one that matches the storage you intend to serve; they are alternatives, not a sequence. Scale-up pools are ZFS on media attached to one or two systems; the three scale-out workflows all build on a Ceph cluster of three or more systems.

Setup Scale-up Storage Pool

The Setup Scale-up Storage Pool workflow. The clustered HA sequence builds the heartbeat layer first, then the pool, then the failover group and its virtual interface.

Scale-up Storage Pools may be setup in single-node mode or clustered HA mode. The card shows the clustered sequence, which has a strict order: the site cluster and its heartbeat rings have to exist before an HA group can be attached to a pool, and the HA group has to exist before a virtual interface can move with it.

Step Opens Documented in
1 Create Site Cluster Site Cluster Setup
2 Add Cluster Ring Site Cluster Setup -- two rings per site cluster is the recommendation
3 Create Storage Pool Storage Pools
4 Create HA Group HA Cluster Setup (JBODs)
5 Add Pool HA VIF Cluster VIFs, with the failover mechanics in High-availability VIF Management

For a single-node pool only step 3 applies. Under the Express edition, or where cluster management is hidden for the account, the card collapses to that one step.

HA pools have a hardware precondition the guide states in its description: the media must support I/O fencing, which means dual-ported SAS, dual-ported NVMe, Fibre Channel or iSCSI devices. HA Cluster Setup (JBODs) covers the cabling; HA Cluster Setup (external SAN) covers the same configuration on SAN-provided media.

Setup Scale-out Object Pool

A scale-out storage cluster using three (3) or more Storage Systems must be setup first. The order builds the cluster, gives it capacity, then layers object storage on top.

Step Opens Documented in
1 Create Cluster Scale-out Object Setup (ceph)
2 Create OSDs & Journals Scale-out Object Setup (ceph), with the dialog itself covered in detail in Scale-out Block Setup (ceph)
3 Create Object Pool Group Scale-out Object Setup (ceph)
4 Add Object Gateway Scale-out Object Setup (ceph)
5 Create Object User Scale-out Object Setup (ceph)
6 Create Object Bucket Scale-out Object Setup (ceph)

Steps 5 and 6 are the same two steps as the Provision Object Storage workflow, repeated here so that this one workflow takes a set of bare systems all the way to a writable bucket.

Setup Scale-out File Pool

Scale-out file Storage Pools are POSIX-compliant and deliver high performance NFS, SMB, and native CephFS client access. The metadata servers come before the pool because a CephFS file system cannot be created without them.

Step Opens Documented in
1 Create Cluster Scale-out Block Setup (ceph)
2 Create OSDs & Journals Scale-out Block Setup (ceph)
3 Add MDS Scale-out File Setup (ceph)
4 Create File Storage Pool Scale-out File Setup (ceph)
5 Create Share Scale-out File Setup (ceph)

Setup Scale-out Block Pool

Scale-out block Storage Pools provide highly-available block storage via the iSCSI, Fibre-Channel, and NVMeoF protocols as well as via the native Ceph RBD protocol.

Step Opens Documented in
1 Create Cluster Scale-out Block Setup (ceph)
2 Create OSDs & Journals Scale-out Block Setup (ceph)
3 Create Pool Scale-out Block Setup (ceph)
4 Create Storage Volume Scale-out Block Setup (ceph)

A volume created here still has to be assigned to a Host before any initiator can reach it, which is what the Provision Block Storage workflow does.

Provisioning Setup

Three workflows that turn an existing pool into storage a client can mount. Each of them assumes a pool from the Pool Setup group already exists.

Provision File Storage

A Storage Pool (scale-up or scale-out) must be created before Network Shares may be provisioned.

Step Opens Documented in
1 Create Share Network Shares
2 Add NFS Access Network Shares
3 Modify Network Share Network Shares -- user access, record size and compression

A new share is created with a default [public] NFS client entry that permits every address, so step 2 is where NFS access is narrowed to the subnets that should have it. SMB access is governed separately, by users and groups rather than by client rules.

Provision Block Storage

Storage Volume(s) must be assigned to one or more Hosts before they may be accessed. That is the whole reason this workflow has three steps rather than one: QuantaStor has no open-access mode, so a volume nobody is assigned to is reachable by nobody.

Step Opens Documented in
1 Create Storage Volume Storage Volumes
2 Add Host Creates the Host entry that represents a server, VM or cluster node, identified by its iSCSI IQN, NVMe NQN or Fibre Channel WWPNs
3 Assign Volumes Storage Volumes

Where several hosts form a cluster, put them in a Host Group and assign to the group instead -- hosts added later then pick up every volume already assigned to it. See Storage Volumes.

Provision Object Storage

Use the 'Setup Scale-out Object Pool' workflow to first setup an object storage cluster before provisioning Object Users and Buckets. This workflow is the short form for a cluster that already exists.

Step Opens Documented in
1 Create Object User Scale-out Object Setup (ceph) -- each user carries an access key and a secret key
2 Create Object Bucket Scale-out Object Setup (ceph)

Misc Setup

Setup Remote-Replication

Replication is automated via a Replication Schedules so that it can be used as part of a business continuity and DR site fail-over plan. The link comes first because it establishes the security relationship a schedule needs; a schedule cannot be created between two systems that have no link.

Step Opens Documented in
1 Create Replication Link Remote-replication (DR) -- links are bidirectional
2 Create Schedule Remote-replication (DR)
3 Trigger Replication Schedule Remote-replication (DR)

Both endpoints must be members of the same Storage Grid, so Storage Grid Setup is a prerequisite for this workflow.

Setup Cloud Integration

Storage Systems can be connected to one or more major public cloud providers to provide local NAS gateway access to object storage and a means of automated backup and tiering via Backup Policies. Only the first step is required; the rest are marked optional because which of them you need depends on whether the cloud bucket already exists.

Step Opens Documented in
1 Add Cloud Provider Credential Cloud Containers / NAS Gateway
2 (optional) Add/Import Cloud Storage Container Cloud Containers / NAS Gateway -- for a bucket that already exists
3 (optional) Create Cloud Storage Container Cloud Containers / NAS Gateway -- creates the bucket as well as the container
4 (optional) Create Backup Policy Backup Policies

A Cloud Storage Container appears as a Network Share on the appliance, so file clients reach cloud object storage over NFS and SMB without changing anything client-side.

Related pages


Verified against QuantaStor 6.9.0.