openbmc/entity-manager/README.md

1 # Entity Manager
3 Entity manager is a design for managing physical system components, and mapping
10 ### Entity  subsection
14 likely does contain multiple sub-components, but the component itself as a whole
15 is referred to as an entity.
20 entity encompasses.
24 A particular feature of an Entity. An Entity generally will have multiple
30 A set of rules for detecting a given entity. Said rules generally take the form
31 of a D-Bus interface definition.
35 Entity manager has the following goals (unless you can think of better ones):
45 A full BMC setup using Entity Manager consists of a few parts:
48    components at runtime. The most common of these, fru-device, is included in
49    the Entity-Manager repo, and scans all available I2C buses for IPMI FRU
51    **[peci-pcie](https://github.com/openbmc/peci-pcie):** A daemon that utilizes
53    **[smbios-mdr](https://github.com/openbmc/smbios-mdr):** A daemon that
65 2. **An entity manager configuration file** Entity manager configuration files
66    are located in the ./configurations directory in the entity manager
71    Exposes records that specify the specific features that this Entity supports.
72    Once a component is detected, entity manager will publish these Exposes
73    records to D-Bus.
75 3. **A reactor** The reactors are things that take the entity manager
77    describe. One example of this is dbus-sensors, which contains a suite of
84 reactor when architectures are multi-tiered. An example of this might include a
90 Entity Manager will automatically create associations between its entities in
95 1. Entity manager shall support the dynamic discovery of hardware at runtime,
98    PCIe Add-in-cards.
100 2. Entity manager shall support the ability to add or remove support for
101    particular devices in a given binary image. By default, entity manager will
104 3. Entity manager shall provide data to D-Bus about a particular device such
107 4. Entity manager shall support multiple detection runs, and shall do the
109    longer detected. Some examples of re-detection events might include host
112 5. Entity manager shall have exactly one configuration file per supported device
120 1. Entity manager shall not directly participate in the detection of devices,
121    and instead will rely on other D-Bus applications to publish interfaces that
123 2. Entity manager shall not directly participate in management of any specific
125    feature set of entity manager, to ensure it remains small, and effective to
128 ### Entity Manager Compatible Software
131 entity-manager to produce a Redfish compliant REST API. **intel-ipmi-oem** An
132 implementation of the IPMI SDR, FRU, and Storage commands that utilize Entity
133 Manager as the source of information.
137 1. **[Entity Manager DBus API](https://github.com/openbmc/entity-manager/blob/master/docs/entity_ma…
138 2. **[My First Sensor Example](https://github.com/openbmc/entity-manager/blob/master/docs/my_first_…
139 3. **[Configuration File Schema](https://github.com/openbmc/entity-manager/tree/master/schemas)**
140 4. **[EEPROM address size detection modes](https://github.com/openbmc/entity-manager/tree/master/do…