Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-4270

Investigate ManifestWork option for structured properties

XMLWordPrintable

    • Icon: Spike Spike
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • MCE 2.2.2
    • Server Foundation
    • None
    • False
    • None
    • False
    • Hide

      Provide the required acceptance criteria using this template.
      * ...
      Show
      Provide the required acceptance criteria using this template. * ...
    • No

      Value Statement

      Controllers which use ManifestWork need insight into the status of their operands. They can already declare feedbackRules to collect specific properties. However today's:

      JSONPaths: A valid Kubernetes JSON-Path that selects a scalar field from the resource. Currently supported types are Integer, String and Boolean.

      is restricted to scalar fields, and occasionally controllers need more structured information. HOSTEDCP-924 discusses a workaround where structured content is serialized to JSON and stored where the existing feedbackRules can pick it up as an opaque string. But it would be convenient if there was a way to request structured property data via feedbackRules, especially because it is not always possible to adjust the operand resource to be easily consumed by existing rules.

      However, there are also bandwidth and storage costs to packaging large chunks of structured data in ManifestWork. It's not clear to me at the moment how tight those constraints are, and where the cost/benefit trade-offs ship between the convenience of being able to transmit structured data wins out over the transmission efficiency of requiring consumers to explicitly request every scalar property they require.

      Definition of Done for Engineering Story Owner (Checklist)

      • Clarity around whether JSON Path feedbackRules for structured data is in the roadmap, including pointers to any follow-up tickets, or a description of why it's not in the roadmap.

      Development Complete

      • The code is complete.
      • Functionality is working.
      • Any required downstream Docker file changes are made.

      Tests Automated

      • [ ] Unit/function tests have been automated and incorporated into the
        build.
      • [ ] 100% automated unit/function test coverage for new or changed APIs.

      Secure Design

      • [ ] Security has been assessed and incorporated into your threat model.

      Multidisciplinary Teams Readiness

      • [ ] Create an informative documentation issue using the Customer Portal doc-issue template, and ensure doc acceptance criteria is met. Link the development issue to the doc issue.
      • [ ] Provide input to the QE team, and ensure QE acceptance criteria
        (established between story owner and QE focal) are met.

      Support Readiness

      • [ ] The must-gather script has been updated.

            leyan@redhat.com Le Yang
            trking W. Trevor King
            Hui Chen Hui Chen
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: