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

[enterprise-4.11] Issue in file scalability_and_performance/routing-optimization.adoc

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major Major
    • None
    • 4.11
    • Documentation
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • None
    • Important
    • None
    • None
    • None
    • Rejected
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

      In the document [1], it is mentioned that it is not supported to modify the environment variables directly by modifying the deployment of Ingress POD.
      
      
      Whereas in this section [2] of the document, it is mentioned that we can modify the environment variables by modifying the IngressController directly. 
      
      Somewhere the explanation of the document Ingress Controller (router) performance optimizations [1] is misleading for the users. 
      
      Most of the users will think that OpenShift won't support tuning `ROUTER_THREADS, ROUTER_DEFAULT_TUNNEL_TIMEOUT, ROUTER_DEFAULT_CLIENT_TIMEOUT, ROUTER_DEFAULT_SERVER_TIMEOUT, and RELOAD_INTERVAL`. But in fact, they can tune them with tuningOptions [2].
      
      
      Thus the expectation from this issue is that the section Ingress Controller (router) performance optimizations document [1] should highlight that changing the underlying timeouts variables is supported through the tuningOptions [2] to avoid the confusion.

       

      Actual results:

      Routing Optimization document is not highlighting the tunningOptions which is used to modify the Timeouts variables. 

       

      Expected results:

      Routing Optimization document should highlight Router Tuning Options to modify the environment variables.

       

      Additional info:

      Issue: https://github.com/openshift/openshift-docs/issues/51823

       

      [1] https://docs.openshift.com/container-platform/4.11/scalability_and_performance/routing-optimization.html#router-performance-optimizations_routing-optimization

      [2] https://docs.openshift.com/container-platform/4.11/networking/ingress-operator.html#:~:text=the%20IngressController%20image.-,tuningOptions,-tuningOptions%20specifies%20options

       

       

       

       

       

       

              wiharris@redhat.com William Harris (Inactive)
              rhn-support-swasthan Swadeep Asthana (Inactive)
              None
              None
              Hongan Li Hongan Li
              None
              Votes:
              1 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: