Fix the typing of Helm chart timeout duration

The intention and docs has always been to allow e.g. 10m as the timeout value. However, due to incorrect typing used it only accepted numeric values in nanosecs. :D

This fixes the typing to use k8s `k8s.io/apimachinery/pkg/apis/meta/v1/Duration` type so it'll be correctly parsed.

Fixes #4172

Signed-off-by: Jussi Nummelin <[email protected]>

Author: jnummelin

pkg/apis/k0s/v1beta1/extensions.go

@@ -19,9 +19,9 @@ package v1beta1
 import (
 	"errors"
 	"fmt"
-	"time"
 
 	"helm.sh/helm/v3/pkg/chartutil"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 var _ Validateable = (*ClusterExtensions)(nil)
@@ -91,13 +91,15 @@ func (he HelmExtensions) Validate() []error {
 
 // Chart single helm addon
 type Chart struct {
-	Name      string        `json:"name"`
-	ChartName string        `json:"chartname"`
-	Version   string        `json:"version"`
-	Values    string        `json:"values"`
-	TargetNS  string        `json:"namespace"`
-	Timeout   time.Duration `json:"timeout"`
-	Order     int           `json:"order"`
+	Name      string `json:"name"`
+	ChartName string `json:"chartname"`
+	Version   string `json:"version"`
+	Values    string `json:"values"`
+	TargetNS  string `json:"namespace"`
+	// Timeout specifies the timeout for how long to wait for the chart installation to finish.
+	// A duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
+	Timeout metav1.Duration `json:"timeout"`
+	Order   int             `json:"order"`
 }
 
 // ManifestFileName returns filename to use for the crd manifest

pkg/apis/k0s/v1beta1/extenstions_test.go

@@ -18,8 +18,11 @@ package v1beta1
 
 import (
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 func TestValidation(t *testing.T) {
@@ -106,5 +109,32 @@ func TestValidation(t *testing.T) {
 		assert.Equal(t, chart1.ManifestFileName(), "1_helm_extension_release.yaml")
 		assert.Equal(t, chart2.ManifestFileName(), "2_helm_extension_release.yaml")
 	})
+}
+
+func TestDurationParsing(t *testing.T) {
+	yaml := `
+apiVersion: k0s.k0sproject.io/v1beta1
+kind: ClusterConfig
+metadata:
+  name: foobar
+spec:
+  extensions:
+    helm:
+      charts:
+      - name: prometheus-stack
+        chartname: prometheus-community/prometheus
+        version: "14.6.1"
+        timeout: 20m
+`
+
+	c, err := ConfigFromString(yaml)
+	require := require.New(t)
+
+	require.NoError(err)
 
+	chart := c.Spec.Extensions.Helm.Charts[0]
+	expectedDuration := metav1.Duration{
+		Duration: 20 * time.Minute,
+	}
+	require.Equal(expectedDuration, chart.Timeout)
 }

pkg/apis/k0s/v1beta1/zz_generated.deepcopy.go

@@ -41,6 +41,7 @@ import (
 	"helm.sh/helm/v3/pkg/release"
 	"helm.sh/helm/v3/pkg/storage/driver"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/tools/clientcmd"
@@ -147,7 +148,7 @@ func addOpenEBSHelmExtension(helmSpec *k0sAPI.HelmExtensions, storageExtension *
 		TargetNS:  "openebs",
 		Version:   constant.OpenEBSVersion,
 		Values:    values,
-		Timeout:   time.Duration(time.Minute * 30), // it takes a while to install openebs
+		Timeout:   metav1.Duration{Duration: time.Duration(time.Minute * 30)}, // it takes a while to install openebs
 	})
 	return helmSpec, nil
 }
@@ -391,7 +392,7 @@ metadata:
 spec:
   chartName: {{ .ChartName }}
   releaseName: {{ .Name }}
-  timeout: {{ .Timeout }}
+  timeout: {{ .Timeout.Duration }}
   values: |
 {{ .Values | nindent 4 }}
   version: {{ .Version }}

pkg/component/controller/extensions_controller.go

@@ -102,11 +102,9 @@ spec:
                               type: integer
                             timeout:
                               description: |-
-                                A Duration represents the elapsed time between two instants
-                                as an int64 nanosecond count. The representation limits the
-                                largest representable duration to approximately 290 years.
-                              format: int64
-                              type: integer
+                                Timeout specifies the timeout for how long to wait for the chart installation to finish.
+                                A duration string is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
+                              type: string
                             values:
                               type: string
                             version: