Uploaded image for project: 'Red Hat Advanced Cluster Security'
  1. Red Hat Advanced Cluster Security
  2. ROX-27788

Agreed-on guidelines on how to evolve operator API

Create Feature from Fe...Move to CloseXMLWordPrintable

    • Agreed-on guidelines on how to evolve operator API
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected
    • To Do
    • 100% To Do, 0% In Progress, 0% Done
    • 0

      CUSTOMER PROBLEM

      • Closely related to that, we are in equally bad shape w.r.t. evolving the schema as the operands (e.g. collector) changes - according to k8s API conventions, we make incompatible schema changes and we’re still on v1alpha1. So we are effectively not versioning our API. (Note that many OpenShift APIs are in the same (alpha) boat.)
      • We do not have good guide-rails for evolving the API. For the more dynamically changing parts of configuration this results in getting ourselves painted into a corner, and consequently abominations such as forceCollection field.

      Related (unfinished) discussion on slack.

      ACCEPTANCE CRITERIA

      1. A set of agreed-on guidelines on:
        1. how to introduce new fields into the operator API and subsequently evolve them. These guidelines must describe how we should have handled the above-mentioned issues if we were wiser from the start.
        2. how and in what situations to bump the operator API version.
      2. Solutions to the child tickets.

       

              mowsiany@redhat.com Marcin Owsiany
              mowsiany@redhat.com Marcin Owsiany
              ACS Install
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated: