README.md

OpenBMC

The OpenBMC project can be described as a Linux distribution for embeddeddevices that have a BMC; typically, but not limited to, things like servers,top of rack switches or RAID appliances. The OpenBMC stack uses technologiessuch asYocto,OpenEmbedded,systemd, andD-Bus to allow easycustomization for your server platform.

Setting up your OpenBMC project

1) Prerequisite

• Ubuntu 14.04

sudo apt-get install -y git build-essential libsdl1.2-dev texinfo gawk chrpath diffstat

• Fedora 28

sudo dnf install -y git patch diffstat texinfo chrpath SDL-devel bitbake rpcgensudo dnf groupinstall "C Development Tools and Libraries"

2) Download the source

git clone git@github.com:openbmc/openbmc.gitcd openbmc

3) Target your hardware

Any build requires an environment variable known asTEMPLATECONF to be setto a hardware target.You can see all of the known targets withfind meta-* -name local.conf.sample. Choose the hardware target andthen move to the next step. Additional examples can be found in theOpenBMC Cheatsheet

As an example target Palmetto

export TEMPLATECONF=meta-ibm/meta-palmetto/conf

4) Build

. openbmc-envbitbake obmc-phosphor-image

Additional details can be found in thedocsrepository.

Build Validation and Testing

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 check directive is run. At the system level, the commit is built into afirmware image and 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. Ourcomplete test repository can be foundhere.

Submitting Patches

Support of additional hardware and software packages is always welcome.Please follow thecontributing guidelineswhen making a submission. It is expected that contributions contain testcases.

Bug Reporting

Issues are managed onGitHub. It is recommended you search through the issues before openinga new one.

Features of OpenBMC

Feature List

• REST Management
• IPMI
• SSH based SOL
• Power and Cooling Management
• Event Logs
• Zeroconf discoverable
• Sensors
• Inventory
• LED Management
• Host Watchdog
• Simulation
• Code Update Support for multiple BMC/BIOS images

Features In Progress

• Full IPMI 2.0 Compliance with DCMI
• Verified Boot
• HTML5 Java Script Web User Interface
• BMC RAS

Features Requested but need help

• OpenCompute Redfish Compliance
• OpenBMC performance monitoring
• cgroup user management and policies
• Remote KVM
• Remote USB
• OpenStack Ironic Integration
• QEMU enhancements

Finding out more

Dive deeper in to OpenBMC by opening thedocsrepository.

Contact

• Mail:openbmc@lists.ozlabs.orghttps://lists.ozlabs.org/listinfo/openbmc
• IRC: #openbmc on freenode.net
• Riot:#openbmc:matrix.org