Uploaded image for project: 'Migration Toolkit for Virtualization'
  1. Migration Toolkit for Virtualization
  2. MTV-3566

[DOC] Strict API for forkliftController global settings

XMLWordPrintable

    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected

      In 2.10 we will be using a strict API for forkliftController global settings.
      Up until 2.10, we did not formally document the API of setting feature gates and other global settings.

       

      https://kubev2v.github.io/forklift-documentation/documentation/doc-Migration_Toolkit_for_Virtualization/master/index.html#configuring-mtv-operator_forklift

      in 2.10 we will formally declare the API for this options:
      https://github.com/kubev2v/forklift/blob/main/operator/config/crd/bases/forklift.konveyor.io_forkliftcontrollers.yaml#L45

      This PR includes all the settings, some short descriptions, and default values.

       

      As @myakove raised the issue that we in 2.9 users may have used the API wrong because it was not formalized

      We will need a release note informing users the API type for feature flags will only allow strings, e.g. "true" / "false" and error on booleans, in 2.9, we did not specify the type, and both booleans and strings were accepted.

      • Release note: informing user that the API type for feature flags will only allow strings, e.g. "true" / "false" and error on booleans
      • Add admonition note to the documentation: This note is important in case users use automation or scripts that use the API using the wrong type.

              rhn-support-jelynch Jenny-Anne Lynch
              rhn-support-anarnold A Arnold
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated: