Skip to content

UI Buidling Guidelines

Jump to bottom
Paresh Gupta edited this page Jun 10, 2021 · 2 revisions

High level

  • Stay consistent.
  • Don't assume that users know what you know.

Nomenclature

  • Use Title Capitalization for panel name.
    For example: Server Operational State, not Server operational State

  • Panel names should use this pattern: Use-case - Direction Protocol - Scope

    • Use-case: Keep as short as possible. Examples are Top 10 Uplink Ports, Top 10 Servers, and so on.
    • Direction: RX, TX, Ingress, Egress. Read below for difference between RX and Ingress.
    • Protocol: Eth or FC
    • Scope: $location, $domain, etc. Example: Top 10 Uplink Ports - RX Eth - Italy
      Traffic Per Domain - Ingress FC - UK

  • Suffix the scope in the panel title. For example, on Location dashboard, suffix all panel names with - $location. Likewise, on Domain dashboard, suffix all panel titles with - $domain.

  • Use Server to reference a server-blade or rack. Use Service Profile only if using Server to reference the physical reference in the same view.

  • Ingress Traffic - Traffic going to server or received by server. Ingress Traffic on

    • FI Uplink Ports is RX
    • FI Server Ports is TX
    • IOM Fabric Ports is RX
    • IOM Backplane Ports is TX
    • Adapter Ports is RX
    • vNIC/vHBA is RX

  • Likewise, Egress Traffic - Traffic going from server or sent by server. Egress Traffic on

    • FI Uplink Ports is TX
    • FI Server Ports is RX
    • IOM Fabric Ports is TX
    • IOM Backplane Ports is RX
    • Adapter Ports is TX
    • vNIC/vHBA is TX

  • Ingress and Egress Traffic terminology is used in the context of overall UCS domain. While referencing to a specific ports, RX and TX are used. For example, while showing utilization of a FI Uplink Port, RX and TX show the traffic received and sent by that specific port. Likewise, while showing utilization of FI Server Port, RX and RX show the traffic show the traffic received and sent by that specific port. In the overall content, however, RX traffic on FI Server Port is Ingress Traffic (going to Server). Extend the same for TX traffic on FI Server Port.

Links and Data Links

  • Carry the timestamp of the current dashboard. Use ${__url_time_range} or =from=${__from}&to={$__to}

Panel Placements

First Eth, then FC First RX, then TX First Ingres, then Egress

Hierarchy

Locations > UCS Domain (includes FI) > Chassis (includes IOM) > Server (includes adapter, vHBA, and vNIC)

Clone this wiki locally