1. Manuals
  2. Brands
  3. Chelsio Manuals
  4. PCI Card
  5. T5
  6. Installation and user manual

Chelsio T5 Installation And User Manual

Iscsi pdu offload target with scst support for linux
Hide thumbs Also See for T5:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Installer and User Manual

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the T5 and is the answer not in the manual?

Questions and answers

Related Manuals for Chelsio T5

Summary of Contents for Chelsio T5

  • Page 2 Copyright © 2016.Chelsio Communications. All Rights Reserved. Chelsio ® is a registered trademark of Chelsio Communications. All other marks and names mentioned herein may be trademarks of their respective companies. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 3 Document History Version Revision Date 1.0.0 03/28/2016 1.0.1 06/20/2016 Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 4: Table Of Contents

    5.10. Rules of Target Reload (i.e. “on the fly” changes) 5.11. System Wide Parameters 5.12. Performance Tuning 5.13. Firmware Update Software/Driver Unloading Software/Driver Uninstallation Software/Driver Update Appendix 9.1. Troubleshooting 9.2. Chelsio End-User License Agreement (EULA) Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 5: Introduction

    Chapter 1. Introduction 1. Introduction Thank you for choosing Chelsio Unified Wire adapters. These high speed, single chip, single firmware cards provide enterprises and data centers with high performance solutions for various Network and Storage related requirements. The Terminator 5 (T5) is Chelsio’s next generation of highly integrated, hyper-virtualized 40/10GbE controllers.

  • Page 6: Features

    Chapter 1. Introduction The performance of this iSCSI stack is outstanding and when used with Chelsio’s hardware it is enhanced further. Because of the tight integration with Chelsio’s TOE adapters, this software has a distinct performance advantage over the regular NIC. The entire solution, which includes this software, Chelsio TOE hardware, an appropriate base computer system –...

  • Page 7: Hardware Requirements

    1.2.3. Storage Requirements When using the Chelsio iSCSI target, a minimum of one hardware storage device is required. This device can be any of the device types that are supported (block, virtual block, RAM disk). Multiple storage devices are allowed by configuring the devices to one target or the devices to multiple targets.

  • Page 8: Software Requirements

    The directory contains support documents - README, Release Notes and User’s Guide (this document) for the software. scripts: Support script used by the installer. src: The directory contains driver source code and T5 firmware binary and configuration files. tools: ...
  • Page 9 Chapter 1. Introduction  chdebug: This script collects operating system environment details and debug information which can be sent to the support team, to troubleshoot Chelsio hardware/software related issues.  chiscsi_set_affinity.sh: This shell script is used for mapping iSCSI Worker threads to different CPUs.

  • Page 10: Hardware Installation

    6. For maximum performance, it is highly recommended to install the adapter into a PCIe x8/x16 slot. 7. Holding the Chelsio adapter by the edges, align the edge connector with the PCI connector on the motherboard. Apply even pressure on both edges until the card is firmly seated. It may be necessary to remove the SFP (transceiver) modules prior to inserting the adapter.
  • Page 11 Note convention: the port farthest from the motherboard will appear as the first network interface. However, for T5 40G adapters, the association of physical Ethernet ports and their corresponding network device names is opposite. For these adapters, the port nearest to the motherboard will appear as the first network interface.

  • Page 12: Software/Driver Installation

    Chapter 3. Software/Driver Installation 3. Software/Driver Installation Any previous version of SCST or Chelsio Unified Wire driver package must Important be uninstalled before proceeding. SCST should be installed in the machine followed by iSCSI Target driver. Follow the steps mentioned below: Download the iSCSI Target driver package from Chelsio Download Center, http://service.chelsio.com/...
  • Page 13 Reboot system for changes to take effect. Installation/uninstallation will neither remove the configuration file nor rename it. It Note will always be intact. However, it’s recommended to always take a backup of the file. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 14: Software/Driver Loading

    There are two main steps to installing the Chelsio iSCSI PDU Offload Target software. They are: 1. Installing the iSCSI software – The majority of this section deals with how to install the iSCSI software.
  • Page 15 Chapter 4. Software/Driver Loading ii. Configure an iSCSI Target. You can refer the sample configuration files placed in your system during installation. A sample iSCSI configuration file will be installed in /etc/chelsio- iscsi/chiscsi.conf and a sample SCST configuration file in /etc/chelsio-iscsi/scst.conf. You...
  • Page 16 For the script to execute properly, make sure the following flag is set on Note all kernel.org kernels. # CONFIG_MODULE_FORCE_LOAD=y  The script will not work on Ubuntu platforms and also when SCST configuration is used. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 17: Software/Driver Configuration And Fine-Tuning

    Chelsio specific. An example of an iSCSI specific item is “HeaderDigest” which is defaulted to “None” but can be overridden to “CRC32C”. An example of a Chelsio Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 18: A Quick Start Guide For Target

    PortalGroup – The portal group tag associating with a list of target IP address (es) and port number(s) that service the login request. The format of this field is a Chelsio specific iSCSI driver parameter which is described in detail in the configuration file section.
  • Page 19 Stop Target: To stop the all the iSCSI target(s), execute “ ”. target=ALL [root@host~]# iscsictl –s target=ALL with “ ” followed by the target name. To stop a specific target execute iscsictl [root@host~]# iscsictl –s target=iqn.2006-02.com.chelsio.diskarray.san1 Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 20: The Iscsi Configuration File

    There can be only one global entity block whereas multiple target entity blocks are allowed. The global entity block is optional but there must be at least one target entity block. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 21 5.4.1. Chelsio System Wide Global Entity Settings Description Chelsio System Wide Global Entity Parameters pass system control information to the iSCSI software which affects all targets in the same way. More detail of these parameters below can be found in a later section entitled “System Wide Parameters”.
  • Page 22 (initiator and a string of target) systems. maximum of iscsi_chelsio_ini_idstr “cxgb4i” characters Make sure the initiator name contain the substring set in iscsi_chelsio_ini_idstr when using Chelsio iscsi initiator Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 23 5.4.2. iSCSI Entity Settings Description iSCSI Entity Parameters pass iSCSI protocol control information to the Chelsio iSCSI driver. This information is unique for each entity block. The parameters follow the IETF iSCSI standard RFC 3720 in both definition and syntax. The descriptions below are mostly from this RFC.
  • Page 24 Chelsio Entity Parameters pass control information to the Chelsio iSCSI driver. The parameters are specific to Chelsio’s implementation of the iSCSI node (target or initiator) and are unique for each entity block. The parameters consist of information that can be put into three categories: 1.
  • Page 25 It [,<target IP must be a positive integer. address> [:<port <target IP address> is the IP number>]] address associated with the portal [,timeout= group tag. <timeout value Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 26 NULLRW specifies that random data is returned for reads, and for writes data is dropped. Useful for Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 27 ID (short form for SCSI ID), SN and WWN values should manually TargetDevice. These values will be returned in Inquiry response (VPD 0x83). Multiple TargetDevice key=value Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 28  iname, and/or  sip, and/or  dip. lun=<lun list>:<permission> controls how the initiators access the luns. The supported value for <lun list> is ALL. <permissions> can be: Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 29 # change iscsi_offload_mode to TOE or ULP if desired # perform CHAP authentication first before ACL iscsi_auth_order=CHAP # Authentication configuration # Use DISC_AuthMethod=CHAP to force chap DISC_AuthMethod=None # oneway chap, Use DISC_Auth_CHAP_Policy=Mutual for mutual chap Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 30 # flag "NULLRW" means no actual read or write (i.e., if specified, # for read, random contents will be returned; for write, # data will be dropped. It is useful to test for network # performance. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 31 # Target Portal group information, adjust to your system specifc PortalGroup=1@192.168.1.1:3260 PortalGroup=2@192.168.1.2:3260 #Access Control List settings ACL_Enable=[Yes|No] ACL=[iname=<initiator name>;][;<sip=src ip>][;<dip=dst ip>] [;<lun=ALL:R|RW>] #ACL_Enable=Yes # initiator iqn.2004-08.com.chelsio.test1 is allowed r/w access on all Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 32 # oneway chap, Use Auth_CHAP_Policy=Mutual for mutual chap. Auth_CHAP_Policy=Oneway #Auth_CHAP_ChallengeLength=16 # CHAP id and secret should be enclosed in double quotes and # separated by : Auth_CHAP_Target="target_id1":"target_secret1" Auth_CHAP_Initiator="initiator_id1":"initiator_sec1" Auth_CHAP_Initiator="initiator_id2":"initiator_sec2" Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 33: Challenge-Handshake Authenticate Protocol (Chap)

    CHAP is a protocol that is used to authenticate the peer of a connection and uses the notion of a challenge and response, (i.e., the peer is challenged to prove its identity). Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 34 For mutual CHAP, in addition to the initiator CHAP id and secret, the target CHAP id and secret are required. They are configured and stored on a per target basis with Chelsio Entity parameter “Auth_CHAP_Target”. 5.5.4. Adding CHAP User ID and Secret...
  • Page 35 CHAP b) CHAP Oneway or c) CHAP Mutual  Auth_CHAP_Policy=Mutual , the Chelsio iSCSI target will accept a relevant initiator if it does a) no CHAP or b) CHAP Mutual With AuthMethod=None , regardless the setting of the key Auth_CHAP_Policy, the Chelsio iSCSI target will only accept a relevant initiator if it does no CHAP.

  • Page 36: Target Access Control List (Acl) Configuration

    DISC_Auth_CHAP_Initiator="initiator_id1":"initiator_sec1" 5.6. Target Access Control List (ACL) Configuration The Chelsio iSCSI target supports iSCSI initiator authorization via an Access Control List (ACL). ACL configuration is supported on a per-target basis. The creation of an ACL for a target establishes: Which iSCSI initiators are allowed to access it...

  • Page 37: Target Storage Device Configuration

    An iSCSI Target can support one or more storage devices. The storage device can either be the built-in RAM disk or actual backend storage. Configuration of the storage is done through the Chelsio configuration file via the key-value pair TargetDevice...
  • Page 38 “SYNC” can be used with FILE mode to make sure the data is flushed to the storage device before the Target responds back to the Initiator. FILE To configure a FILE storage device specify as the device mode: TargetDevice=<path to the storage device>[,FILE][,SYNC] Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 39 Is the path to the actual storage device, such as /dev/sdb. The path must exist in the system. target: #<snip> # /dev/sdb is accessed in BLK mode TargetDevice=/dev/sdb,BLK #<snip> Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 40: Target Redirection Support

    #<snip> # any login requests received on 10.193.184.81:3260 will be # redirected to 10.193.184.85:3261. PortalGroup=1@10.193.184.81:3260,[2] PortalGroup=2@10.193.184.85:3261 # the PortalGroup “2” is NOT presented on the same system. ShadowMode=Yes #<snip> Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 41: The Command Line Interface Tools "Iscsictl" & "Chisns

    5.9. 5.9.1. iscsictl iscsictl is the tool Chelsio provides for controlling the iSCSI target. It is a Command Line Interface (CLI) that is invoked from the console. Its usage is as follows: iscsictl <options> <mandatory parameters> [optional parameters] Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 42 Chelsio iSCSI driver implementation. In this document, the key=value is referred to as “pair”, and var=const is referred to as “parameter” to clarify between iSCSI protocol‟s pair value(s), and Chelsio iSCSI driver‟s parameter value(s). Note that all value and const are case sensitive.
  • Page 43 Display the Chelsio iSCSI Global Entity Settings. <var=const> Set the Chelsio iSCSI Global Entity Settings. var=const parameter: Where var=const can be any key listed under Chelsio Global Entity Settings. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 44 1. If the target=<name> parameter is specified, only the targets from the list will be started or reloaded. 2. If target=ALL is specified, all targets specified from the iSCSI configuration file will Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 45 The port is optional and if it‟s not specified it defaults to 3205. The server with the ip address is mandatory and if it‟s not specified the, the command will be Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...
  • Page 46 In the first example the minimum command set is given where the IP address of the iSNS server is specified. In the second example a fully qualified command is specified by also setting three optional parameters. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 47: Rules Of Target Reload (I.e. "On The Fly" Changes)

    DataDigest MaxRecvDataSegmentLength AuthMethod Auth_CHAP_Initiator Auth_CHAP_Target Auth_CHAP_ChallengeLength Auth_CHAP_Policy The following parameters SHOULD NOT be changed because only one valid value is supported: DataPDUInOrder (support only "Yes") DataSequenceInOrder (support only "Yes") Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 48: System Wide Parameters

    (irrelevant because IFMarker=No) 5.11. System Wide Parameters The Chelsio Global Entity Settings are system wide parameters that can be controlled through the configuration file or the use of the command line “ ”. The finer points of some of iscsictl -G these parameters are described in detail here: 5.11.1.

  • Page 49: Performance Tuning

    This string is used to verify the initiator name received, and identify if the initiator is running iscsi_chelsio_ini_idstr Chelsio drivers: if the initiator name contains the same substring as it is assumed the initiator is running with the Chelsio iscsi initiator driver and additional offload optimization is performed. 5.12.

  • Page 50: Firmware Update

    [root@host~]# chiscsi_set_affinity.sh 5.13. Firmware Update The T5 firmware is installed on the system, typically in /lib/firmware/cxgb4, and the driver will auto-load the firmware if an update is required. The kernel must be configured to enable userspace firmware loading support: Device Drivers -> Generic Driver Options -> Userspace firmware loading support The firmware version can be verified using ethtool: [root@host~]# ethtool -i <iface>...

  • Page 51: Software/Driver Unloading

    [root@host~]# scstadmin -force -noprompt -clear_config /etc/chelsio- iscsi/scst.conf iii. Stop all running targets: [root@host~]# iscsictl -s target=ALL iv. Unload the driver: [root@host~]# rmmod chiscsi_t4 [root@host~]# rmmod chiscsi_base [root@host]# modprobe –v –r chiscsi_t4 Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 52: Software/Driver Uninstallation

    Chapter 7. Software/Driver Uninstallation 7. Software/Driver Uninstallation Change your working directory to Chelsio-iSCSI-scst-x.x.x.x ii. Run the following command to uninstall the iSCSI Target driver: [root@host~]# make uninstall Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 53: Software/Driver Update

    Please visit Chelsio support web site http://service.chelsio.com/ for regular updates on various software/drivers. You can also subscribe to our newsletter for the latest software updates. Chelsio T5 iSCSI PDU Offload Target with SCST support for Linux...

  • Page 54: Appendix

    9.1. Troubleshooting Removing inbox driver from initramfs The following example describes the method to remove Chelsio inbox network driver (cxgb4) from initramfs. Similarly, other inbox drivers can be removed by using this procedure. Ensure that you are the root user.

  • Page 55: Chelsio End-User License Agreement (Eula)

    3. Ownership of Software. As Licensee, you own only the media upon which the Software is recorded or fixed, but Chelsio retains all right, title and interest in and to the Software and all subsequent copies of the Software, regardless of the form or media in or on which the Software may be embedded.
  • Page 56 Agreement by returning the Software. 8. Limitation of Liability. IN NO EVENT SHALL CHELSIO HAVE ANY LIABILITY TO YOU OR ANY THIRD...
  • Page 57 Agreement (by merger, operation of law or in any other manner) without the prior written consent of Chelsio and any attempt to do so without such consent shall be void and shall constitute a material breach of this Agreement.

Table of Contents