xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-21 18:50:28 +00:00
Code Issues Releases Wiki Activity

minor Formatting changes for the cumulus section

Browse Source
This commit is contained in:
Victor Hu
2017-02-06 10:07:42 -05:00
parent df7b859fc4
commit af0bd14071
5 changed files with 28 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/source/advanced/networks/onie_switches/index.rst
View File

@@ -3,9 +3,10 @@ Open Network Install Environment Switches
The Open Network Install Environment, or "ONIE" [1]_. is an open source project definining an **install environment** for bare metal switches. This environment allows choice for the end users when selecting a network operating system to install onto these bare metal switches.
.. [1] Open Network Install Environment: Created by Cumulus Networks, Inc. in 2012, the Open Network Install Environment (ONIE) Project is a small operating system, pre-installed as firmware on bare metal network switches, that provides an environment for automated operating system provisioning.
.. toctree::
:maxdepth: 2
os_cumulus/index.rst
.. [1] Open Network Install Environment: Created by Cumulus Networks, Inc. in 2012, the Open Network Install Environment (ONIE) Project is a small operating system, pre-installed as firmware on bare metal network switches, that provides an environment for automated operating system provisioning.

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

@@ -1,7 +1,7 @@
Cumulus Linux OS
================
This documentation will focus on installing the Cumulus Network Operating System (https://www.cumulusnetworks.com/) onto a "white-box" edge-core switch but the same concepts should apply to other ONIE enabled switches using other network OS.
This documentation will focus on installing the Cumulus Network Operating System (https://www.cumulusnetworks.com/) onto a "white-box" Edgecore switch but the same concepts should apply to other ONIE enabled switches using other network operating systems.
.. toctree::

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

@@ -4,22 +4,23 @@ Installation and Configuration
Cumulus OS Installtion
----------------------
The following assumes that the physical switches have power and have obtained a DHCP IP address from the xCAT open range.
**Note:** *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 sends it the Cumulus Linux OS.
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.
#. Create a pre-defined switch definition for the ONIE switch using the ``onieswitch`` template.
The mac address of the switch management port is required for xCAT to configure the DHCP information and send over the OS to install on the switch.
For smaller clusters, if you know the mac address of the management port on the switch, simply create the pre-defined switch defintion providing the mac address: ::
**[small clusters]** If you know the mac address of the management port on the switch, create the pre-defined switch defintion providing the mac address. ::
mkdef switch01 --template onieswitch arch=armv71 \
ip=192.168.1.1 mac="aa:bb:cc:dd:ee:ff"
For large clusters, xCAT's :doc:`switchdiscover </guides/admin-guides/references/man1/switchdiscover.1>` command can be used to discover the mac address and fill in the predefined switch definitions based on the switch/switchport mapping.
**[large clusters]** xCAT's :doc:`switchdiscover </guides/admin-guides/references/man1/switchdiscover.1>` command can be used to discover the mac address and fill in the predefined switch definitions based on the switch/switchport mapping.
#. Define the switch objects ::
#. Define all the switch objects providing the switch/switchport mapping: ::
mkdef switch01 --template onieswitch arch=armv71 \
ip=192.168.1.1 switch=coresw1 switchport=1
@@ -31,7 +32,7 @@ xCAT provides support for detecting and installing the Cumulus Linux OS into ONI
ip=192.168.4.1 switch=coresw1 switchport=4
...
#. Leverage ``switchdiscover`` over the DHCP range to detect the MAC addrees and write them into the predefined swtiches above. ::
#. Leverage ``switchdiscover`` over the DHCP range to automatically detect the MAC address and write them into the predefined swtiches above. ::
switchdiscover --range <IP range>
@@ -44,14 +45,14 @@ xCAT provides support for detecting and installing the Cumulus Linux OS into ONI
makedhcp -a <switch>
At this point, the DHCPREQUEST from the switch should get the Cumulus Linux OS as a response and begin the installation.
Normal Installation time is around 1 hour.
At this point, the DHCPREQUEST from the switch should now get a response with the Cumulus Linux OS and begin the network installation. *(Normal installation time for Cumulus Linux is 1 hour)*
Configure xCAT Remote Commands
------------------------------
After Cumulus Linux OS is installed, a default user ``cumulus`` will be created. The default password is: ``CumulusLinux!``.
After Cumulus Linux OS is installed, a default user ``cumulus`` will be created with default password: ``CumulusLinux!``.
To ease in the management of the switch, xCAT provides a script to help configure password-less ssh as the ``root`` user. This script sends over the xCAT ssh keys so that the xCAT remote commands (``xdsh``, ``xdcp``, etc) can be run against the ONIE switches.
@@ -67,26 +68,28 @@ After Cumulus Linux OS is installed onto the ONIE switch, only the serial port c
#. Copy the license file to the switch: ::
xdcp <switch> /install/custom/sw_os/cumulus/licensefile.txt /root/
xdcp <switch> /install/custom/sw_os/cumulus/licensefile.txt /root/
#. Activate the license: ::
xdsh <switch> "/usr/cumulus/bin/cl-license -i /root/licensefile.txt"
xdsh <switch> "/usr/cumulus/bin/cl-license -i /root/licensefile.txt"
#. Verify that the license file is successfully installed: ::
xdsh <switch> /usr/cumulus/bin/cl-license
xdsh <switch> /usr/cumulus/bin/cl-license
Output should be similar to: ``<switch> xxx@xx.com|xxxxxxxxxxxxxxx``
Output should be similar to: ``<switch> xxx@xx.com|xxxxxxxxxxxxxxx``
#. Reboot the switch to apply the license file: ::
xdsh <switch> reboot
xdsh <switch> reboot
Enable SNMP (optional)
----------------------
To enable ``snmpd``, execute the ``enablesnmp`` postscript on the switch: ``updatenode <switch> -P enablesnmp``.
To enable ``snmpd``, execute the ``enablesnmp`` postscript on the switch: ::
updatenode <switch> -P enablesnmp

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

@@ -10,12 +10,11 @@ Re-install OS
There may be occasions where a re-install of the OS is required. Assuming the files are available on the xCAT management node, the following commands will invoke the install process:
**Manually:** Log into the Cumulus OS switch and run the following commands: ::
sudo onie-select -i
sudo reboot
**Using xCAT:** ``xdsh`` can be used to invoke the reinstall of the OS: ::
* **[use xCAT]** ``xdsh`` can be used to invoke the reinstall of the OS: ::
xdsh <switch> "/usr/cumulus/bin/onie-select -i -f;reboot"
* **[manually]** Log into the Cumulus OS switch and run the following commands: ::
sudo onie-select -i
sudo reboot

1
docs/source/advanced/networks/onie_switches/os_cumulus/prepare.rst
View File

@@ -7,6 +7,7 @@ Prepare the Cumulus Linux files on the xCAT Management Node.
#. Copy the above files into a location under the xCAT ``/install`` directory. ::
# Create a directory to hold the cumulus linux files
mkdir -p /install/custom/sw_os/cumulus/
# copy the license file