This patch adds more details to the QUICKSTART guide so that it includes kernel configuration and user space configuration.
I've also changed some formatting. The column width is now 80 characters. I cleaned up some grammatical errors and tried to add more helpful information when applicable. Signed-off-by: Robert Love <[email protected]> --- QUICKSTART | 171 +++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 files changed, 146 insertions(+), 25 deletions(-) diff --git a/QUICKSTART b/QUICKSTART index dffe24d..fd9af08 100644 --- a/QUICKSTART +++ b/QUICKSTART @@ -1,15 +1,70 @@ -This document is a quickstart guide for a user connected -to a Fibre Channel Forwarder (FCF) and not a SW target. -It covers the installation of Data Center Bridging (DCB), -the HBA API wrapper library, libhbalinux and fcoe-utils. +This document is a quickstart guide for a user connected to a Fibre Channel +Forwarder (FCF) and not a SW target. It covers the configuration of the kernel +and installation and configuration of Data Center Bridging (DCB), the HBA API +wrapper library, libhbalinux and fcoe-utils. + +This document was written using Fedora 11 as the installed operating system. +There are differences in where files exist in different distributions as well +as dependency differences. This guide will need to be adjusted for other +distributions. + ## -# Dependencies -############### +# Kernel Configuration and Compilation +###################################### + +1) Download kernel source + There are a number of good choices regarding the most appropriate + kernel source for your needs. fcoe-next.git is a repository that may be + unstable, but will have the latest code. Downloading a released kernel + from kernel.org will give you the most stable kernel, but you'll need to + get user space code that matches the kernel version you've chosen. You can + get user space code that matches stable kernels on the Open-FCoE.org + "Downloads" page or you can pull directly from the git repositories using + tags. + +2) Configure the kernel + # make menuconfig + + Select the following: + + Networking Support -> Networking Options + Data Center Bridging + 802.1Q VLAN Support + GVRP (GARP VLAN Registration Protocol) support + + Networking Support -> Networking Options -> QoS and/or fair queuing + Multi Band Priority Queueing (PRIO) + Hardware Multiqueue-aware Multi Band Queuing (MULTIQ) + Elementary classification (BASIC) + Universal 32bit comparisons w/ hashing (U32) + Extended Matches + U32 key + Actions + SKB Editing + + Device Drivers -> SCSI Device Support -> SCSI Low-level drivers + LibFC + LibFCoE + FCoE + + Device Drivers -> Network Device Support -> Ethernet (10000 Mbit) + Intel(R) 10GbE PCI Express adapters support + Data Center Bridging (DCB) Support -git://open-fcoe.org/openfc/hbaapi_build.git -git://open-fcoe.org/openfc/libhbalinux.git -git://open-fcoe.org/openfc/fcoe-utils.git + [ Replace with desired driver if not using Intel adapter. ] + + Exit Saving Changes + +3) Compile the kernel + # make && make modules_install && make install + + If you're going to build fcoe-utils, you can run 'make headers_install' + at this stage to skip a later step. + +4) Configure Grub + Change the default kernel so that this new kernel is used when booting + # reboot ## @@ -27,10 +82,10 @@ DEPENDENCIES PROCESS -1) Obtain the source tarball from sourceforge - http://sourceforge.net/projects/e1000/files/DCB%20Tools/0.9.19/dcbd-0.9.19.tar.gz/download +1) Obtain the latest source tarball from sourceforge under "DCB Tools" + http://sourceforge.net/projects/e1000/files/ -2) Untar the tarball and change into it's directory +2) Untar the tarball and change into its directory # tar -xvzf dcbd-x.y.z.tar.gz # cd dcbd-x.y.z/ @@ -60,10 +115,13 @@ DEPENDENCIES PROCESS -1) Obtain the source tarball from sourceforge +1) Obtain hbaapi_build source code from Open-FCoE.org + git://open-fcoe.org/openfc/hbaapi_build.git + +2) Obtain the source tarball from sourceforge http://sourceforge.net/projects/hbaapi/ -2) Untar the tarball and move its contents to hbaapi_build/ +3) Untar the tarball and move its contents to hbaapi_build/ and change into its directory # tar -xvzf hbaapi_src_2.2.tgz # mv hbaapi_src_2.2/* hbaapi_build/ @@ -94,7 +152,10 @@ DEPENDENCIES PROCESS -1) Bootstrap, configure, make and make install +1) Obtain the libhbalinux source code from Open-FCoE.org + git://open-fcoe.org/openfc/libhbalinux.git + +2) Bootstrap, configure, make and make install # ./bootstrap.sh # rpm --eval "%configure" | sh # make @@ -108,7 +169,9 @@ PROCESS DEPENDENCIES * libhbalinux -* dcbd (optional configure flag to build without) +* dcbd +(fcoe-utils can be compiled without dcbd support if you configure fcoe-utils +with the --without-dcb option, i.e. 'rpm --eval "%configure --without-dcb" | sh') * autoconf * autotools @@ -118,14 +181,16 @@ DEPENDENCIES PROCESS -1) Ensure correct header files - - fcping requires certain kernel header files to be exported - or it cannot be compiled. These header files were included - in the 2.6.31 Linux kernel. If you are using a distribution - kernel that is >= 2.6.31 then you shouldn't have to take - this step. If you are building your own kernel or are using - a pre-2.6.31 kernel you will need to take this step to - export the appropriate header files. +1) Obtain the fcoe-utils source code from Open-FCoE.org + git://open-fcoe.org/openfc/fcoe-utils.git + +2) Ensure correct header files + - fcping requires certain kernel header files to be exported or it + cannot be compiled. These header files were included in the 2.6.31 Linux + kernel. If you are using a distribution kernel that is >= 2.6.31 then you + shouldn't have to take this step. If you are building your own kernel or + are using a pre-2.6.31 kernel you will need to take this step to export + the appropriate header files. # pushd <kernel-src> # make headers_install @@ -134,8 +199,64 @@ PROCESS # ln -s $PWD/usr/include/scsi/fc /usr/include/scsi/fc # popd -2) Bootstrap, configure, make and make install +3) Bootstrap, configure, make and make install # ./bootstrap.sh # rpm --eval "%configure" | sh # make # make install + +## +# Example Configuration +####################### + +This example sets up a VLAN (101) for interface eth3 and configures the +system to automatically connect to storage over this interface. + +1) Create a VLAN + # cd /etc/sysconfig/network-scripts/ + # cp ifcfg-eth3 ifcfg-eth3.101 + Edit ifcfg-eth3.101 so the file has the following settings, + + DEVICE=eth3.101 + VLAN=yes + ONBOOT=yes + +2) Congigure fcoe for the VLAN + # cd /etc/fcoe/ + # cp cfg-ethx cfg-eth3.101 + +3) Start dcbd and configure the VLAN interface + # /etc/init.d/dcbd start + # dcbtool sc eth3 dcb on + # dcbtool sc eth3 pfc e:1 + # dcbtool sc eth3 app:fcoe e:1 + + As a convenience there is a script that will confirm if DCB has been + configured correctly for FCoE. The script is run as follows, + + <fcoe-utils source>/debug/dcbcheck.sh eth3 + (note: this is on the root device, not the VLAN) + + Follow the suggestions and repeatedly run the script until it states that + DCB is configured correctly. + +4) Start fcoe + # /etc/init.d/fcoe start + After a few moments your storage should apear (assuming everything is + configured correctly on the fabric) + +5) Setup dcbd and fcoe to start when booting + # chkconfig dcbd on + # chkconfig fcoe on + + +## +# Reporting Errors +################## + +Most steps cannot be skipped. Resolve issues before moving forward. + +Please run '<fcoe-utils-src>/debug/fcoedump.sh eth3.101 2>&1 > dump.out' +and provide the dump.out file with the bug report. Defects can be filed +against the distribution used, reported to the Ethernet vendor of the +card in use, or mailed to [email protected]. _______________________________________________ devel mailing list [email protected] http://www.open-fcoe.org/mailman/listinfo/devel
