Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-31711

platform.aws.lbType explain docs is misleading

XMLWordPrintable

    • Low
    • No
    • Sprint 253
    • 1
    • False
    • Hide

      None

      Show
      None
    • The explain command was confusing to users for installconfig.platform.aws.lbType. The information was updated to explain that setting the value will set the load balancer type for all ingress controllers (including the default).
    • Release Note Not Required
    • In Progress

      Description of problem:

      The go docs in the install-config's platform.aws.lbType is misleading as well as on the ingress object (oc explain ingresses.config.openshift.io.spec.loadBalancer.platform.aws.type).
      
      Both say:
      "When this field is specified, the default ingresscontroller will be created using the specified load-balancer type."
      
      That is true, but what is missing is that ALL ingresscontrollers will be created using the specified load-balancer type by default (not just the default ingresscontroller).
      
      This missing information can be confusing to users.

      Version-Release number of selected component (if applicable):

          4.12+

      How reproducible:

          100%

      Steps to Reproduce:

      openshift-install explain installconfig.platform.aws.lbType
      - or -
      oc explain ingresses.config.openshift.io.spec.loadBalancer.platform.aws.type   

      Actual results:

      ./openshift-install explain installconfig.platform.aws.lbType
      KIND:     InstallConfig
      VERSION:  v1RESOURCE: <string>
      
      LBType is an optional field to specify a load balancer type. When this field is specified, the default ingresscontroller will be created using the specified load-balancer type. 
      
      ...
      [same with ingress.spec.loadBalancer.platform.aws.type]

      Expected results:

      My suggestion:
      
      ./openshift-install explain installconfig.platform.aws.lbType
      KIND:     
      InstallConfig 
      VERSION:  v1RESOURCE: <string>  
      
      LBType is an optional field to specify a load balancer type. When this field is specified, all ingresscontrollers (including the default ingresscontroller) will be created using the specified load-balancer type by default.
      
      ...
      [same with ingress.spec.loadBalancer.platform.aws.type]

      Additional info:

          Since the change should be the same thing for both the installconfig and ingress object, this bug would handle both.

            rh-ee-bbarbach Brent Barbachem
            gspence@redhat.com Grant Spence
            Yunfei Jiang Yunfei Jiang
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Created:
              Updated: