Repository files navigation

OpenBMC is a Linux distribution for management controllers used in devices suchas servers, top of rack switches or RAID appliances. It usesYocto,OpenEmbedded,systemd, andD-Bus to allow easycustomization for your platform.

See theYocto documentationfor the latest requirements

sudo apt install git gcc g++ make file wget \    gawk diffstat bzip2 cpio chrpath zstd lz4 bzip2

sudo dnf install git python3 gcc g++ gawk which bzip2 chrpath cpio \    hostname file diffutils diffstat lz4 wget zstd rpcgen patch

git clone https://github.com/openbmc/openbmccd openbmc

Any build requires an environment set up according to your hardware target.There is a special script in the root of this repository that can be used toconfigure the environment as needed. The script is calledsetup and takes thename of your hardware target as an argument.

The script needs to be sourced while in the top directory of the OpenBMCrepository clone, and, if run without arguments, will display the list ofsupported hardware targets, see the following example:

$ . setup <machine> [build_dir]Target machine must be specified. Use one of:...

A more complete list of supported machines can be found undermeta-phosphor/docs.

Once you know the target (e.g. romulus), source thesetup script as follows:

. setup romulus

bitbake obmc-phosphor-image

Additional details can be found in thedocsrepository.

The OpenBMC community maintains a set of tutorials new users can go through toget up to speed on OpenBMC development outhere

Commits submitted by members of the OpenBMC GitHub community are compiled andtested via ourJenkins server. Commits are runthrough two levels of testing. At the repository level the makefilemake checkdirective is run. At the system level, the commit is built into a firmware imageand run with an arm-softmmu QEMU model against a barrage ofCI tests.

Commits submitted by non-members do not automatically proceed through CItesting. After visual inspection of the commit, a CI run can be manuallyperformed by the reviewer.

Automated testing against the QEMU model along with supported systems areperformed. The OpenBMC project uses theRobot Framework for all automation. Our completetest repository can be foundhere.

Support of additional hardware and software packages is always welcome. Pleasefollow thecontributing guidelineswhen making a submission. It is expected that contributions contain test cases.

Issues are managed on GitHub. It isrecommended you search through the issues before opening a new one.

First, please do a search on the internet. There's a good chance your questionhas already been asked.

For general questions, please use the openbmc tag onStack Overflow. Pleasereview thediscussionon Stack Overflow licensing before posting any code.

For technical discussions, please seecontact info below for Discordand mailing list information. Please don't file an issue to ask a question.You'll get faster results by using the mailing list or Discord.

This is a common question, particularly regarding boards from popular COTS(commercial off-the-shelf) vendors such as Supermicro and ASRock. You can seethe list of supported boards by running. setup (with no further arguments) inthe root of the OpenBMC source tree. Most of the platforms supported by OpenBMCare specialized servers operated by companies running large datacenters, butsome more generic COTS servers are supported to varying degrees.

If your motherboard is not listed in the output of. setup it is not currentlysupported. Porting OpenBMC to a new platform is a non-trivial undertaking,ideally done with the assistance of schematics and other documentation from themanufacturer (it is not completely infeasible to take on a porting effortwithout documentation via reverse engineering, but it is considerably moredifficult, and probably involves a greater risk of hardware damage).

However, even if your motherboard is among those listed in the output of. setup, there are two significant caveats to bear in mind. First, not allports are equally mature -- some platforms are better supported than others, andfunctionality on some "supported" boards may be fairly limited. Second, supportfor a motherboard is not the same as support for a complete system -- inparticular, fan control is critically dependent on not just the motherboard butalso the fans connected to it and the chassis that the board and fans are housedin, both of which can vary dramatically between systems using the same boardmodel. So while you may be able to compile and install an OpenBMC build on yoursystem and get some basic functionality, rough edges (such as your cooling fansrunning continuously at full throttle) are likely.

See also"Supported Machines".

• Host management: Power, Cooling, LEDs, Inventory, Events, Watchdog
• Full IPMI 2.0 Compliance with DCMI
• Code Update Support for multiple BMC/BIOS images
• Web-based user interface
• REST interfaces
• D-Bus based interfaces
• SSH based SOL
• Remote KVM
• Hardware Simulation
• Automated Testing
• User management
• Virtual media

• OpenCompute Redfish Compliance
• Verified Boot

• OpenBMC performance monitoring

Dive deeper into OpenBMC by opening thedocsrepository.

The Technical Steering Committee (TSC) guides the project. Members are:

• Benjamin Fair, Google
• Patrick Williams, Meta
• Roxanne Clarke, IBM
• Sagar Dharia, Microsoft
• Samer El-Haj-Mahmoud, Arm
• Terry Duncan, Intel

• Mail:openbmc@lists.ozlabs.orghttps://lists.ozlabs.org/listinfo/openbmc
• Discord:https://discord.gg/69Km47zH98