Added disclaimer about incompatibility with SMD

This commit is contained in:
David Allen 2024-08-14 14:44:22 -06:00
parent 5b1e3e732e
commit db44c51113
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC

View file

@ -2,6 +2,8 @@
The `magellan` CLI tool is a Redfish-based, board management controller (BMC) discovery tool designed to scan networks and is written in Go. The tool collects information from BMC nodes using the provided Redfish RESTful API with [`gofish`](https://github.com/stmcginnis/gofish) and loads the queried data into an [SMD](https://github.com/OpenCHAMI/smd/tree/master) instance. The tool strives to be more flexible by implementing multiple methods of discovery to work for a wider range of systems (WIP) and is capable of using independently of other tools or services. The `magellan` CLI tool is a Redfish-based, board management controller (BMC) discovery tool designed to scan networks and is written in Go. The tool collects information from BMC nodes using the provided Redfish RESTful API with [`gofish`](https://github.com/stmcginnis/gofish) and loads the queried data into an [SMD](https://github.com/OpenCHAMI/smd/tree/master) instance. The tool strives to be more flexible by implementing multiple methods of discovery to work for a wider range of systems (WIP) and is capable of using independently of other tools or services.
**Note: `magellan` v0.1.0 is incompatible with SMD v2.15.3 and earlier.**
## Main Features ## Main Features
The `magellan` tool comes packed with a handleful of features for doing discovery, such as: The `magellan` tool comes packed with a handleful of features for doing discovery, such as: