scottk/OpenNetworkLinux
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/OpenNetworkLinux.git synced 2026-01-08 16:21:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

modified BootProcess and GettingStarted

Browse Source
This commit is contained in:
Steven Noble
2015-12-17 13:27:18 -08:00
parent 0b8176ccfe
commit 837b921832
2 changed files with 273 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
docs/BootProcess.md Normal file
View File

@@ -0,0 +1,95 @@
Summary
---------
The high-level boot process for ONL is fairly straight forward, but there is a lot detail.
At high-level, there are three phases
1. uBoot phase
2. the ONL Loader phase
3. The final ONL operating system
Detailed Boot Process
--------------------------
1. uBoot is the first level boot loader: http://www.denx.de/wiki/U-Boot
2. uBoot reads the 'nos_bootcmd' environmental variable from flash and runs the contents
('nos' is Network Operating System)
4. If $nos_boot_cmd returns, uBoot loads and runs ONIE (see below) to download the ONL installer and install the ONL loader
a) The factory default $nos_boot_cmd is to a trival command that returned immediately, e.g., 'echo'
5. In normal operation, i.e., after ONIE has been run, $nos_boot_cmd is set to load and run the ONL Loader
6. The ONL loader boots the Linux kernel (later, the "boot kernel")
7. The ONL loader decides which SWI to run based on the URL in the file /etc/SWI
URL=`cat /etc/SWI`
8. The ONL loader runs `/bin/boot $URL`
9. The ONL loader retrieves the SWI file
a) if the URL is remote (e.g., http://, ftp://, etc.), verify that there is a locally cached copy
of the SWI in /mnt/flash2 or if not, download it
b) if the URL is local, verify that the device is accessible
c) if the URL is a Zero Touch Networking (ZTN) URL, the execute the ZTN protocol to get the SWI (see below)
10. The ONL loader reads the 'rootfs' file out of the SWI and mounts it using overlayfs[1] (SWI contents described below)
Partition Layout
------------------
Switches typically have two flash storage device: a smaller flash (e.g.,
64MB flash) for booting and a larger, mass storage device (e.g., compact
flash, 2+GB).
Smaller Boot Flash:
Partition 1: uBoot
Partition 2: environmental variables (e.g., $nos_boot_cmd)
Partition 3: ONIE
Partition 4+: Free space (unused)
Mass Storage Device:
Partition 1: ONL loader kernel -- the format of this partition varies depending on what formats uBoot supports on the specific platform
Partition 2: ONL Loader configuration files (mounts as "/mnt/flash" both during the loader and the main ONL phases)
Partition 3: ONL SWitch Images (SWIs) partition (mounts as "/mnt/flash2" both during the loader and the main ONL phases)
ONL file system layout
-----------------------
root@onl-powerpc:/bin# df
Filesystem 1K-blocks Used Available Use% Mounted on
rootfs 72040 176 71864 1% /
devtmpfs 1024 0 1024 0% /dev
none 72040 176 71864 1% /
tmpfs 48028 148 47880 1% /run
tmpfs 5120 0 5120 0% /run/lock
/dev/sda2 71177 7 71170 1% /mnt/flash
/dev/sda3 3791960 98172 3693788 3% /mnt/flash2
tmpfs 96040 0 96040 0% /run/shm
SWI
--------
Zip file contains:
$ unzip -l ONL-2.0.0_ONL-OS_2015-12-12.0252-ffce159_PPC.swi
Archive: ONL-2.0.0_ONL-OS_2015-12-12.0252-ffce159_PPC.swi
Length Date Time Name
--------- ---------- ----- ----
97968128 2015-12-15 20:20 rootfs-powerpc.sqsh
1063 2015-12-15 20:20 manifest.json
--------- -------
97969191 2 files
1. 'rootfs-$ARCH' : the root file system for the running ONL
2. 'manifest.json' : a list of supported platforms, version information about ONL and the architecture
Footnotes
-----------
[1] : https://kernel.googlesource.com/pub/scm/linux/kernel/git/mszeredi/vfs/+/overlayfs.current/Documentation/filesystems/overlayfs.txt

