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

Implement the JSON configuration refactor decided by ADR-18

Change Owns to Parent OfsSet start and due date...
    XporterXMLWordPrintable

Details

    • Obs Mgt & Controls
    • Hide

      A better considered structure for the configuration string, making extraction of parts relevant to different subsystems easier.

      Show
      A better considered structure for the configuration string, making extraction of parts relevant to different subsystems easier.
    • Hide

      At the end of the feature the MVP tests, BDD and otherwise, should execute successfully with the new JSON string.

      The Solution Intent should be updated with details of the new structure (https://confluence.skatelescope.org/display/SWSI/Configuration+Schemas

      The new schema is added to the telescope model repository, and the CSP configuration generation code is adjusted to put SDP receive addresses in the right place

      All other standard DoD criteria

      Show
      At the end of the feature the MVP tests, BDD and otherwise, should execute successfully with the new JSON string. The Solution Intent should be updated with details of the new structure ( https://confluence.skatelescope.org/display/SWSI/Configuration+Schemas )  The new schema is added to the telescope model repository, and the CSP configuration generation code is adjusted to put SDP receive addresses in the right place All other standard DoD criteria
    • 2
    • 2
    • 6.5
    • Team_CREAM, Team_NCRA
    • Sprint 4
    • Hide

      Documentation of changes planned and agreed with other stakeholders in AT-218 closing document
      The merge request for telescope-model is #24 (https://gitlab.com/ska-telescope/telescope-model/-/merge_requests/24)
      The merge request for CSP-LMC can be seen in
      https://gitlab.com/ska-telescope/csp-lmc/-/merge_requests/13
      The Solution intent is updated with the 1.0 protocol description (https://developer.skatelescope.org/projects/telescope-model/en/latest/ska_csp_configure.html#csp-config-1-0)

      Show
      Documentation of changes planned and agreed with other stakeholders in AT-218 closing document The merge request for telescope-model is #24 ( https://gitlab.com/ska-telescope/telescope-model/-/merge_requests/24 ) The merge request for CSP-LMC can be seen in https://gitlab.com/ska-telescope/csp-lmc/-/merge_requests/13 The Solution intent is updated with the 1.0 protocol description ( https://developer.skatelescope.org/projects/telescope-model/en/latest/ska_csp_configure.html#csp-config-1-0 )
    • 9.6
    • Stories Completed, Integrated, Solution Intent Updated, BDD Testing Passes (no errors), Outcomes Reviewed, NFRS met, Demonstrated, Satisfies Acceptance Criteria, Accepted by FO
    • PI24 - UNCOVERED

    • Cross_Team_Code_Review
    • SPO-863

    Description

      ADR-18 decided on a change to the structure of the JSON strings used to configure the CSP. This feature implements ADR-18 change in the current MVPs for Mid and Low. The total work is partially in CSP.LMC (receiver, estimated 1FP) and partially in TM (sender, estimated 1FP).

      From the ADR page (adapted):

      The new structure of configuration json reflects the real structure of the target [sub]element.The CSP configure would have a structure as:

      The configure json structure has three main portions:

      1. the subarray portion. This section contains only the parameters specific to the configuration receiving entity (in current design the subarray device). It is not forwarded.
      2. the common portion. This section contains only the parameters common to all sub-elements and then it is forwarded to all of them
      3. the sub-element specific portion.

      The new structure, while a little more complex than the previous one has the following advantages:

      • For the producing entity it is simpler to organize and maintain the code which configure a specific part.
      • For the target entity the gain is analogous, as the sub-elements decode portion does need to know only a specific (‘local’) portion of the possible commands
      • For testing and human inspection it is much simpler to collect all related item in a single branch of the complete json.

      The current version does not includes all due variables. The lists relative to each sub-elements will be variable with time and will belong more properly to the ICD documentation.

      We note that the old  and the new format can coexist without harming each other. It is so possible to foresee a transition phase in which both forms are present.

      There should be collaboration with the work on SP-1345 to ensure alignment, and also with the NCRA team to cover any impact on the TMC. The work required on this feature and on SP-1345 could be re-arranged if it makes sense to.

      In due time the new structure will incorporate json versioning as per ADR-22

      Attachments

        Issue Links

          Structure

            Activity

              People

                a.bridger Bridger, Alan
                a.bridger Bridger, Alan
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Feature Progress

                  Story Point Burn-up: (100.00%)

                  Feature Estimate: 2.0

                  IssuesStory Points
                  To Do00.0
                  In Progress   00.0
                  Complete410.0
                  Total410.0

                  Dates

                    Created:
                    Updated:
                    Resolved:

                    Structure Helper Panel