Gitiles
Code Review Sign In
gerrit.openbmc.org / mdmillerii / openbmc / 8954c350519fc1830b832ef6779587f71bf12234
commit8954c350519fc1830b832ef6779587f71bf12234[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Thu Jan 09 12:18:33 2020 -0600
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Wed Jan 15 20:50:25 2020 +0000
tree8b84d347557ceef46dc750b3a44c781eff958177
parent8ed7439f03a063a812a222f898aa36371dd1b322 [diff]
README: Fix TSC list mistake

2b90a9f2 missed a name on the TSC list.
This commit fixes that mistake.

The TSC list is moving to the openbmc/openbmc README because the docs
README is becoming specific to the docs repo and the openbmc/openbmc
README is for more general project information since the openbmc/openbmc
README is most likely the first landing spot of anyone new to
the project.

Change-Id: I8884df9e7abc05d4551fe745dfb729c7b7dad0d8
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
1 file changed
tree: 8b84d347557ceef46dc750b3a44c781eff958177
  1. .github/
  2. meta-arm/
  3. meta-aspeed/
  4. meta-evb/
  5. meta-facebook/
  6. meta-google/
  7. meta-hxt/
  8. meta-ibm/
  9. meta-ingrasys/
  10. meta-inspur/
  11. meta-intel/
  12. meta-inventec/
  13. meta-lenovo/
  14. meta-mellanox/
  15. meta-microsoft/
  16. meta-nuvoton/
  17. meta-openembedded/
  18. meta-openpower/
  19. meta-phosphor/
  20. meta-portwell/
  21. meta-qualcomm/
  22. meta-quanta/
  23. meta-raspberrypi/
  24. meta-security/
  25. meta-x86/
  26. meta-xilinx/
  27. meta-yadro/
  28. poky/
  29. bitbake ⇨ poky/bitbake/
  30. LICENSE ⇨ poky/LICENSE
  31. meta ⇨ poky/meta
  32. meta-poky ⇨ poky/meta-poky/
  33. meta-skeleton ⇨ poky/meta-skeleton
  34. oe-init-build-env ⇨ poky/oe-init-build-env
  35. scripts ⇨ poky/scripts/
  36. .gitignore
  37. .gitreview
  38. .templateconf
  39. MAINTAINERS
  40. openbmc-env
  41. README.md
  42. 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 perl-Thread-Queue perl-bignum perl-Crypt-OpenSSL-Bignum
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 Romulus

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

4) Build

. openbmc-env
bitbake obmc-phosphor-image

Additional details can be found in the docs repository.

OpenBMC Development

The OpenBMC community maintains a set of tutorials new users can go through to get up to speed on OpenBMC development out here

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.

Questions

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

For general questions, please use the openbmc tag on Stack Overflow. Please review the discussion on Stack Overflow licensing before posting any code.

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

Features of OpenBMC

Feature List

  • 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

Features In Progress

  • OpenCompute Redfish Compliance
  • Verified Boot

Features Requested but need help

  • OpenBMC performance monitoring

Finding out more

Dive deeper into OpenBMC by opening the docs repository.

Technical Steering Committee

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

  • Brad Bishop (chair), IBM
  • Nancy Yuen, Google
  • Sai Dasari, Facebook
  • James Mihm, Intel
  • Sagar Dharia, Microsoft
  • Supreeth Venkatesh, Arm

Contact