Difference between revisions of "+ User Guide Overview"

From OSNEXUS Online Documentation Site
Jump to: navigation, search
m (Step 1: Installing the QuantaStor StorageLink Adapter)
m (User Guide Topics)
 
(266 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Multipath Configuration ==
+
[[Category:user_guide]]
=== Configuring Microsoft MPIO ===
+
The QuantaStor Users Guide focuses on how to configure your hosts (Linux, Windows, MacOS, VMware, XenServer, etc) to access file and block storage in your QuantaStor storage systems.
=== Configuring Linux Device-Mapper Multipath (DMMP) ===
+
== XenServer Configuration ==
+
=== Installing the QuantaStor Adapter for Citrix StorageLink ===
+
The next release of XenServer & Citrix Essentials for Hyper-V will include built-in support for QuantaStor but until then you can add support to your XenServer 5.5/5.6 instances by following a few steps.
+
==== Step 1:  Installing the QuantaStor StorageLink Adapter ====
+
After you have StorageLink installed and licensed you can add the QuantaStor adapter by downloading and running the StorageLink adapter installer available from our [http://www.osnexus.com/downloads/ downloads] page.  Before installing the QuantaStor StorageLink adapter you'll need to first stop the StorageLink service by typing this command at an Administrator command prompt or by stopping the StorageLink service using the Windows Services panel.
+
<pre>
+
c:\> net stop storagelink
+
</pre>
+
  
After the service is stopped you can now install the QuantStor StorageLink Adapter using the installer executable:
+
== User Guide Topics ==
[http://www.osnexus.com/downloads/osn_quantastor_client.exe osn_quantastor_client.exe]
+
  
Additionally, you'll need to add this block of XML to the end of the StorageLink configuration file located here:
+
[[iSCSI Initiator Setup]]
C:\Program Files\Citrix\StorageLink\Server\scsi_device_id_config.xml
+
<pre>
+
<ScsiDeviceIDProcessor>
+
  <InquiryMatch>
+
    <Vendor>OSNEXUS</Vendor>
+
    <Product>QUANTASTOR</Product>
+
  </InquiryMatch>
+
  <VendorID value="OSNEXUS" />
+
  <ProductID value="QUANTASTOR" />
+
  <EnclosureID page="128" offset="4" length="8" />
+
  <DeviceID page="128" offset="12" length="8" />
+
</ScsiDeviceIDProcessor>
+
</pre>
+
  
Also, at the top of this file you'll find a version number that looks like this:
+
[[Multipath IO Configuration]]
<pre>
+
<version>2.0.0.4</version>
+
</pre>
+
You'll want to increase that version number so that it is something like this:
+
<pre>
+
<version>2.0.0.5</version>
+
</pre>
+
That tells StorageLink that it needs to upgrade your XenServer systems with these new device identification rules. 
+
  
Now you're ready to restart the Citrix StorageLink service:
+
[[NFS Configuration]]
<pre>
+
c:\> net start storagelink
+
</pre>
+
  
Now that you have the StorageLink adapter installed, you'll want to verify that the adapter was properly loaded, and then add your storage system credentials so that StorageLink can dynamically configure and allocate storage volumes for your QuantaStor storage system.  Once you're logged in to Citrix StorageLink Manager, select the "Administration" tree on the left and side and look for OS NEXUS QuantaStor in the list.  It should look like this:
+
[[VMware Configuration]]
  
[[File:storagelink_admin.png]]
+
[[XenServer Configuration]]
  
Note in this picture it shows credentials for two QuantaStor storage systems have been added. 
+
[[VSA iSCSI Configuration]]
  
 
+
[[FIPS Mode]]
[[File:storagelink_si.png]]
+
 
+
Once you add your credentials you can verify that the storage system discovery was successful by choosing the ''Storage Infrastructure'' tree.  It should look something like this after your storage system has been discovered.  Now you're ready to start creating storage repositories using the Create Storage Repository wizard within StorageLink Manager.
+
 
+
==== Step 2:  Installing the XenServer multipath configuration settings ====
+
XenServer utilizes the Linux device-mapper multipath driver (dmmp) to enable support for hardware multi-pathing.  The dmmp driver has a configuration file called multipath.conf that contains the multipath mode and failover rules for each vendor.  There are some special rules that need to be added to that file for QuantaStor as well.  To that end, you'll need to edit the /etc/multipath-enabled.conf file located on each of your XenServer dom0 nodes. In that file, just find the last '''device { }''' section and add this additional one for QuantaStor:
+
<pre>
+
device {
+
    vendor "OSNEXUS"
+
    product "QUANTASTOR"
+
    getuid_callout "/sbin/scsi_id -g -u -s /block/%n"
+
    path_checker readsector0
+
    path_grouping_policy multibus
+
    failback immediate
+
}
+
</pre>
+
 
+
Again, apologies for the inconvenience here. We're working closely with Citrix to get this integrated so that everything is pre-installed with their next product release.
+
 
+
 
+
=== Creating XenServer Storage Repositories (SRs) ===
+
 
+
Generally speaking, there are two types of XenServer storage repositories (SRs) you can use with QuantaStor. 
+
 
+
* iSCSI Software SR
+
* StorageLink SR
+
 
+
The 'iSCSI Software SR' which allows you to assign a single QuantaStor storage volume to XenServer and then XenServer will create multiple virtual disks (VDIs) within that one storage volume/LUN.  This route is easy to setup but it has some drawbacks:
+
 
+
'''iSCSI Software SR'''
+
*Pros:
+
** Easy to setup
+
*Cons:
+
** The disk is formatted and laid out using LVM so the disk cannot be easily accessed outside of XenServer
+
** The custom LVM disk layout makes it so that you cannot easily migrate the VM to a physical machine or other hypervisors like Hyper-V & VMWare.
+
** No native XenServer support for hardware snapshots & cloning of VMs
+
** Potential for spindle contention problems which reduces performance when the system is under high load.
+
** Within QuantaStor manager you only see a single volume so you cannot setup custom snapshot schedules per VM and cannot roll-back a single VM from snapshot.
+
 
+
The second and most preferred route is to create your VMs using a Citrix StorageLink SR.  With StorageLink there is a one-to-one mapping of a QuantaStor ''storage volume'' to each virtual disk (VDI) seen by each XenServer virtual machine.
+
 
+
'''Citrix StorageLink SR'''
+
*Pros:
+
** Each VM is on a separate LUN(s)/storage volume(s) so you can setup custom snapshot policies
+
** Leverage hardware snapshots and cloning to rapidly deploy large numbers of VMs
+
** Enables migration of VMs between XenServer and Hyper-V using Citrix StorageLink
+
** Enables one to setup custom off-host backup policies and scripts for each individual VM
+
** Easier migration of VMs between XenServer resource pools
+
** VM Disaster Recovery support via StorageLink (requires QuantaStor Platinum Edition)
+
*Cons:
+
** Requires a Windows host or VM to run StorageLink on.
+
** Some additional licensing costs to run Citrix Essentials depending on your configuration. 
+
*** (A free version exists which supports 1 storage system)
+
 
+
With the next version of Citrix StorageLink we'll be directly integrated so it will be just as easy to get going using the StorageLink SR if not easier as it will do all the array side configuration for you automatically.
+
 
+
==== Creating a XenServer Software iSCSI SR ====
+
 
+
Now that we've discussed the pros/cons, let's get down to creating a new SR.  We'll start with the traditional "one big LUN" ''iSCSI Software SR''.  The name is perhaps a little misleading, but it's called a 'Software' SR because Citrix is trying to make clear that the iSCSI software initiator is utilized to connect to your storage hardware.  Here's a summary of the steps you'll need to take within the QuantaStor Manager web interface before you create the SR.
+
 
+
* Login to QuantaStor Manager
+
* Create a ''storage volume'' that is large enough to fit all the VMs you're going to create. 
+
** Note: If you use a large thin-provisioned volume that will give you the greatest flexibility.
+
* Add a ''host'' for each node in your XenServer resource pool
+
** Note: You'll want to identify each XenServer host by it's IQN.  See the troubleshooting section for a picture of XenCenter showing a server's initiator IQN.
+
* (optional) Create a ''host group'' that combines all the Hosts
+
* Assign the ''storage volume'' to the ''host group''
+
 
+
Alternatively you can assign the storage to each host individually but you'll save a lot of time by assigning it to a host group and it makes it easier to create more SRs down the road.
+
 
+
After you have the storage volume created and assigned to your XenServer hosts, you can now create the SR.
+
 
+
[[File:xencenter_iscsisr.png]]
+
 
+
This picture shows the iSCSI Software SR type selected.
+
 
+
 
+
[[File:xencenter_iscsisr_part2.png]]
+
 
+
Here we're showing the main page of the wizard.  Here you'll enter the IP address of your QuantaStor storage system and then press the Discover Targets and Discover LUNs button to find the device you created.  Once you have it selected, just press OK and you're done.
+
 
+
==== Creating a XenServer StorageLink SR (LUN per VDI) ====
+
 
+
Once you have the StorageLink adapter software installed as outlined above, you can quickly create new SRs using the StorageLink Manager UI.  StorageLink SRs map one-to-one with a QuantaStor Storage Pool.  So when you create the SR you'll indicate which pool you want your storage volumes created in for that SR and as new VMs are created with that SR StorageLink will automatically provision the storage volumes for you and deploy them into your XenServer environment.  To get started first you'll need to login to Citrix StorageLink Manager and tell it about your storage system. 
+
You'll do this by selecting the "Administration" section, then select "OS NEXUS QuantaStor" from the list vendor modules, then right-click and choose "Add Credentials".  You'll see this dialog:
+
 
+
[[File:storagelink_addcred.png]]
+
 
+
In here you need to tell StorageLink the IP address of your QuantaStor storage system and the username/password to login so that it can dynamically configure the storage system for you.  If you have multiple teams using a common QuantaStor storage system, you might want to first setup some QuantaStor ''storage clouds'' so that you can securely separate the resources between the teams.  That way each team will only see their devices within their StorageLink/XenServer deployment, and you can place quotas on them.
+
 
+
Next you'll want to look at the ''Storage Infrastructure'' tree inside Citrix StorageLink Manager to make sure your QuantaStor hardware has been properly detected.  If you see it there, you're all set, just click the "Create Storage Repository" button in the Action pane on the right hand side of the Citrix StorageLink Manager window and follow the wizard.
+
 
+
=== Troubleshooting StorageLink ===
+
 
+
If you run into problems we recommend that you create a traditional iSCSI SR to verify connectivity to the array before you start allocating LUNs via a StorageLink SR.  To do that, first you'll need to allocate a storage volume using the QuantaStor Manager, then you'll need to assign it to all the nodes in your XenServer resource pool. To summarize:
+
* Login to QuantaStor Manager
+
* Create a ''storage volume''
+
* Add a ''host'' for each node in your XenServer resource pool
+
* (optional) Create a ''host group'' that combines all the Hosts
+
* Assign the ''storage volume'' to the ''host group''
+
 
+
Note that when you add the hosts using the 'Add Host' dialog in QuantaStor Manager you'll want to enter the XenServer host's initiator IQN and that can be found using XenCenter as shown in this picture.
+
 
+
[[File:xencenter_iqn.png]]
+
 
+
At this point you can create the iSCSI SR by pointing it to the QuantaStor storage system and your storage volume will appear.  The great thing about this method is that you can use it to verify that StorageLink is properly identifying your storage volumes using the device identification rules you added to the scsi_device_id_config.xml file.
+
 
+
Next we're going to verify that your iSCSI LUN is being properly identified by the internal StorageLink tools on your XenServer host.  To do this, first you'll need to go to the console window of your XenServer dom0 and then issue the following commands
+
 
+
<pre>
+
cd /opt/Citrix/StorageLink/bin
+
./csl_devscan --native
+
</pre>
+
 
+
This is going to print out a list of all the SCSI devices that are visible to the system and their StorageLink identifiers.  In that list that is printed you should see a StorageLink storage volume identifiers (SVIDs) for all your SCSI disks and you should see at least one that looks something like this:
+
<pre>
+
OSNEXUS__QUANTASTOR__820ab779__b8b2c67f
+
</pre>
+
This identifier shows the vendor and model of the hardware (OSNEXUS / QUANTASTOR) and the two hex numbers '''820ab779''' and '''b8b2c67f''' at the end uniquely identify the storage system and the storage volume respectively.  If you don't see any OSNEXUS devices listed, then XenServer has not yet logged into the storage system.
+
If you see a OSNEXUS QUANTASTOR device and it is followed by a very long number (typically starting with 0080 and 0083) then the XenServer host is not properly identifying the devices using the rules you added to the ''scsi_device_id_config.xml'' file.  The way to fix this is to manually edit the local ''scsi_device_id_config.xml'' device configuration file at the dom0 console window:
+
<pre>
+
nano /opt/Citrix/StorageLink/bin/scsi_device_id_config.xml
+
</pre>
+
Once you're in the text editor you'll need to copy and paste in this XML block that was noted above which you added to the scsi_device_id_config.xml on Windows. 
+
<pre>
+
<ScsiDeviceIDProcessor>
+
  <InquiryMatch>
+
    <Vendor>OSNEXUS</Vendor>
+
    <Product>QUANTASTOR</Product>
+
  </InquiryMatch>
+
  <VendorID value="OSNEXUS" />
+
  <ProductID value="QUANTASTOR" />
+
  <EnclosureID page="128" offset="4" length="8" />
+
  <DeviceID page="128" offset="12" length="8" />
+
</ScsiDeviceIDProcessor>
+
</pre>
+
 
+
StorageLink's auto-upgrade process generally updates this configuration file for you so you shouldn't have to do this step but there may be some corner cases where the auto-upgrade isn't triggered.  Once you have the scsi_device_id_config.xml file updated you'll want to re run the ''csl_devscan'' command again you should now see the storage volume ID (SVID) properly identified as shown in the example above. (''OSNEXUS__QUANTASTOR__820ab779__b8b2c67f'').
+
At this point go ahead and create a StorageLink SR for XenServer using the Citrix StorageLink Manager GUI and try creating a new virtual machine to test it out.
+

Latest revision as of 14:27, 5 April 2023

The QuantaStor Users Guide focuses on how to configure your hosts (Linux, Windows, MacOS, VMware, XenServer, etc) to access file and block storage in your QuantaStor storage systems.

User Guide Topics

iSCSI Initiator Setup

Multipath IO Configuration

NFS Configuration

VMware Configuration

XenServer Configuration

VSA iSCSI Configuration

FIPS Mode