Differences

This shows you the differences between two versions of the page.

--- documentation:end-users_docs [2019/11/08 15:02] – [From BSDRP directly] olivier
+++ documentation:end-users_docs [2024/10/18 01:31] (current) – [Installation] olivier
@@ Line 4: / Line 4: @@
 ===== Hardware Compatibility List =====
-For BSDRP you need:
+To run BSDRP, you will need:
-  * a 2GB flash disk (Compact Flash, USB stick, mSATA flash module, etc.).
+  * A 4GB flash disk (such as Compact Flash, USB stick, or mSATA module).
-  * a minimum of 512MB RAM.
+  * At least 1GB of RAM.
-[[https://www.freebsd.org/releases/12.0R/hardware.html|All hardware supported by FreeBSD 12]] are supported by BSDRP with the exception of following drivers:
+All hardware supported by the latest FreeBSD release is compatible with BSDRP, except for some drivers that have been removed (e.g., wireless, PCMCIA, SCSI, USB printer, and FireWire).
-Wireless, PCMCIA cards, SCSI adapters, USB printer, fire wire, etc. drivers were removed from the FreeBSD kernel.
 ===== Filename convention =====
-The BSDRP images use this filename convention:
+BSDRP image filenames follow this pattern:
 BSDRP_//release//_//image type//_//arch//_//console//.img.xz
 The value //image type// can be:
-  * full : To be used for installing BSDRP. This image contain full BSDRP filesystem (bootloader, 2 systems partitions, cfg partition and data partition)
+  * full : For full installation, includes the bootloader, system, and data partitions.
-  * upgrade : To be used for upgrading BSDRP. This image contain only one system partition.
+  * upgrade : For system upgrades, includes only one system partition
 The value //arch// can be:
-  * i386 : for i486, i586 and i686 CPU
+  * i386 : For older x86 CPUs (i486, i586, i686).
-  * amd64 : for all x86-64 CPU (amd64 or intel 64)
+  * amd64 : For modern x86 64-bit CPUs (Intel and AMD)
 The value //console// can be:
-  * vga: To be used with a vga card and keyboard as default console (but it's still possible to connect to the serial port)
+  * vga: For VGA and keyboard use or KVM, but serial port is also accessible.
-  * serial: For headless use, use only serial port as default console
+  * serial: For headless systems using only the serial port.
 Examples:
-  * BSDRP_0.3_full_i386_vga.img, means full image, for arch i386, with keyboard/vga as console.
+  * BSDRP_0.3_full_i386_vga.img: Full image for i386, VGA console.
-  * BSDRP_0.3_upgrade_amd64_serial.img, means upgrade image, for arch amd64 on headless serial.
+  * BSDRP_0.3_upgrade_amd64_serial.img: Upgrade image for amd64, serial console.
 The *.mtree.xz files are used for system integrity check.
@@ Line 41: / Line 39: @@
 == Windows users ==
-Here are the 2 steps for writing the image to a CF/USB removable media:
+Here are the 2 steps for writing the image to a CF/flasg/USB removable media:
-  - Decompress the BSDRP image file [[http://www.7-zip.org/|7-Zip]]: You need to obtain a file with .img extension.
+  - Decompress the BSDRP image using [[http://www.7-zip.org/|7-Zip]] to get a .img file.
-  - Use [[http://win32diskimager.sourceforge.net/|Image Writer for Windows]] for writing the image file .img (**and not the file with .xz extension**) on your CF/USB connected to your PC.
+  - Use [[http://win32diskimager.sourceforge.net/|Image Writer for Windows]] to write the .img file to your CF/flash/USB device.
 == *BSD or Linux users ==
-Connect your Compact Flash or USB disk and write down the device name (can be 'sd4' for an usb key under Linux or 'da0' under FreeBSD as exemple).
+Connect your flash or USB drive and note its device name.
+Decompress the image and copy it to your drive using a byte copy command.
-Then unzip the file and byte copy it to your drive (**Warning: Double check that you had choosen the good destination disk!!!**):
+Then unzip the file and byte copy it to your drive (**Warning: Be sure to double-check the destination disk!**):
 <code>
 xzcat BSDRP_full_amd64_vga.1.0.img.xz | dd of=/dev/sd4 bs=256k
@@ Line 58: / Line 56: @@
 == Mac OS X users ==
-Insert the USB key, and run mount in a terminal (or disk utility if you prefer graphical method) to see what device OSX has assigned to your USB key. You should see something like this:
+Insert the USB key, and display list of external devices:
+<code>
+% diskutil list | grep external
+/dev/disk3 (external, physical):
+</code>
+Check if it is already mounted
 <code>
+% mount | grep '/dev/disk3'
 /dev/disk0s2 on / (hfs, local, journaled)
 devfs on /dev (devfs, local)
@@ Line 68: / Line 74: @@
 /dev/disk3s1 on /Volumes/UNTITLED (msdos, local, nodev, nosuid, noowners)
 </code>
-The last line is your USB device. Unmount it and write the BSDRP image to it with:
+The last line is your USB device. Unmount it and write the BSDRP image to the device adding the 'r' letter:
 <code>
 sudo umount -f /dev/disk3s1
-xzcat BSDRP_full_amd64_vga.1.0.img.xz | dd of=/dev/disk3 bs=256k
+xzcat BSDRP_full_amd64_vga.1.0.img.xz | sudo dd of=/dev/rdisk3 bs=1m
 </code>
-If successful, OSX will pop up an error dialog telling you it doesn't recognize the disk. Click 'Eject', remove the USB key, and you're done.
+If successful, OSX will pop up an error dialog telling you it doesn't recognise the disk. Click 'Eject', remove the USB key, and you're done.
 === To an hard drive ===
@@ Line 410: / Line 416: @@
 BSDRP v1.4 and earlier have a default configuration that prevent remote syslog. This behavior can be changed by editing /etc/rc.conf.misc and replacing syslogd_flags="-ss" by syslogd_falgs="-s"
 </note>
+==== Firmware Upgrade ====
+=== Mellanox ===
+Stat by identifying your NIC ID:
+<code>
+# mstfwmanager
+Querying Mellanox devices firmware ...
+Device #1:
+----------
+  Device Type:      ConnectX4
+  Part Number:      MCX416A-CCA_Ax
+  Description:      ConnectX-4 EN network interface card; 100GbE dual-port QSFP28; PCIe3.0 x16; ROHS R6
+  PSID:             MT_2150110033
+  PCI Device Name:  pci0:2:0:0
+  Base GUID:        e41d2d0300fdbd90
+  Base MAC:         e41d2dfdbd90
+  Versions:         Current        Available
+     FW             12.26.1040     N/A
+     PXE            3.5.0803       N/A
+     UEFI           14.19.0014     N/A
+  Status:           No matching image found
+</code>
+Then go to the [[https://www.mellanox.com/page/firmware_download|Mellanox firmware web site]] in section "Device Type" -> "Part Number" -> "PSID", then fetch it into your BSDRP and upgrade it:
+<code>
+# mount /data
+# cd /data
+# fetch http://www.mellanox.com/downloads/firmware/fw-ConnectX4-rel-12_26_4012-MCX416A-CCA_Ax-UEFI-14.19.17-FlexBoot-3.5.805.bin.zip
+# unzip fw-ConnectX4-rel-12_26_4012-MCX416A-CCA_Ax-UEFI-14.19.17-FlexBoot-3.5.805.bin.zip
+# mstfwmanager -u -i fw-ConnectX4-rel-12_26_4012-MCX416A-CCA_Ax-UEFI-14.19.17-FlexBoot-3.5.805.bin
+Querying Mellanox devices firmware ...
+Device #1:
+----------
+  Device Type:      ConnectX4
+  Part Number:      MCX416A-CCA_Ax
+  Description:      ConnectX-4 EN network interface card; 100GbE dual-port QSFP28; PCIe3.0 x16; ROHS R6
+  PSID:             MT_2150110033
+  PCI Device Name:  pci0:2:0:0
+  Base GUID:        e41d2d0300fdbd90
+  Base MAC:         e41d2dfdbd90
+  Versions:         Current        Available
+     FW             12.26.1040     12.26.4012
+     PXE            3.5.0803       3.5.0805
+     UEFI           14.19.0014     14.19.0017
+  Status:           Update required
+---------
+Found 1 device(s) requiring firmware update...
+Perform FW update? [y/N]: y
+Device #1: Updating FW ...
+Initializing image partition -   OK
+Writing Boot image component -   OK
+Done
+Restart needed for updates to take effect.
+</code>
 ===== Debugging =====
 ==== Enabling crash dump ====
+=== Local swap dump device ===
 For saving and extracting a crash dump you need:
@@ Line 511: / Line 587: @@
 </code>
+=== netdump ===
+In case where you didn't have enough disk space to localy store dump, you can use netdump(4).
+On the receiving FreeBSD server (not your router):
+<code>
+pkg install netdumpd
+service netdumpd enable
+service netdumpd start
+</code>
+Then on your router, declare source interface to use, source IP address, gateway
+<code>
+sysrc dumpdev=igb1
+sysrc dumpon_flags="-s 198.19.0.24 -c 192.168.1.10 -g 192.168.1.254
+</code>
+and enable it:
+<code>
+# service dumpon restart
+kernel dumps on priority: device
+: /dev/null
+server address: 198.19.0.24
+client address: 192.168.1.10
+gateway address: 192.168.1.254
+</code>
 ==== Installing debug symbols ====
 Symbol files of kernel and binary are available in the separate DEBUG archive file.