-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README.md: Update Readme with new guide to interact with the tools
- Loading branch information
Showing
1 changed file
with
12 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,24 @@ | ||
| # Bluefield tools | ||
| This repository contains tools and a Containerfile to build a container which provides a conveniant way to manage Bluefield-2 (BF-2) and Bluefield-3 (BF-3). Make sure that the underlying system has kernel-modules-extra installed (since cuse is a dependency) and run the container as follows (a build is available on quay.io): | ||
| # Dpu tools | ||
| This repository contains tools and a Containerfile to build a container which provides a conveniant way to manage DPU's such as Bluefield-2 (BF-2) and Bluefield-3 (BF-3), Intel IPU, Marvell Octeon. Make sure that the underlying system has kernel-modules-extra installed (since cuse is a dependency) and run the container as follows (a build is available on quay.io): | ||
|
|
||
| ``` | ||
| sudo podman run --pull always --replace --pid host --network host --user 0 --name bf -dit --privileged -v /dev:/dev quay.io/bnemeth/bf | ||
| sudo podman run --pull always --replace --pid host --network host --user 0 --name bf -dit --privileged -v /dev:/dev quay.io/bnemeth/dpu-tools <SUBCOMMAND> | ||
| ``` | ||
|
|
||
| ## Tools | ||
|
|
||
| All the tools can directly be ran inside the container. All the tools automatically find and act on the first BF in the system. | ||
| All the tools can directly be interacted with through the dpu-tools interface. All the tools automatically find and act on the first DPU in the system. One small difference is that using the console subcommand requires specifying what DPU type you are working with. Check out its help page by passing the `-h` flag. | ||
|
|
||
| ``` | ||
| sudo podman exec -it bf /<TOOL_NAME> | ||
| ``` | ||
|
|
||
| | Tool | Purpose | | ||
| | Tool/Subcommand | Purpose | | ||
| |--------------|------------------------------------------------------------------------------------------| | ||
| | `reset` | Reboots the BF. | | ||
| | `listbf` | List all B2 on the system. | | ||
| | `fwup` | Updates the firmware on the BF to the latest. | | ||
| | `fwversion` | Shows firmware version | | ||
| | `console` | Starts a minicom console to access the BF. | | ||
| | `reset` | Reboots the DPU. | | ||
| | `list` | List all DPUs on the system. | | ||
| | `firmware` | Manages the firmware of the DPU. {version, reset, up} | | ||
| | `console` | Starts a minicom console to access the DPU. | | ||
| | `pxeboot` | Starts a pxe server and tells BF to boot from it. An coreos iso file needs to be passed. | | ||
| | `fwdefaults` | Resets the firmware settings on the BF to defaults. | | ||
| | `bfb` | Downloads BFB images and sends it to the BF. | | ||
| | `set_mode` | Sets the BF mode to either dpu or nic. One argument is required | | ||
| | `get_mode` | Gets the BF mode. | | ||
| | `cx_fwup` | Upgrades the firmware on a CX | | ||
| | `mode` | Gets the BF mode. Use `--set-mode` to change the mode to either dpu or nic | | ||
| | `utils` | Access common or non-dpu specific utilities. {cw_fwup, bfb} | | ||
|
|
||
| The only tool that requires an argument is the `pxeboot` tool. It expect an iso file with coreos that should | ||
| The `pxeboot` tool requires an argument; It expect an iso file with coreos that should | ||
| be booted through the rshim. The iso file can optionally be on an nfs mount point. |