Fix documentation for Delayloop

Co-authored-by: Tom Wieczorek <[email protected]> Signed-off-by: Juan-Luis de Sousa-Valadas Castaño <[email protected]>
k0sproject · May 7, 2024 · 18d3583 · 18d3583
1 parent c22cbf3
commit 18d3583
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 13 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -337,13 +337,13 @@ Configuration options required for using VRRP to configure VIPs in control plane
 
 Configuration options required for using VRRP to configure VIPs in control plane load balancing.
 
-| Element           | Description                                                                                                                      |
-| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
-| `ipAddress`          | The load balancer's listen address.                                                                                           |
-| `delayLoop`          | Delay timer for health check polling in seconds. Default: `0`.                                                                |
-| `lbAlgo`             | Algorithm used by keepalived. Supported algorithms: `rr`, `wrr`, `lc`, `wlc`, `lblc`, `dh`, `sh`, `sed`, `nq`. Default: `rr`. |
-| `lbKind`             | Kind of ipvs load balancer. Supported values: `NAT`, `DR`, `TUN`  Default: `DR`.                                              |
-| `persistenceTimeout` | Timeout value for persistent connections in seconds. Default: `360` (6 minutes).                                              |
+| Element                     | Description                                                                                                                                      |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ipAddress`                 | The load balancer's listen address.                                                                                                              |
+| `delayLoop`                 | Delay timer for check polling. DelayLoop accepts microsecond precision. Further precision will be truncated without warnings. Example: `10s`.    |
+| `lbAlgo`                    | Algorithm used by keepalived. Supported algorithms: `rr`, `wrr`, `lc`, `wlc`, `lblc`, `dh`, `sh`, `sed`, `nq`. Default: `rr`.                    |
+| `lbKind`                    | Kind of ipvs load balancer. Supported values: `NAT`, `DR`, `TUN`  Default: `DR`.                                                                 |
+| `persistenceTimeoutSeconds` | Timeout value for persistent connections in seconds. Must be in the range of 1-2678400 (31 days). If not specified, defaults to 360 (6 minutes). |
 
 ### `spec.controllerManager`
 

diff --git a/pkg/apis/k0s/v1beta1/cplb.go b/pkg/apis/k0s/v1beta1/cplb.go
@@ -160,10 +160,10 @@ type VirtualServer struct {
 	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:MinLength=1
 	IPAddress string `json:"ipAddress"`
-	// DelayLoop is the delay timer for check polling. If not specified, defaults to 0.
-	// DelayLoop is defined in microseconds. Further precision will be truncated without
+	// DelayLoop is the delay timer for check polling. DelayLoop accepts
+	// microsecond precision. Further precision will be truncated without
 	// warnings.
-	// kubebuilder:validation:Minimum=0
+	// +optional
 	DelayLoop metav1.Duration `json:"delayLoop,omitempty"`
 	// LBAlgo is the load balancing algorithm. If not specified, defaults to rr.
 	// Valid values are rr, wrr, lc, wlc, lblc, dh, sh, sed, nq. For further

diff --git a/static/manifests/v1beta1/CustomResourceDefinition/k0s.k0sproject.io_clusterconfigs.yaml b/static/manifests/v1beta1/CustomResourceDefinition/k0s.k0sproject.io_clusterconfigs.yaml
@@ -391,10 +391,9 @@ spec:
                               properties:
                                 delayLoop:
                                   description: |-
-                                    DelayLoop is the delay timer for check polling. If not specified, defaults to 0.
-                                    DelayLoop is defined in microseconds. Further precision will be truncated without
+                                    DelayLoop is the delay timer for check polling. DelayLoop accepts
+                                    microsecond precision. Further precision will be truncated without
                                     warnings.
-                                    kubebuilder:validation:Minimum=0
                                   type: string
                                 ipAddress:
                                   description: IPAddress is the virtual IP address