xref: /openbmc/bmcweb/OWNERS (revision 1d7c0f08)
1ceeba4f9SEd Tanous# Below lists the current bmcweb maintainers.  bmcweb is used in a number of
2ceeba4f9SEd Tanous# different contexts, and is one of the few nearly-universally used core
3ceeba4f9SEd Tanous# components in OpenBMC.  As such, given the severe consequences of mistakes
4ceeba4f9SEd Tanous# made within the codebase, maintainers on this list are expected to:
5ceeba4f9SEd Tanous# - Have a solid understanding of the bmcweb core code, and how it's used.
6ceeba4f9SEd Tanous#
7ceeba4f9SEd Tanous# - Have access to at least one upstream platform to test relevant patchsets.
8ceeba4f9SEd Tanous#
9ceeba4f9SEd Tanous# - Help to manage the orderly merging of patchsets onto master through review.
10ceeba4f9SEd Tanous# It is expected that bmcweb maintainers participate on a majority of code
11ceeba4f9SEd Tanous# reviews, and although maintainers may work with each other to segment the
12ceeba4f9SEd Tanous# responsibilities into sub-parts the codebase, it is expected that maintainers
13ceeba4f9SEd Tanous# should be capable of reviewing all code in all modules if the need arises.
14ceeba4f9SEd Tanous#
15ceeba4f9SEd Tanous# - Provide help in testing and triage of cross-platform issues that arise as a
16ceeba4f9SEd Tanous# result of merging new features.
17ceeba4f9SEd Tanous#
18ceeba4f9SEd Tanous# - Have an in-depth understanding of the Redfish standard, its constraints in
19ceeba4f9SEd Tanous# how it interacts with OpenBMC, and how the bmcweb implementation compares to
20ceeba4f9SEd Tanous# other Redfish instances and how changes effect compatibility with other
21ceeba4f9SEd Tanous# Redfish services compatibility.
22ceeba4f9SEd Tanous#
23ceeba4f9SEd Tanous# - Be capable of, and have a track record of posing questions, clarifications,
24ceeba4f9SEd Tanous# and specification changes to [DMTF](https://www.dmtf.org/standards/redfish)
25ceeba4f9SEd Tanous# for resources implemented within the Redfish standard.  bmcweb maintainers
26ceeba4f9SEd Tanous# regularly attend the Redfish specification meetings to have a handle on
27ceeba4f9SEd Tanous# "intent" behind Redfish APIs.  In many cases, the role of the maintainer
28ceeba4f9SEd Tanous# requires knowing when a Redfish resource is underspecified, and direct people
29ceeba4f9SEd Tanous# to the standard before their changes can be accepted.
30ceeba4f9SEd Tanous#
31ceeba4f9SEd Tanous# - Have an understanding of, and track record of executing the various test
32ceeba4f9SEd Tanous# harnesses that bmcweb needs to pass, listed in CLIENTS.md, and at least a
33ceeba4f9SEd Tanous# rudimentary understanding of their requirements, and limitations.
34ceeba4f9SEd Tanous#
35ceeba4f9SEd Tanous# - Have an understanding of DBus and the specific implementations of sdbusplus
36ceeba4f9SEd Tanous# APIs that bmcweb uses, and their limitations in versioning, consistency, and
37ceeba4f9SEd Tanous# general implementation completeness.
38ceeba4f9SEd Tanous#
39ceeba4f9SEd Tanous# - Join and answer questions of the #bmcweb-and-redfish channel within
40ceeba4f9SEd Tanous# discord.
41ceeba4f9SEd Tanous#
42ceeba4f9SEd Tanous# - Join and answer architecture queries posed to the mailing list concerning
43ceeba4f9SEd Tanous# bmcweb.
44ceeba4f9SEd Tanous#
45ceeba4f9SEd Tanous# - Be capable of responding to CVE queries forwarded from the
46ceeba4f9SEd Tanous# [openbmc-security-response-team]
47ceeba4f9SEd Tanous# (https://github.com/openbmc/docs/blob/master/security/obmc-security-response-team.md).
48ceeba4f9SEd Tanous# Considering that in most implementations of the OpenBMC security model,
49ceeba4f9SEd Tanous# bmcweb is the primary attacker/client facing application on the network, it
50ceeba4f9SEd Tanous# is expected that a number of potential CVEs will be posted, for which bmcweb
51ceeba4f9SEd Tanous# forms a component of the alleged attack.  Maintainers should be prepared to
52ceeba4f9SEd Tanous# respond to such requests in the timeframe required by the CVE process, and
53ceeba4f9SEd Tanous# ideally should have a track record of doing it in the past.
54ceeba4f9SEd Tanous#
55*1d7c0f08SGunnar Mills# - Understand webui-vue, that bmcweb can optionally host, its use cases, and
56*1d7c0f08SGunnar Mills# how they differ from "normal" client-based use cases, as well as an
57*1d7c0f08SGunnar Mills# understanding of hosting web services in general.
58ceeba4f9SEd Tanous#
59ceeba4f9SEd Tanous# If you believe you meet the qualifications for the above, please open a
60ceeba4f9SEd Tanous# patchset, adding your name to the list below, documenting some evidence of
61ceeba4f9SEd Tanous# the above requirements being met, and the existing maintainers will happily
62ceeba4f9SEd Tanous# add you to the list.
63ceeba4f9SEd Tanous
64eaa96da3SEd Tanousowners:
65eaa96da3SEd Tanous- ed@tanous.net
66eaa96da3SEd Tanous- gmills@linux.vnet.ibm.com
676afb06d9SGunnar Mills
68ceeba4f9SEd Tanous
69ceeba4f9SEd Tanous# The below specifies a list of reviewers and interested parties that should be
70ceeba4f9SEd Tanous# included on code reviews to stay informed of progress.
71ceeba4f9SEd Tanous
726afb06d9SGunnar Millsreviewers:
7301358549SNan Zhou- nanzhoumails@gmail.com
74b0d3a856SEd Tanous
75b0d3a856SEd Tanousmatchers:
76b0d3a856SEd Tanous# unit tests
77b0d3a856SEd Tanous- suffix: _test.cpp
78b0d3a856SEd Tanous  owners:
79df0c4ee0SNan Zhou      - nanzhoumails@gmail.com
80b0d3a856SEd Tanous
81b0d3a856SEd Tanous# Redfish schemas
82b4d7181aSNan Zhou- exact: redfish-core/include/query.hpp
83df0c4ee0SNan Zhou  owners:
84df0c4ee0SNan Zhou      - nanzhoumails@gmail.com
85b4d7181aSNan Zhou- exact: redfish-core/include/utils/query_param.hpp
86df0c4ee0SNan Zhou  owners:
87df0c4ee0SNan Zhou      - nanzhoumails@gmail.com
88b0d3a856SEd Tanous- exact: redfish-core/lib/certificate_service.hpp
89df0c4ee0SNan Zhou  owners:
90df0c4ee0SNan Zhou      - nanzhoumails@gmail.com
913daf7270SNan Zhou- exact: redfish-core/lib/log_services.hpp
92df0c4ee0SNan Zhou  owners:
93df0c4ee0SNan Zhou      - nanzhoumails@gmail.com
94b0d3a856SEd Tanous- exact: redfish-core/lib/memory.hpp
95df0c4ee0SNan Zhou  owners:
96df0c4ee0SNan Zhou      - nanzhoumails@gmail.com
97b0d3a856SEd Tanous- exact: redfish-core/lib/sensors.hpp
98df0c4ee0SNan Zhou  owners:
99df0c4ee0SNan Zhou      - nanzhoumails@gmail.com
100