GUI : Service Indicators

[derick-montague]

SMEs

BMC: @lkammath PHYP: Adam Stallman RAS: George Ahrens

Research

Summary

The goal of this story is to finalize the fault and service indicators in the HW status and inventory page.

Two kinds of service indicators for specific FRUs (A) Fault LED (Cannot be switched on/off by a user)

Fault LED is mapped to the Health, so: fault LED ON = Health Critical fault LED OFF = Health OK fault LED OFF = Health Warning

(B) Identify LED (Can be switched on/off by a user)

Four kinds of service indicators for systems (A) Power status (read only) (B) System identify LED (C) System attention LED (D) Lamp test

Background

• [ ] TBD

End users

• Paul (Product Engineer)
• Tricia (Power Sys Admin)
• Noah (Junior Sys Admin w/o HMC)

User Needs

• [ ] Needs a quick way to point out which hardware components need to be serviced/replaced.

References/Resources

• ASMI -> Enclosure indicators and Indicators by Location Code
• eBMC Feature Item: 2.4.2, 2.4.3, 2.4.4
• [ ] Link to Discovery folder
• 2.4.1: Server LED, 2.4.2: System Information Indicators
• 2.4.3: Indicators by Location Code Not needed since the Indicator LED toggle will be associated with the component in the Hardware Inventory along with the Location Code

Design

User Story

As a system admin I need to know if a FRU is faulty and be able to turn on the LED service indicator in order to easily locate the part that needs to be replaced.

Use Case(s)

• [ ] Add use case(s)

Design Goals

• [ ] Allow the user to easily identify and locate a faulty part for replacement
• [ ] Should be integrated in the Hardware Vital Product Data page

InVision Prototype

• Iteration 0

Community

• [ ] Created design review story in webui-vue repo
• [ ] Sent email to community sharing the design review story

FED

UX Flow / Interaction Requirements

Upstream

• Add System attention indicators section
• Add Power status/state (on or off)
• Add the System Identify LED

Downstream

• Add Lamp test

Unknown

• System Attention LED (Backend still in dicussion)

cURL Commands and Redfish Response

• [ ] Add Redfish response
• [ ] Add cURL commands

Notes

• [ ] Any known API workarounds
• [ ] Any server-side functionality WIP

UI Checklist

Browser Tests (Chrome, Firefox, Safari (Mac), Edge (Windows))

• [ ] Tested responsive layout on supported viewport sizes
• [ ] Verified functionality works as expected, e.g. success and failure use cases
• [ ] Resolved any JavaScript errors thrown to the console

Accessibility Tests

• [ ] Verified markup is semantic
• [ ] No reported issues in IBM Accessibility Checker (Free open source tool) https://www.ibm.com/able/toolkit/tools/

Test Hooks

• [ ] Verify need for data-test-id hooks with test team

[derick-montague]

Expect the design for this to have impact on of the Hardware Status and VPD design #2210 since location codes will also be present in VPD.

[derick-montague]

ASMI screen captures

Indicators by Location code

Error Message

Enclosure indicators

[nicoleconser]

From preliminary card sort (not validated w/ users) — this was to help us group all things indicator/LED related:

[priyanka-pillai97]

Important Slack Conversations

Participants: Gunnar, Vishwa and Santosh https://ibm-systems-power.slack.com/archives/C0Q6TQP5Z/p1615357717014500?thread_ts=1611132244.032200&cid=C0Q6TQP5Z

Summary:

Two kinds of service indicators for specific FRUs

(A) Fault LED (Cannot be switched on/off by a user) (B) Identify LED (Can be switched on/off by a user)

Fault LED is mapped to the Health, so:

1. fault LED ON = Health Critical
2. fault LED OFF = Health OK
3. ault LED OFF = Health Warning

Four kinds of service indicators for systems

1. Power status (read only)
2. System identify LED
3. System attention LED (Implementation undecided. Being discussed within the team)
4. Lamp test

[Su-kan]

Resolved by https://gerrit.openbmc-project.xyz/c/openbmc/webui-vue/+/43959

[Su-kan]

System attention LED will be available from backend by Sept 2021 stated by @lkammath (here)