Uploaded image for project: 'SAFe Program'
  1. SAFe Program
  2. SP-1545

SDP operator engineering user interface(s)

Details

    • Feature
    • Not Assigned
    • PI10
    • COM SDP SW
    • None
    • Data Processing
    • Hide

      As a PSI operator, I want to be able to have an easy to use interface, or set of interfaces, to interrogate the internal state SDP and issue commands. 

      Show
      As a PSI operator, I want to be able to have an easy to use interface, or set of interfaces, to interrogate the internal state SDP and issue commands. 
    • Hide
      • An Initial prototype (MVP) of an SDP operator focused engineering user interface has been developed capable of:
        • 1) Interrogating the internal state of SDP, including knowledge of active, starting, and completed Processing blocks.
        • 2) providing a more user-friendly update to commands already exposed via the sdpcfg CLI.
      • This can be CLI or GUI based and internal functions could be mocked for this PI as the primary goal of this work in PI10 should prepare a solution that can be used to get quick feedback as to the future direction of this product.
      Show
      An Initial prototype (MVP) of an SDP operator focused engineering user interface has been developed capable of: 1) Interrogating the internal state of SDP, including knowledge of active, starting, and completed Processing blocks. 2) providing a more user-friendly update to commands already exposed via the sdpcfg  CLI. This can be CLI or GUI based and internal functions could be mocked for this PI as the primary goal of this work in PI10 should prepare a solution that can be used to get quick feedback as to the future direction of this product.
    • 3
    • 3
    • 8.667
    • Team_SIM
    • Sprint 5
    • Hide

      Use cases for the operator interfaces are captured in Miro here:

      https://miro.com/app/board/o9J_lO4rG24=/

      and they have been analysed in the Sim team Confuence pages here:

      https://confluence.skatelescope.org/display/SE/SDP+Operator+Interfaces

      One outcome of the analysis was the decision to store the workflow definitions in the configuration database.

      The command line interface has been renamed to "ska-sdp" and its functionality and on-line documentation has been improved. The documentation has also been made available as part of the SDP configuration library documentation.

      We have implemented a proof-of-concept web interface to provide various views of the contents of the SDP configuration database.

      Version 0.5.0 of the SDP Helm chart includes the new command-line interface (in the console) and the web interface.

      Show
      Use cases for the operator interfaces are captured in Miro here: https://miro.com/app/board/o9J_lO4rG24=/ and they have been analysed in the Sim team Confuence pages here: https://confluence.skatelescope.org/display/SE/SDP+Operator+Interfaces One outcome of the analysis was the decision to store the workflow definitions in the configuration database. The command line interface has been renamed to "ska-sdp" and its functionality and on-line documentation has been improved. The documentation has also been made available as part of the SDP configuration library documentation. We have implemented a proof-of-concept web interface to provide various views of the contents of the SDP configuration database. Version 0.5.0 of the SDP Helm chart includes the new command-line interface (in the console) and the web interface.
    • 11.4
    • Stories Completed, Integrated, Outcomes Reviewed, Demonstrated, Satisfies Acceptance Criteria, Accepted by FO

    Description

      While to a certain extent aspects of this exists already in the form of:

      • The UI provided by Webjive/Tarana for the SDP subarray device
      • Logging dashboards provided by the ELK stack (ie Kibana)
      • Commands available in the sdpcfg configuration database CLI

      None of these can really be considered to provide the level of UX we likely need to provide advanced engineering operators who will need to interrogate and command the SDP system either as part of a full SKA software deployment for testing of SDP in a standalone mode where TMC is not deployed.

      The intension of this feature is to develop an extremely simple MVP of an interface, possibly by extending existing functionality, possibly mocking a lot of the underlying functions to gather early feedback and start a fast feedback loop with PSI operators to establish a solution we can build in future.

      Further elaboration of what functionality should be in this MVP should be discussed at or shortly after PI10 planning (possibly with an initial spike). Some possible considerations to start that are:

      1. Given a running SDP system, when I use the SDP operator interface, I want to be able to see a list of processing blocks along with associated metadata so I can better understand the state of processing in the system.
      2. Gen a running SDP system, I want to be able to view a dashboard of aggregated logs 
      3. Given <a running SDP system?>, when I ask for a list of SDP workflows that the SDP system can currently execute, I want to be able to obtain this list including associated meta-data which tells me: 1) if the workflow has been validated against the current version of SDP or is still in an experimental state, 2) 
      4. ...

       

      Attachments

        Issue Links

          Structure

            Activity

              People

                b.mort Mort, Ben
                b.mort Mort, Ben
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Feature Progress

                  Story Point Burn-up: (100.00%)

                  Feature Estimate: 3.0

                  IssuesStory Points
                  To Do00.0
                  In Progress   00.0
                  Complete1020.5
                  Total1020.5

                  Dates

                    Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel