Difference between revisions of "+ Getting Started Overview"

From OSNEXUS Online Documentation Site
Jump to: navigation, search
m (Add S3/SWIFT Users)
m (Highly-Available Pool Setup (ZFS))
 
(79 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:Stor Sys Rbbn Gttn Started.jpg | 900px | Getting Started Ribbon]]
+
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.
 
 
[[File:Configuration Guide.jpg  | 500px | Getting Started/Configuration Guide]]
 
 
=== 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:Basic Setup Add License.jpg  | 512px | 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:Basic Setup Activate License.jpg | 512px | 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.
 
 
For more information on the license activation, refer to the [[Storage System License Activate Online]] page.
 
 
=== Change Administrator 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:Basic Setup Chng Pass.jpg | 512px | Change Administrator 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".
+
===Getting Started===
 
+
With your first login, the Getting Started dialog will give you step by step guidance to set up your desired Storage System.
[[File:Basic Setup Net Cnfg.jpg | 512px | Network Configuration]]
+
[[File:Getting Stared Welcome.jpg|512px]]
 
+
For more information on the password, refer to the [[Network Port Modify]] page.
+
 
+
== Storage Grid Setup ==
+
 
+
=== Create Storage Grid... ===
+
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:Storage Grid Create Grid.jpg | 512px | Create Storage Grid...]]
+
 
+
For more information, refer to the [[Create Management Grid]] page.
+
 
+
=== Add System... ===
+
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".
+
 
+
[[File:Storage Grid Add System.jpg | 512px |  Add System...]]
+
 
+
For more information, refer to the [[Add Management Grid]] 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 Pool ===
+
 
+
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:Block Prov Create Pool.jpg | 512px | 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:Block Prov Create Volume.jpg | 512px | Create Volume]]
+
 
+
For more information, refer to the [[Storage Volume Create]] page and the [[QuantaStor Administrators Guide | Administrators Guide]].
+
 
+
=== Add Host Initiator ===
+
 
+
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:Block Prov Add Host Initiator.jpg | 512px | Add Host Initiator]]
+
 
+
For more information, refer to the [[Host Add]] page.
+
 
+
=== Assign Volume ===
+
 
+
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:Block Prov Assign Volume.jpg | 512px | Assign Volume]]
+
 
+
<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 Pool ===
+
 
+
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:File Prov Create Storage Pool.jpg | 512px | 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:File Prov Setup Active Directory.jpg  | 512px | Setup Active Directory (Optional)]]
+
 
+
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:File Prov Create Network Share.jpg | 512px | Create Network Share]]
+
 
+
For more information, refer to the [[Network Share Configure CIFS]] page.
+
 
+
=== Add NFS Client Access Settings ===
+
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:File Prov Add NFS Client Access.jpg | 512px | Add NFS Client Access Settings]]
+
 
+
For more information, refer to the [[Add NFS Client Access]] page.
+
 
+
===  Modify SMB Client Access Settings ===
+
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:File Prov Modify SMB Client Access Settings.jpg | 512px | Modify SMB Client Access Settings]]
+
 
+
For more information, refer to the [[Modify Network Share]] page.
+
 
+
== Object Storage Setup (S3/SWIFT) ==
+
 
+
=== Create Object Storage Cluster ===
+
 
+
Scale-out S3/SWIFT Object Storage and scale-out block storage leverages open storage Ceph technology. Before provisioning scale-out storage one must setup one or more Ceph Clusters within the Storage Grid. Ceph Clusters should be comprised of at least three (3) or more Storage Systems within the grid. Single-node Ceph Clusters may be created but these are only recommended for test configurations. Note also that one should setup the network ports on each System so that a dedicated high speed back-end network may be used for inter-node communication. This back-end network is recommended to have double the bandwidth of the front-end network. Both the front-end and back-end network ports should bonded ports for improved performance and high-availability. The same network may be used for the front-end and back-end network but this is not optimal.
+
 
+
 
+
[[File:Obj Stor Create Object Storage Cluster.jpg | 512px | Create Object Storage Cluster]]
+
 
+
===Select Data Devices ===
+
 
+
Scale-out Storage Pools and Zones store their data in object storage devices called OSDs. Each Physical Disk assigned to the Ceph Cluster as a data Device becomes an OSD. To accelerate write performance each System must have at least one SSD device assigned as a WAL Device. All writes are logged to an OSD's associated WAL Device first. Press the button to the left to add OSDs and WAL devices to the Ceph Cluster.
+
 
+
 
+
[[File:Obj Stor Select Data Devices.jpg | 512px | Select Data Devices]]
+
 
+
=== Create S3/SWIFT Object Storage Zone ===
+
  
To access the cluster via the S3 or SWIFT object storage protocols a Zone must be created. Press the button to the left to create a S3/SWIFT object storage zone within the cluster.
 
  
  
[[File:Obj Stor Select Create S3-SWIFT Object Storage Zone.jpg | 512px | Create S3/SWIFT Object Storage Zone]]
+
Thereafter you will have to go to the toolbar for the Getting Started dialog.
  
=== Add S3/SWIFT Gateways ===
+
'''Navigation:''' Storage Management --> Storage System --> Storage System --> Getting Started ''(toolbar)''
  
Select the Ceph Cluster to add a new S3/SWIFT Gateway to and specify the network interface configuration.
+
[[File:Getting Started Ribbon Bar.jpg|512px]]
  
 +
[[QuantaStor_Getting_Started_Guide|Additional information for Getting Started dialog.]]
  
[[File:Obj Obj Stor Add S3-SWIFT Gateways.jpg | 512px | Add S3/SWIFT Gateways]]
+
=== [[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 S3/SWIFT Users ===
+
===Highly-Available Pool Setup (ZFS)===
 +
{{Editing_Highly-Available_Pool_Setup_(ZFS)}}
  
After the Zone has been created users must be given an access key and secret key in order to create buckets and objects via the S3 and or SWIFT protocols. Press the button to the left to add a S3/SWIFT Object User Access Entry to the Zone.
+
=== [[Scale-out Block Storage Setup]] ===
  
 +
=== [[Scale-out File Storage Setup]] ===
  
[[File:Add S3-SWIFT Users.jpg | 512px | Add S3/SWIFT Users]]
+
=== [[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.
  
 +
=== [[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.
  
 +
=== [[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.
  
 +
=== [[Remote-Replication Setup]] ===
  
 
{{Template:ReturnToWebGuide}}
 
{{Template:ReturnToWebGuide}}
 
[[Category:WebUI Dialog]]
 
[[Category:WebUI Dialog]]
[[Category:QuantaStor4]]
 
[[Category:Requires Review]]
 

Latest revision as of 15:45, 18 September 2019

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

Getting Started

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


Thereafter you will have to go to the toolbar for the Getting Started dialog.

Navigation: Storage Management --> Storage System --> Storage System --> Getting Started (toolbar)

Getting Started Ribbon Bar.jpg

Additional information for 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.

Create a Site Cluster

Create a Site Cluster.

Add a Cluster Ring

Add Cluster Ring 5.5.jpg

Scale-out Block Storage Setup

Scale-out File 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.

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

Return to the QuantaStor Web Admin Guide