Gitiles
Code Review Sign In
gerrit.openbmc.org / stefanberger / openbmc / 0aa858ac8f4517f74c9a01593a7ccd8decc59742
commit0aa858ac8f4517f74c9a01593a7ccd8decc59742[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Mon Feb 04 17:12:29 2019 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Wed Feb 06 11:29:25 2019 -0500
treef1573ca2c1a736480b6583ecc7763e57408ce5ac
parent1aaa08f1fade2d88cfdb7bb40b41c91a6296fdc3 [diff]
ibm: Add a basic README

Most OE metadata repositories have a README.  Add a basic one for
meta-ibm.

meta-ibm never really had a clear direction of what it was supposed to
be, so give it one.

The top level meta-ibm will be a distro policy layer for IBM branded
servers.  Subtrees will be BSPs (and possibly additional distro policy)
for the components that make up the servers (BMCs and planars).

Note that meta-palmetto and meta-romulus are missing.  These are
OpenPOWER reference platforms and not IBM branded servers.  As such,
meta-palmetto and meta-romulus will be moved to meta-openpower.

(From meta-ibm rev: 8120f7c441f0599293cd05ae39ee852bfc52c482)

Change-Id: I6b0a446dd476188ff10d7c710a1c3ecb3eb4f754
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
1 file changed
tree: f1573ca2c1a736480b6583ecc7763e57408ce5ac
  1. meta-arm/
  2. meta-aspeed/
  3. meta-evb/
  4. meta-facebook/
  5. meta-google/
  6. meta-hxt/
  7. meta-ibm/
  8. meta-ingrasys/
  9. meta-inspur/
  10. meta-intel/
  11. meta-inventec/
  12. meta-mellanox/
  13. meta-nuvoton/
  14. meta-openembedded/
  15. meta-openpower/
  16. meta-phosphor/
  17. meta-portwell/
  18. meta-qualcomm/
  19. meta-quanta/
  20. meta-raspberrypi/
  21. meta-security/
  22. meta-x86/
  23. meta-xilinx/
  24. poky/
  25. bitbake ⇨ poky/bitbake/
  26. LICENSE ⇨ poky/LICENSE
  27. meta ⇨ poky/meta
  28. meta-poky ⇨ poky/meta-poky/
  29. meta-skeleton ⇨ poky/meta-skeleton
  30. oe-init-build-env ⇨ poky/oe-init-build-env
  31. scripts ⇨ poky/scripts/
  32. .gitignore
  33. .gitreview
  34. .templateconf
  35. MAINTAINERS
  36. openbmc-env
  37. README.md
  38. setup
README.md

OpenBMC

Build Status

The OpenBMC project can be described as a Linux distribution for embedded devices that have a BMC; typically, but not limited to, things like servers, top of rack switches or RAID appliances. The OpenBMC stack uses technologies such as Yocto, OpenEmbedded, systemd, and D-Bus to allow easy customization 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 rpcgen
sudo dnf groupinstall "C Development Tools and Libraries"

2) Download the source

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

3) Target your hardware

Any build requires an environment variable known as TEMPLATECONF to be set to a hardware target. You can see all of the known targets with find meta-* -name local.conf.sample. Choose the hardware target and then move to the next step. Additional examples can be found in the OpenBMC Cheatsheet

MachineTEMPLATECONF
Palmettometa-ibm/meta-palmetto/conf
Zaiusmeta-ingrasys/meta-zaius/conf
Witherspoonmeta-ibm/meta-witherspoon/conf
Romulusmeta-ibm/meta-romulus/conf

As an example target Palmetto

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

4) Build

. openbmc-env
bitbake obmc-phosphor-image

Additional details can be found in the docs repository.

Build Validation and Testing

Commits submitted by members of the OpenBMC GitHub community are compiled and tested via our Jenkins server. Commits are run through two levels of testing. At the repository level the makefile make check directive is run. At the system level, the commit is built into a firmware image and run with an arm-softmmu QEMU model against a barrage of CI tests.

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

Automated testing against the QEMU model along with supported systems are performed. The OpenBMC project uses the Robot Framework for all automation. Our complete test repository can be found here.

Submitting Patches

Support of additional hardware and software packages is always welcome. Please follow the contributing guidelines when making a submission. It is expected that contributions contain test cases.

Bug Reporting

Issues are managed on GitHub. It is recommended you search through the issues before opening a 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 the docs repository.

Contact