Add latest godoc from
@@ -120,16 +120,27 @@ type IngressControllerTuningOptions struct {
// handle more connections but at the cost of additional
// system resources being consumed.
//
+ // Permitted values are:
+ //
+ // empty
+ // 0
+ // -1
+ // 2000-2000000
+ //
// If this field is empty or 0, the IngressController will use
// the default value of 20000, but the default is subject to
- // change in future releases. If the value is -1 then HAProxy
- // will dynamically compute a value based on ulimits and the
- // the configuration file when the haproxy process starts.
- // Selecting -1 (i.e., auto) will result in a large value
- // being computed (typically 524259 on OpenShift >=4.10
- // clusters) and therefore each HAProxy process will incur
- // significant memory usage compared to the current default of
- // 20000.
+ // change in future releases.
+ //
+ // If the value is -1 then HAProxy will dynamically compute a
+ // maximum value based on the available ulimits in the running
+ // container. Selecting -1 (i.e., auto) will result in a large
+ // value being computed (~520000 on OpenShift >=4.10 clusters)
+ // and therefore each HAProxy process will incur significant
+ // memory usage compared to the current default of 20000.
+ //
+ // Setting a value that is greater than the current operating
+ // system limit will prevent the HAProxy process from
+ // starting.
//
// +kubebuilder:validation:Optional
// +optional
