diff --git a/docs/source/advanced/networks/infiniband/driver_and_installation.rst b/docs/source/advanced/networks/infiniband/driver_and_installation.rst deleted file mode 100644 index d9d10a596..000000000 --- a/docs/source/advanced/networks/infiniband/driver_and_installation.rst +++ /dev/null @@ -1,11 +0,0 @@ -IB Driver Preparation and Installation -====================================== - -xCAT provides sample postscripts to help you install the Mellanox OpenFabrics Enterprise Distribution (OFED) InfiniBand Driver. These scripts are located in ``opt/xcat/share/xcat/ib/scripts/Mellanox/``. You can use these scripts directly or change them to satisfy your own environment. **xCAT 2.11 drops support of mlnxofed_ib_install and recommends using version 2 of the script: mlnxofed_ib_install.v2**. - -.. toctree:: - :maxdepth: 2 - - mlnxofed_ib_install_v2_usage.rst - mlnxofed_ib_install_v1_usage.rst - diff --git a/docs/source/advanced/networks/infiniband/index.rst b/docs/source/advanced/networks/infiniband/index.rst index c525d6c95..cb92a7045 100644 --- a/docs/source/advanced/networks/infiniband/index.rst +++ b/docs/source/advanced/networks/infiniband/index.rst @@ -1,13 +1,18 @@ InfiniBand (Mellanox) ===================== -xCAT offers a certain degree support for Mellanox InfiniBand product, it help you to configurate Mellanox InfiniBand products easily. For more information about Mellanox InfiniBand, please refer to `Mellanox official site `_. +xCAT has the ability to help with Mellanox InfiniBand (IB) adapter installation and network configuration as part of the node provisioning process. + .. toctree:: :maxdepth: 2 - driver_and_installation.rst + mlnxofed_ib_install_v2.rst network_configuration.rst switch_configuration.rst ufm_configuration.rst firmware_updates.rst + + + +For more information about Mellanox products, refer to http://www.mellanox.com. diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_diskful.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_diskful.rst deleted file mode 100644 index 37da6def7..000000000 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_diskful.rst +++ /dev/null @@ -1,53 +0,0 @@ -Configuration for Diskful Installation -====================================== - -1. Set script ``mlnxofed_ib_install`` as postbootscript :: - - chdef -p postbootscripts=mlnxofed_ib_install - -2. Specify dependence package **[required for RHEL and SLES]** - - a) Copy the pkglist to the custom directory :: - - cp /opt/xcat/share/xcat/install//compute...pkglist \ - /install/custom/install//compute...pkglist - - b) Edit your /install/custom/install//compute...pkglist and add one line:: - - #INCLUDE:/opt/xcat/share/xcat/ib/netboot//ib...pkglist# - - c) Make the related osimage use the customized pkglist :: - - chdef -t osimage -o --install-compute \ - pkglist=/install/custom/install//compute...pkglist - - Take RHEL 6.4 on x86_64 for example :: - - cp /opt/xcat/share/xcat/install/rh/compute.rhels6.x86_64.pkglist \ - /install/custom/install/rh/compute.rhels6.x86_64.pkglist - - Edit the ``/install/custom/install/rh/compute.rhels6.x86_64.pkglist`` and add below line - ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist#`` - - Then ``/install/custom/install/rh/compute.rhels6.x86_64.pkglist`` looks like below :: - - #Please make sure there is a space between @ and group name - #INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist# - ntp - nfs-utils - net-snmp - rsync - yp-tools - openssh-server - util-linux-ng - - Then modify related osimage :: - - chdef -t osimage -o rhels6.4-x86_64-install-compute \ - pkglist=/install/custom/install/rh/compute.rhels6.x86_64.pkglist - -3. Install node :: - - nodeset osimage=--install-compute - rsetboot net - rpower reset diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_diskless.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_diskless.rst deleted file mode 100644 index fd1173186..000000000 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_diskless.rst +++ /dev/null @@ -1,77 +0,0 @@ -Configuration for Diskless Installation -======================================= - -1. Specify dependence package **[required for RHEL and SLES]** - - a) Copy a correct pkglist file **shipped by xCAT** according your environment to the ``/install/custom/netboot//`` directory :: - - cp /opt/xcat/share/xcat/netboot//compute...pkglist \ - /install/custom/netboot//compute...pkglist - - b) Edit your ``/install/custom/netboot//.pkglist`` and add one line ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot//ib...pkglist#`` - - Take RHEL 6.4 on x86_64 for example :: - - cp /opt/xcat/share/xcat/netboot/rh/compute.rhels6.x86_64.pkglist \ - /install/custom/netboot/rh/compute.rhels6.x86_64.pkglist - - Edit the ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` and add below line - ``#INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist#`` - - Then ``/install/custom/netboot/rh/compute.rhels6.x86_64.pkglist`` looks like below :: - - #INCLUDE:/opt/xcat/share/xcat/ib/netboot/rh/ib.rhels6.x86_64.pkglist# - bash - nfs-utils - openssl - dhclient - ..... - - -2. Prepare postinstall scripts - - a) Specify postinstall script **shipped by xCAT** :: - - mkdir -p /install/custom/netboot// - - cp /opt/xcat/share/xcat/netboot//.postinstall \ - /install/custom/netboot// - - chmod +x /install/custom/netboot//.postinstall - - Take RHEL 6.4 on x86_64 for example :: - - mkdir -p /install/custom/netboot/rh/ - cp /opt/xcat/share/xcat/netboot/rh/compute.rhels6.x86_64.postinstall \ - /install/custom/netboot/rh/ - chmod +x /install/custom/netboot/rh/compute.rhels6.x86_64.postinstall - - b) Edit ``/install/custom/netboot//.postinstall`` and add below line in the end: :: - - installroot=$1 ofeddir=/install/post/otherpkgs///ofed/ \ - NODESETSTATE=genimage mlnxofed_options=--force /install/postscripts/mlnxofed_ib_install - - -3. Set the related osimage use the customized pkglist and customized compute.postinsall - -* [RHEL/SLES] :: - - chdef -t osimage -o --netboot-compute \ - pkglist=/install/custom/netboot//compute...pkglist \ - postinstall=/install/custom/netboot//.postinstall - -* [Ubuntu] :: - - chdef -t osimage -o --netboot-compute \ - postinstall=/install/custom/netboot//.postinstall - -4. Generate and package image for diskless installation :: - - genimage --netboot-compute - packimage --netboot-compute - -5. Install node :: - - nodeset osimage=--netboot-compute - rsetboot net - rpower reset diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_preparation.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_preparation.rst deleted file mode 100644 index 340871bef..000000000 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_preparation.rst +++ /dev/null @@ -1,42 +0,0 @@ -Preparation -=========== - -Obtain the Mellanox OFED ISO file from `Mellanox official site `_ and mount it onto suggested target location on the xCAT MN according your OS and ARCH: :: - - mkdir -p /install/post/otherpkgs///ofed - - mount -o loop MLNX_OFED_LINUX----.iso \ - /install/post/otherpkgs///ofed - -Take sles11 sp1 for x86_64 as an example :: - - mkdir -p /install/post/otherpkgs/sles11.1/x86_64/ofed/ - - mount -o loop MLNX_OFED_LINUX-1.5.3-3.0.0-sles11sp1-x86_64.iso \ - /install/post/otherpkgs/sles11.1/x86_64/ofed/ - - -Take Ubuntu14.4.1 for Power8 LE as an example :: - - mkdir -p /install/post/otherpkgs/ubuntu14.04.1/ppc64el/ofed - - mount -o loop MLNX_OFED_LINUX-2.3-1.0.1-ubuntu14.04-ppc64le.iso \ - /install/post/otherpkgs/ubuntu14.04.1/ppc64el/ofed - - -**[NOTE]** - -* Mellanox provides OFED files with **tarball** and **ISO** two format, but for xCAT, we just support **ISO** format right now. - -Copy Sample script **mlnxofed_ib_install** shipped by xCAT into ``/install/postscripts`` before using, such as :: - - cp /opt/xcat/share/xcat/ib/scripts/Mellanox/mlnxofed_ib_install \ - /install/postscripts/mlnxofed_ib_install - -The **mlnxofed_ib_install** invokes a script ``mlnxofedinstall`` shipped by Mellanox OFED ISO. If you want to pass the argument to ``mlnxofedinstall``, you set the argument to the environment variable ``mlnxofed_options`` which could be read by **mlnxofed_ib_install**. For example: PPE requires the 32-bit version of libibverbs, but the default **mlnxofed_ib_install** will remove all the old ib related packages at first including the 32-bit version of libibverbs. In this case, you can set the environment variable ``mlnxofed_options=--force`` when running the **mlnxofed_ib_install**. For diskful, you should put the environment variable ``mlnxofed_options=--force`` in mypostscript.tmpl. myposcript.tmpl is in ``/opt/xcat/share/xcat/templates/mypostscript/`` by default. When customize it, you should copy it into ``/install/postscripts/myposcript.tmpl`` :: - - mlnxofed_options='--force' - export mlnxofed_options - - - \ No newline at end of file diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_usage.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_usage.rst deleted file mode 100644 index 79577bdbd..000000000 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v1_usage.rst +++ /dev/null @@ -1,9 +0,0 @@ -Using mlnxofed_ib_install (drops support) -========================================= - -.. toctree:: - :maxdepth: 1 - - mlnxofed_ib_install_v1_preparation.rst - mlnxofed_ib_install_v1_diskful.rst - mlnxofed_ib_install_v1_diskless.rst \ No newline at end of file diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2.rst new file mode 100644 index 000000000..493ab2b95 --- /dev/null +++ b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2.rst @@ -0,0 +1,14 @@ +Mellanox OFED Installation Script +================================= + +Mellanox provides a tested and packaged version of the OpenFabrics Enterprise Distribution (OFED) driver, named Mellanox OFED (MLNX_OFED). To assist with the installation of the MLNX_OFED driver, xCAT provids a sample postscript: ``mlnxofed_ib_install.v2``. + +.. toctree:: + :maxdepth: 2 + + mlnxofed_ib_install_v2_preparation.rst + mlnxofed_ib_install_v2_diskful.rst + mlnxofed_ib_install_v2_diskless.rst + mlnxofed_ib_verified_scenario_matrix.rst + mlnxofed_ib_known_issue.rst + diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_usage.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_usage.rst deleted file mode 100644 index 52d500fb3..000000000 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_usage.rst +++ /dev/null @@ -1,12 +0,0 @@ -Using mlnxofed_ib_install.v2 (Recommend) -========================================= - -.. toctree:: - :maxdepth: 1 - - mlnxofed_ib_install_v2_preparation.rst - mlnxofed_ib_install_v2_diskful.rst - mlnxofed_ib_install_v2_diskless.rst - mlnxofed_ib_verified_scenario_matrix.rst - mlnxofed_ib_known_issue.rst -