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

Go Docs on IngressConfig's LBType field is misleading

XMLWordPrintable

    • Low
    • None
    • Rejected
    • False
    • Hide

      None

      Show
      None

      Description of problem:

      The GO Docs of IngressConfig's spec.loadBalancer.platform.aws.type field is misleading because it doesn't mention that it actually sets LB Type for ALL user-created IngressControllers too.
      
      For both customers and OpenShift developers, this can be confusing. We should explicitly mention that this field provides the default for ALL IngressControllers, both the "default" IngressController and user-created IngressControllers.
      
      This becomes more important as we introduce more "mixed-use" fields in IngressConfig's `spec.loadBalancer`. Some new fields may set just the default IngressController (EIPAllocations), but some new fields may configure the default for all IngressControllers (Subnets).

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

      4.12+

      How reproducible:

      100%

      Steps to Reproduce:

          1. oc explain ingresses.config.openshift.io.spec.loadBalancer.platform.aws.type 

      Actual results:

      DESCRIPTION:
           type allows user to set a load balancer type. When this field is set the
           default ingresscontroller will get created using the specified LBType. If
           this field is not set then the default ingress controller of LBType Classic
           will be created. Valid values are:     * "Classic": A Classic Load Balancer that makes routing decisions at either
           the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See
           the following for additional details:         https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb     * "NLB": A Network Load Balancer that makes routing decisions at the
           transport layer (TCP/SSL). See the following for additional details:         https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb
      

      Expected results:

      It should explain that it's the default for ALL AWS IngressControllers, including user-created IngressControllers.

      Additional info:

          

              rh-ee-gpiotrow Grzegorz Piotrowski
              gspence@redhat.com Grant Spence
              Hongan Li Hongan Li
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: