xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-24 04:00:26 +00:00
Code Issues Releases Wiki Activity

Add Admonitions tags for the Network advanced sections

Browse Source
This commit is contained in:
Victor Hu
2018-05-09 14:22:35 -04:00
parent 15493a4d0b
commit 9d7354c03c
8 changed files with 24 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/advanced/networks/ethernet_switches/ethernet_switches.rst
View File

@@ -71,7 +71,7 @@ Running Remote Commands in Parallel
You can use xdsh to run parallel commands on Ethernet switches. The following shows how to configure xCAT to run xdsh on the switches:
**[Note]**:Configure the switch to allow **ssh** or **telnet**. This varies for switch to switch. Refer to the switch command references to find out how to do it.
.. note:: For this to work, configure the switch to allow **ssh** or **telnet**. The procedure varies from switch to switch, consult the reference guides for your switch to find out how to do this.
Add the switch in xCAT DB. Refer to the "Discovering Switches" section if you want xCAT to discover and define the switches for you. ::
@@ -97,7 +97,7 @@ Set the ssh or telnet username an d password. ::
xdsh bntc125 --devicetype EthSwitch::BNT "enable;configure terminal;vlan 3;end;show vlan"
Note that you can run multiple switch commands, they are separated by comma.
.. note:: You can run multiple switch commands, each command is comma separated.
Also note that --devicetype is used here. xCAT supports the following switch types out of the box: ::

8
docs/source/advanced/networks/infiniband/firmware_updates.rst
View File

@@ -21,7 +21,11 @@ Burn new firmware on each ibaX: ::
mstflint -d 0002:01:00.0 -i <image location> b
Note: if this is a PureFlex MezzanineP adapter then you must select the correct image for each ibaX device. Note the difference in the firmware image at end of filename: _0.bin (iba0/iba2) & _1.bin (iba1/iba3)
.. note:: If this is a PureFlex MezzanineP adapter, you must select the correct image for each ibaX device.
The difference in the firmware image at the end of the file name:
* _0.bin (iba0/iba2)
* _1.bin (iba1/iba3)
Verify download successful: ::
@@ -31,7 +35,7 @@ Activate the new firmware: ::
reboot the image
Note: the above 0002:01:00.0 device location was used as an example only. it is not meant to imply that there is only one device location or that your device will have the same device location.
.. note:: The above ``0002:01:00.0`` device location is used as an example only. Validate your device location using the ``lspci`` command.
Mellanox Switch Firmware Upgrade
--------------------------------

13
docs/source/advanced/networks/infiniband/mlnxofed_ib_install_v2_diskless.rst
View File

@@ -26,13 +26,16 @@ Diskless Installation
/install/postscripts/mlnxofed_ib_install \
-p /install/<path-to>/<MLNX_OFED_LINUX.iso> -i $1 -n genimage
*Note: The $1 is a argument that is passed to the the postinstall script at runtime.*
.. note:: The ``$1`` is a argument that is passed to the the postinstall script at runtime.
**[kernel mismatch issue]** The Mellanox OFED ISO is built against a series of specific kernel version. If the version of the linux kernel does not match any of the Mellanox offered pre-built kernel modules, you can pass the ``--add-kernel-support --without-32bit --without-fw-update --force`` arguments to the Mellanox installation script to build the kernel modules based on the version you are using. ::
.. tip:: **Kernel Mismatch**
The Mellanox OFED ISO is built against a series of specific kernel version. If the version of the linux kernel being used does not match any of the pre-built kernels, pass ``--add-kernel-support --without-32bit --without-fw-update --force`` to the Mellanox installation script to build the kernel modules based on the kernel you are using. Example: ::
/install/postscripts/mlnxofed_ib_install \
-p /install/<path-to>/<MLNX_OFED_LINUX.iso> -m --add-kernel-support --without-32bit --without-fw-update --force -end- \
-i $1 -n genimage
/install/postscripts/mlnxofed_ib_install \
-p /install/<path-to>/<MLNX_OFED_LINUX.iso> -m --add-kernel-support --without-32bit --without-fw-update --force -end- \
-i $1 -n genimage
#. Generate the diskless image

13
docs/source/advanced/networks/infiniband/switch_configuration.rst
View File

@@ -50,18 +50,7 @@ Then run the following: ::
rspconfig mswitch sshcfg=enable
**[Note]** For Mellanox switch in manufacturing defaults status, the user need to answer 'no' for the initial configuration wizard prompt as follows before run 'rspconfig'. ::
[s1mn][/](/)> ssh -l admin mswitch
Mellanox MLNX-OS Switch Management
Password:
Last login: Wed Feb 20 20:09:50 2013 from 1.2.3.4
Mellanox Switch
Mellanox configuration wizard
Do you want to use the wizard for initial configuration? **no**
To return to the wizard from the CLI, enter the "configuration jump-start"
command from configure mode. Launching CLI...
switch-xxxxxx [standalone: unknown] > exit
.. warning:: For Mellanox switch in manufacturing defaults, the user may need to log in once and answer **no** to the configuration wizard as ``rspconfig`` will fail when prompted against the wizard.
Setup syslog on the Switch
--------------------------

2
docs/source/advanced/networks/onie_switches/os_cumulus/install.rst
View File

@@ -4,7 +4,7 @@ Installation and Configuration
Cumulus OS Installtion
----------------------
**Note:** *The following assumes that the physical switches have power and have obtained a DHCP IP address from the xCAT open range.*
.. important:: The following assumes that the physical switches have power and have obtained a DHCP IP address from the xCAT open range.
xCAT provides support for detecting and installing the Cumulus Linux OS into ONIE enabled switches by utilizing DHCP to detect "**onie_vendor**" from the ``vendor-class-identifier`` string and then send it the Cumulus Linux OS installer.

4
docs/source/advanced/networks/onie_switches/os_cumulus/manage.rst
View File

@@ -32,7 +32,7 @@ xCAT will look for files in the above directory in the following order:
2. file name that matches the switch group name
3. file name that has the word 'default'
Note: If the postscript cannot find a configuration file on the MN, it will set all ports on the switch to be part of VLAN 1.
.. note:: If the postscript cannot find a configuration file on the MN, it will set all ports on the switch to be part of VLAN 1.
Execute the script using the following command: ::
@@ -44,7 +44,7 @@ Re-install OS
There may be occasions where a re-install of the Cumulus Linux OS is required. The following commands can be used to invoke the install:
**Note:** Assumption that the Cumulus Linux files are on the xCAT MN in the correct place.
.. important:: This assumes that the Cumulus Linux files are on the xCAT MN in the correct place.
* **Using xCAT**, ``xdsh`` can invoke the reinstall of the OS: ::

4
docs/source/advanced/networks/onie_switches/os_cumulus/upgrade.rst
View File

@@ -8,7 +8,7 @@ Full Install
Perform a full install from the ``.bin`` file of the new Cumulus Linux OS version, using ONIE.
**Note:** Make sure you back up all your data and configuration files as the binary install will erase all previous configuration.
.. important:: Make sure you back up all your data and configuration files as the binary install will erase all previous configuration.
#. Place the binary image under ``/install`` on the xCAT MN node.
@@ -22,7 +22,7 @@ Perform a full install from the ``.bin`` file of the new Cumulus Linux OS versio
xdsh switch1 "/usr/cumulus/bin/onie-install -a -f -i \
http://172.21.253.37/install/onie/cumulus-linux-3.4.1.bin && reboot"
**Note:** The full upgrade process may run 30 minutes or longer.
.. attention:: The full upgrade process may run 30 minutes or longer.
#. After upgrading, the license should be installed, see :ref:`Activate the License <activate-the-license>` for details.

4
docs/source/advanced/networks/vlan/vlan.rst
View File

@@ -53,7 +53,7 @@ For example: ::
This means port 42 of switch1 is connected to port 50 of switch2. And switch1 can be accessed using SNMP version 3 and switch 2 can be accessed using SNMP version 2.
Note: The **username** and the **password** on the switches table are NOT the same as SSH user name and password. You have to configure SNMP on the switch for these parameters and then fill up this table. Use **tabdump switches -d** command to find out the meaning of each column.
.. note:: The **username** and the **password** on the switches table are NOT the same as SSH user name and password. You have to configure SNMP on the switch for these parameters and then fill up this table. Use **tabdump switches -d** command to find out the meaning of each column.
**2. Populate the switch table**
@@ -148,7 +148,7 @@ For xCAT-vlan 2.7.5 and later versions, you can create vlans for other networks.
A tagged vlan will be created for the network that is on eth1 for node1, node2 and node3. For KVM clients, -i specifies the interface name on the KVM host that the vlan will be tagged on. If -i is omitted, the management networks will be assumed.
Note: After the vlan is created, the nodes can still be accessed by the mn using the management network. You can use **lsvan** command to list all the vlans.
.. note:: After the vlan is created, the nodes can still be accessed by the mn using the management network. You can use **lsvan** command to list all the vlans.
For example: ::