Difference between revisions of "+ Getting Started Overview"

From OSNEXUS Online Documentation Site
Jump to: navigation, search
m (Add License)
m (Additional information for Getting Started dialog.)
(235 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 SDS software on your server, please see the [[QuantaStor Installation Guide|Installation Guide]] for more details. For a full guide to the web interface see the [[QuantaStor Administrators Guide]].
+
[[Category:start_guide]]
 +
This guide begins from the point that you have installed QuantaStor and have successfully logged into QuantaStor Manager.  If you have not yet installed QuantaStor on your server, please see the [[QuantaStor Installation Guide|Installation Guide]] for more details.
  
The setup process in the product is currently contained within the [[Configuration Workflow Manager]]. <br>
+
== First Time Login ==
[[File:Getting Started Intro.png|1113px|Getting Started]]
+
The default administrator user name for your storage system is simply 'admin'.  This user account is present on all QuantaStor systems.  At the login dialog the admin user account name is pre-populated as this is the most commonly used login. If QuantaStor was installed for you by a CSP or VAR the password for the system(s) should have been emailed to you or made available via the CSPs server management panel.  If you've installed QuantaStor on a new server or VM the 'admin' account defaults to having a password of 'password' (without the single quotes).  '''IMPORTANT:''' Please change this immediately after you first login via the Users & Groups section.
  
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 included in the Workflow Manager.
+
==== Change Administrator Password ====
  
== Basic Setup ==
+
[[File:Set Password UI 5.5.jpg|640px|Change the Administrator's Password.]]
  
The steps covered here will be necessary to set up your storage system.
 
 
=== Add License ===
 
Once QuantaStor has been installed, the first step is to enter your license key block. Your license key block can be entered using the [[Storage System License Add | Add License]] button in the Workflow Manager or using the [[Storage System License Manager | License Manager]] dialog which is accessed by pressing the License Manager button in the toolbar.
 
 
[[File:Getting Started Add License.png | 600px | Add License]]
 
 
The key block you received via email is contained within markers like so:
 
 
<pre>
 
--------START KEY BLOCK--------
 
 
---------END KEY BLOCK---------
 
</pre>
 
 
Note that when you add the key using the 'Add License' dialog you can choose whether or not to include the START/END KEY BLOCK markers, though it makes no difference.
 
 
For more information on the license, refer to the [[Storage System License Add]] page.
 
 
=== Activate License ===
 
Once your key block has been entered you'll want to activate your key which can be done in one of two ways. If the new QuantaStor system is connected to the network, the activation can be completed in just a few seconds using the [[Storage System License Activate Online | Activate License Online]] button in the Workflow Manager. The ''Activate Online'' button in the [[Storage System License Manager | License Manager]] functions the same way.
 
 
[[File:Getting Started Activate License.png | 600px | Activate License]]
 
 
If your storage system is not connected to the internet select the [[Storage System License Activate Email | ''Activate via Email'']] button in the License Manager and send the required information to support@osnexus.com.  You have a 7 day grace period for license activation, so you can begin configuring and utilizing the system even if the system is not yet activated.  '''If you do not activate the license within 7 days''', the storage system will no longer allow any additional configuration changes until an activation key is supplied.
 
 
=== Change/Set Admin Password ===
 
 
For security, you will want to create a secure password for your storage system. This can be completed quickly using the [[User Set Password | Change Admin Password]] button in the Manager, but also can be achieved via the ''Set Password'' button in the toolbar under "Users & Groups".
 
For security, you will want to create a secure password for your storage system. This can be completed quickly using the [[User Set Password | Change Admin Password]] button in the Manager, but also can be achieved via the ''Set Password'' button in the toolbar under "Users & Groups".
  
[[File:Getting Started Password.png | 600px | Set Password]]
 
  
 
For more information on the password, refer to the [[User Set Password]] page.
 
For more information on the password, refer to the [[User Set Password]] page.
  
=== Network Configuration ===
+
== Step by Step Configuration Procedure ==
You will want to configure the ports on your storage system. This can be completed quickly using the [[Network Port Modify | Network Configuration]] button in the Manager, but also can be found via right-clicking inside the ''Network Ports'' tab, visible when "Storage System" is selected under "Storage Management".
+
 
+
[[File:Getting Started Network.png | 600px | Configure Network]]
+
 
+
For more information on the password, refer to the [[Network Port Modify]] page.
+
 
+
== Block Storage Provisioning (iSCSI/FC) ==
+
 
+
This section will cover the creation of storage volumes and user groups, and allocation of these storage volumes to these groups.
+
 
+
=== Create Storage Pools ===
+
 
+
To create your first storage pool via the Workflow Manager, switch to the Block Storage Provisioning tab within Workflow Manager and click on the [[Create Storage Pool]] button.  If you select RAID0 for raid type, then the pool will be ready immediately but won't be fault tolerant. Most likely, you will want to replace it with a RAID6 or RAID10 storage pool before you start writing important data to the storage system.
+
 
+
[[File:Getting Started Pool.png | 600px | Create Storage Pool]]
+
 
+
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. 
+
<blockquote>
+
'''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.
+
</blockquote>
+
 
+
For more information on storage pools, RAID levels and storage pool options refer to the [[Create Storage Pool]] page and the [[QuantaStor Administrators Guide | Administrators Guide]].
+
 
+
=== Create Volume ===
+
 
+
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, and so will be used within this wiki.
+
 
+
You may have to wait until your storage pool is 1% complete with its synchronization before you can start to create storage volumes.
+
 
+
To create your storage volumes, click the [[Storage Volume Create | Create Volume]] button in the Workflow Manager or the ''Create'' button on the toolbar under the "Storage Volumes" tab of "Storage Management". When the dialog appears, give your storage volume a name, select the size of the volume you want to create using the slider bar, and press OK.
+
 
+
[[File:Getting Started Volume Create.png | 600px | Create Storage Volume]]
+
 
+
For more information, refer to the [[Storage Volume Create]] page and the [[QuantaStor Administrators Guide | Administrators Guide]].
+
 
+
=== Adding Hosts ===
+
 
+
The host object represents a server, desktop, virtual machine or any other entity that you want to provide storage to. Each host is only allowed to see the storage volumes that you have assigned to them. The industry term for this is called "LUN Masking" but in for this wiki we will refer to it simply as "storage assignment".
+
 
+
To add a host to the system, click the [[Host Add | Add Host]] button in the Workflow Manager or the ''Create'' button on the toolbar under the "Hosts" tab of "Storage Management". You will be asked to enter a name, IP address and/or IQN for your new host.  We highly recommend that you always identify your hosts by IQN as it makes it easier to manage your hosts. Once you've entered a host name and its IQN press OK to have the host created.
+
 
+
[[File:Getting Started Host Create.png | 600px | Create Hosts]]
+
 
+
For more information, refer to the [[Host Add]] page.
+
 
+
=== Assigning Storage Volumes to Hosts ===
+
 
+
Now you're ready to assign the volumes you created to your hosts. In the Workflow Manager, this is covered by the [[Storage Volume Assign | Assign Volume(s)]] button. You can also assign them by using the "Assign" tool, under the "Storage Volumes" and the "Hosts" tab.
+
 
+
[[File:Getting Started Volume Assign.png | 600px | Assign Volumes to Hosts]]
+
 
+
<blockquote>
+
'''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. 
+
</blockquote>
+
Once you've selected your host and volume, press OK. Under the "Hosts" tab, you should now see your selected volumes in a dropdown menu below the host.
+
 
+
For more information, refer to the [[Storage Volume Assign]] page.
+
 
+
== File Storage Provisioning (iSCSI/FC) ==
+
 
+
=== Create Storage Pools ===
+
 
+
This step is identical to the [[QuantaStor_Getting_Started_Guide#Create_Storage_Pools | one of the same name]] in the Block Storage Provisioning step.
+
 
+
[[File:Getting Started Pool Two.png | 600px | Create Storage Pool]]
+
 
+
For more information, refer to the [[Create Storage Pool]] page.
+
 
+
=== Setup Active Directory (Optional) ===
+
This step works with Microsoft Active Directory to assign network shares to users and groups. Set up Active Directory using the [[Network Share Configure CIFS | Setup Active Directory]] button in Workflow Manager, or click on the button ''Configure Active Directory'' in the toolbar under "Network Share" in "Storage Management".
+
 
+
[[File:Getting Started Configure AD.png | 600px | Setup Active Directory]]
+
 
+
For more information, refer to the [[Network Share Configure CIFS]] page.
+
 
+
=== Create Network Share ===
+
This creates a folder within a selected storage pool. Click on the [[Network Share Create | Create Network Share]] button in Workflow Manager, or the ''Create'' button in "Network Share".
+
 
+
[[File:Getting Started Create Share.png | 600px | Create Network Share]]
+
 
+
For more information, refer to the [[Network Share Configure CIFS]] page.
+
 
+
=== Add NFS Client Access ===
+
Creates additional client access for the network share. Click on the [[Add NFS Client Access]] button in Workflow Manager, or rightclick on the target network share under "Network Share" and click "Add NFS Access".
+
 
+
[[File:Getting Started Add Access.png | 600px | Add NFS Access]]
+
 
+
For more information, refer to the [[Add NFS Client Access]] page.
+
 
+
=== Modify SMB Access ===
+
Lets you control the network share's settings such as compression, quotas, and sync policies. Click on the [[Modify Network Share]] button in Workflow Manager, or the ''Modify'' button under "Network Share".
+
 
+
[[File:Getting Started Modify Share.png | 600px | Modify Network Share]]
+
 
+
For more information, refer to the [[Modify Network Share]] page.
+
  
== Storage Grid Setup ==
+
===[[QuantaStor_Getting_Started_Guide|Additional information for Getting Started dialog.]]===
  
=== Create Storage Grid ===
+
[[File:Getting Started Sys Set.jpg|512px|Getting Started]]
Storage grids, also known as management grids, let you manage multiple storage appliance within the same system. Each appliance can only be part of one management grid. In Workflow Manager, switch to the "Storage Grid Setup" tab and click on the [[Create Management Grid | Create Storage Grid]] button, or rightclick on "Storage System" and select "Create Management Grid".
+
  
[[File:Getting Started Storage Grid.png | 600px | Create Storage Grid]]
+
With your first login, the Getting Started dialog will give you step by step guidance to set up your desired Storage System.
  
For more information, refer to the [[Create Management Grid]] page.
+
== Configuration Procedure without Getting Started dialog==
 +
=== [[Grid_Configuration|Grid Configuration]] ===
 +
Combine systems together to form a storage grid. <br>This enables a whole host of additional features including remote-replication, clustering and more.
  
=== Add Storage System to Grid ===
+
===[[Template:Editing_Highly-Available_Pool_Setup_(ZFS)|Highly-Available Pool Setup (ZFS)]]===
Adds other storage systems to your storage grid, called "nodes". Click on the [[Add Management Grid | Add Storage System to Grid]] button in Workflow Manager, or rightclick on "Storage System" and select "Add Grid Node".
+
Storage pools formed from devices which are dual-connected to two storage systems may be made highly-available. This is done by creating a storage pool high-availability group to which one or more virtual network interfaces (VIFs) are added. All access to storage pools must be done via the associated VIFs to ensure continuous data availability in the event the pool is moved (failed-over) to another system.
  
[[File:Getting Started Storage Node.png | 600px | Add Storage Node]]
+
===[[Template:Scale-out_S3_Pool_Setup_(Ceph_RGW)|Scale-out S3 Pool Setup (Ceph RGW)]]===
 +
Scale-out object and block storage configurations enable S3/SWIFT object storage access as well as iSCSI storage access to scale-out storage volumes. Scale-out storage uses replicas and/or erasure-coding technologies to ensure fault-tolerance and high-availability. Ceph technology is used within the platform so a Ceph cluster must first be created to enable this functionality.
  
For more information, refer to the [[Add Management Grid]] page.
+
=== [[Template:Scale-out_File_Pool_Setup_(Ceph_FS)|Scale-out File Pool Setup (Ceph FS)]] ===
 +
The Ceph file system (CephFS) is a POSIX-compliant file system that uses a Ceph storage cluster to store its data. Ceph file systems are highly available using metadata servers (MDS). Once you have a healthy Ceph storage cluster with at least one Ceph metadata server, you can create a Ceph file system.
  
=== Disk Drive Selection ===
+
=== [[Object Storage Setup|Scale-out S3 Object Storage Setup]] ===
 +
If your primary use case is to setup an object storage cluster with 3x or more QuantaStor servers, start here.
  
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.
+
=== [[File Storage Provisioning|Provisioning File Storage]] ===
 +
If your primary use case is to setup your QuantaStor as NAS filer, start here to learn how to provision Network Shares.
  
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.
+
=== [[Block Storage Provisioning|Provisioning Block Storage]] ===
 +
If your primary use case is to setup your QuantaStor as a SAN, start here to learn how to provision Storage Volumes.
  
=== Data Compression ===
+
=== [[Remote-Replication Setup]] ===
 +
The recovery manager enables you to quickly and easily recover the storage system database after a full system reinstall.
  
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.
+
For further Information... [https://wiki.osnexus.com/index.php?title=Remote-replication_(DR) Remote Replication]
  
=== SSD Optimizations ===
+
<br>
  
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.
+
{{Template:ReturnToWebGuide}}
 +
[[Category:WebUI Dialog]]

Revision as of 11:30, 16 June 2021

This guide begins from the point that you have installed QuantaStor and have successfully logged into QuantaStor Manager. If you have not yet installed QuantaStor on your server, please see the Installation Guide for more details.

First Time Login

The default administrator user name for your storage system is simply 'admin'. This user account is present on all QuantaStor systems. At the login dialog the admin user account name is pre-populated as this is the most commonly used login. If QuantaStor was installed for you by a CSP or VAR the password for the system(s) should have been emailed to you or made available via the CSPs server management panel. If you've installed QuantaStor on a new server or VM the 'admin' account defaults to having a password of 'password' (without the single quotes). IMPORTANT: Please change this immediately after you first login via the Users & Groups section.

Change Administrator Password

Change the Administrator's Password.

For security, you will want to create a secure password for your storage system. This can be completed quickly using the Change Admin Password button in the Manager, but also can be achieved via the Set Password button in the toolbar under "Users & Groups".


For more information on the password, refer to the User Set Password page.

Step by Step Configuration Procedure

Additional information for Getting Started dialog.

Getting Started

With your first login, the Getting Started dialog will give you step by step guidance to set up your desired Storage System.

Configuration Procedure without Getting Started dialog

Grid Configuration

Combine systems together to form a storage grid.
This enables a whole host of additional features including remote-replication, clustering and more.

Highly-Available Pool Setup (ZFS)

Storage pools formed from devices which are dual-connected to two storage systems may be made highly-available. This is done by creating a storage pool high-availability group to which one or more virtual network interfaces (VIFs) are added. All access to storage pools must be done via the associated VIFs to ensure continuous data availability in the event the pool is moved (failed-over) to another system.

Scale-out S3 Pool Setup (Ceph RGW)

Scale-out object and block storage configurations enable S3/SWIFT object storage access as well as iSCSI storage access to scale-out storage volumes. Scale-out storage uses replicas and/or erasure-coding technologies to ensure fault-tolerance and high-availability. Ceph technology is used within the platform so a Ceph cluster must first be created to enable this functionality.

Scale-out File Pool Setup (Ceph FS)

The Ceph file system (CephFS) is a POSIX-compliant file system that uses a Ceph storage cluster to store its data. Ceph file systems are highly available using metadata servers (MDS). Once you have a healthy Ceph storage cluster with at least one Ceph metadata server, you can create a Ceph file system.

Scale-out S3 Object Storage Setup

If your primary use case is to setup an object storage cluster with 3x or more QuantaStor servers, start here.

Provisioning File Storage

If your primary use case is to setup your QuantaStor as NAS filer, start here to learn how to provision Network Shares.

Provisioning Block Storage

If your primary use case is to setup your QuantaStor as a SAN, start here to learn how to provision Storage Volumes.

Remote-Replication Setup

The recovery manager enables you to quickly and easily recover the storage system database after a full system reinstall.

For further Information... Remote Replication


Return to the QuantaStor Web Admin Guide