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