178
docs/GettingStarted.md Normal file
View File

@@ -0,0 +1,178 @@
Getting Started
------------------------------------------------
To install and run ONL you need is an ONL Compatible switch (see
http://opennetlinux.org/hcl) and the ONL installer binary. Every
ONL compatible switch ships with the ONIE installer environment installed
which gives you a multitude of ways of getting ONL installed on your switch.
We document the easiest ways here (manual install via console and NFS)
but the http://onie.org website contains a variety of installation
methods including via USB, over the network, and even via ssh.
The resulting installation has a default account ("root") with a default
password ("onl"). The network interface is disabled by default so that
you can change the root password before the system comes up.
ONL Manual Install
------------------------------------------------
1) Attach a serial terminal to the switch
2) Boot switch and hit return to go to ONIE''s interactive mode
2a) You must wait until after uboot has finished loading; if you
accidentally interupt uboot first, just run `boot` to continue
booting into ONIE
3) Download the ONL installer from http://opennetlinux.org and run it by hand
Expected Serial Console Output (from an QuantaMesh LB9, other switches ouput will vary):
U-Boot 2010.12 (Oct 08 2013 - 17:11:37)
CPU: 8541, Version: 1.1, (0x80720011)
Core: Unknown, Version: 2.0, (0x80200020)
Clock Configuration:
CPU0:825 MHz,
CCB:330 MHz,
DDR:165 MHz (330 MT/s data rate), LBC:41.250 MHz
CPM: 330 MHz
L1: D-cache 32 kB enabled
I-cache 32 kB enabled
I2C: ready
DRAM: Detected UDIMM TS128MSD64V3A
Detected UDIMM(s)
DDR: 1 GiB (DDR1, 64-bit, CL=2.5, ECC off)
FLASH: 64 MiB
L2: 256 KB enabled
LB9 U-Boot
Product Name : LB9
Model Name : QUANTA LB9
Serial Number : QTFCA63280001
Part Number : 1LB9BZZ0STQ
Label Revision Number : 1
Hardware Version : 1.0
Platform Version : 0xb901
Release Date : 2013/7/5
MAC Address : 08:9e:01:ce:bd:2d
Set ethaddr MAC address = 08:9e:01:ce:bd:2d
In: serial
Out: serial
Err: serial
Net: TSEC0: PHY is Broadcom BCM5461S (2060c1)
TSEC0
IDE: Bus 0: OK
Device 0: Model: 4GB CompactFlash Card Firm: Ver6.04J Ser#: CDE207331D0100001484
Type: Hard Disk
Capacity: 3811.9 MB = 3.7 GB (7806960 x 512)
Hit any key to stop autoboot: 0
## Error: "nos_bootcmd" not defined
Loading Open Network Install Environment ...
Platform: powerpc-quanta_lb9-r0
Version : 1.5.2-20131008154633
WARNING: adjusting available memory to 30000000
## Booting kernel from Legacy Image at 04000000 ...
Image Name: quanta_lb9-r0
Image Type: PowerPC Linux Multi-File Image (gzip compressed)
Data Size: 3479390 Bytes = 3.3 MiB
Load Address: 00000000
Entry Point: 00000000
Contents:
Image 0: 2762740 Bytes = 2.6 MiB
Image 1: 707380 Bytes = 690.8 KiB
Image 2: 9254 Bytes = 9 KiB
Verifying Checksum ... OK
## Loading init Ramdisk from multi component Legacy Image at 04000000 ...
## Flattened Device Tree from multi component Image at 04000000
Booting using the fdt at 0x434f378
Uncompressing Multi-File Image ... OK
Loading Ramdisk to 2ff53000, end 2ffffb34 ... OK
Loading Device Tree to 03ffa000, end 03fff425 ... OK
Cannot reserve gpages without hugetlb enabled
setup_arch: bootmem
quanta_lb9_setup_arch()
arch: exit
ONIE: Using DHCPv4 addr: eth0: 10.7.1.10 / 255.254.0.0
discover: installer mode detected. Running installer.
Please press Enter to activate this console. ONIE: Using DHCPv4 addr: eth0: 10.7.1.10 / 255.254.0.0
ONIE: Starting ONIE Service Discovery
To check the install status inspect /var/log/onie.log.
Try this: tail -f /var/log/onie.log
Now press RETURN here to jump into ONIE''s manual installer mode. You should see:
** Installer Mode Enabled **
ONIE:/ #
Then simply download the latest ONL installer for the appropriate
architecture (powerpc or amd64) from the website and run it.
ONIE:/ # install_url http://opennetlinux.org/binaries/latest-amd64.installer
ONIE:/ # install_url http://opennetlinux.org/binaries/latest-powerpc.installer
Connecting to opennetlinux.org (107.170.237.53:80)
Open Network Installer running under ONIE.
Installer Version: Open Network Linux e148b7a (powerpc.all,2014.05.21.18.57,e148b7a90131c07eb8d49f74316baf8f2aae92c6)
Detected platform: powerpc-quanta-lb9-r0
Installing in standalone mode.
Unpacking Open Network Linux installer files...
onl.powerpc-as4600-54t.loader
onl.powerpc-as5600-52x.loader
...
ONL NFS Root Directory
------------------------------------------------
Given that the default installation of ONL does not persist files across
reboots (this is intentional -- flash disks should not be written to
as often as spinning disks), it is sometimes useful to have a normally
writable, larger disk available for the switch. Enter the NFS root
directory which enables a switch to boot ONL from a remote NFS partition.
While it is possible to simply fetch the SWI file from an NFS server
(keeping the same non-persisted behavior), the much more useful feature
is to have the root file system NFS hosted.
To enable NFS mounted root partition:
1) Run the ONL installer normally (e.g., via the manual mode per above) so that the ONL
loader is installed.
2) Edit /mnt/flash/boot-config, enable DHCP, and change the SWI variable to point to a URL of the form "nfs://$ip[:port]/path/to/directory/". For example, on my machine, this looks like:
# cat /mnt/flash/boot-config
SWI=nfs://10.6.0.4/home/robs/export/ly2-1/ # trailing '/' is critical
NETAUTO=dhcp # optional, but likely what you want
NETDEV=ma1 # leave untouched
3) On server $ip, in /path/to/directory, unzip a target .SWI file, e.g.,
# wget http://opennetlinux.org/binaries/latest.swi
# unzip latest.swi
4) unsquash the compressed root file system as directory 'rootfs-$arch':
# unsquashfs -d rootfs-$arch rootfs-$arch.sqsh # e.g., $arch = 'powerpc'h
Now reboot your switch and it should boot automatically into the NFS root file system.
Note that the SWI structure is still maintained:
robs@sbs3:~/export/ly2-1$ ls -l
total 109048
-rw-r--r-- 1 robs __USERS__ 3382017 Nov 4 22:28 initrd-powerpc
-rwxr-xr-x 1 robs __USERS__ 6942960 Nov 4 22:28 kernel-85xx*
-rw-r--r-- 1 robs __USERS__ 101322752 Nov 4 22:28 rootfs-powerpc.sqsh
drwxrwxr-x 22 robs __USERS__ 4096 Jan 2 18:21 rootfs-powerpc/
-rw-r--r-- 1 robs __USERS__ 100 Nov 4 22:29 version
That is:
* 'kernel-85xx' is the kernel image
* 'initrd-powerpc' is the initial RAM disk image
* 'rootfs-powerpc' is the base of the root filesystem
* 'version' is a string that identifies this SWI
Note: If NFS root squash is set on the server, you might get a permission error while booting. To fix this, you can set 'no_disable_squash' in /etc/exports. However, be aware of the security implications as root on a client machine will now have the same access privilege on the files as root on the NFS server.